chore: Update discovery artifacts (#1425)
## Deleted keys were detected in the following stable discovery artifacts:
admin directory_v1 https://github.com/googleapis/google-api-python-client/commit/1534f8926019f43dc87a29c1ca32191884556e3b
bigquery v2 https://github.com/googleapis/google-api-python-client/commit/59c51e319602741632201d2ce61a6b03f13e4003
file v1 https://github.com/googleapis/google-api-python-client/commit/0cd409a2d15c68aca3ea864400fc4772b9b4e503
memcache v1 https://github.com/googleapis/google-api-python-client/commit/665ce5b47b9b3238dcfa201b9343bf6447df5994
youtube v3 https://github.com/googleapis/google-api-python-client/commit/5046950872559fe93b954dc9a4f71fd724176247
## Deleted keys were detected in the following pre-stable discovery artifacts:
analyticsadmin v1alpha https://github.com/googleapis/google-api-python-client/commit/934358e5c041ffd1449e7c744463e61e94381ed5
documentai v1beta3 https://github.com/googleapis/google-api-python-client/commit/e8aaabbc7670aefc4a745916fccb31424745f748
file v1beta1 https://github.com/googleapis/google-api-python-client/commit/0cd409a2d15c68aca3ea864400fc4772b9b4e503
memcache v1beta2 https://github.com/googleapis/google-api-python-client/commit/665ce5b47b9b3238dcfa201b9343bf6447df5994
networkconnectivity v1alpha1 https://github.com/googleapis/google-api-python-client/commit/2cc462638aec61f4e775bfce883e725b104eeabb
## Discovery Artifact Change Summary:
feat(admin): update the api https://github.com/googleapis/google-api-python-client/commit/1534f8926019f43dc87a29c1ca32191884556e3b
feat(alertcenter): update the api https://github.com/googleapis/google-api-python-client/commit/7a488d3f0deef3e1f106cff63b1e4f66ad1727bb
feat(analyticsadmin): update the api https://github.com/googleapis/google-api-python-client/commit/934358e5c041ffd1449e7c744463e61e94381ed5
feat(analyticsdata): update the api https://github.com/googleapis/google-api-python-client/commit/40f712130674cec09c1dd7560f69a330a335b226
feat(androiddeviceprovisioning): update the api https://github.com/googleapis/google-api-python-client/commit/81a0002a7051aeab647a3296fb18ce7973bf7137
feat(apigee): update the api https://github.com/googleapis/google-api-python-client/commit/2e6c78a93b2c0ee7001eb163ec95f9afc8f35575
feat(appengine): update the api https://github.com/googleapis/google-api-python-client/commit/125f74a61a94af17c01930841a79db46d3a059c5
feat(bigquery): update the api https://github.com/googleapis/google-api-python-client/commit/59c51e319602741632201d2ce61a6b03f13e4003
feat(cloudasset): update the api https://github.com/googleapis/google-api-python-client/commit/e615264971ccee6eb9b450fe3d85614209c0fee8
feat(cloudbuild): update the api https://github.com/googleapis/google-api-python-client/commit/ceddaccf23eb8b809688907cfdef8906cd77d65d
feat(cloudidentity): update the api https://github.com/googleapis/google-api-python-client/commit/22cd08b69b034c2cdfd854e1ac784f834539db3a
feat(container): update the api https://github.com/googleapis/google-api-python-client/commit/f494c63a42dc418559292c6269289317d9cebc23
feat(documentai): update the api https://github.com/googleapis/google-api-python-client/commit/e8aaabbc7670aefc4a745916fccb31424745f748
feat(drive): update the api https://github.com/googleapis/google-api-python-client/commit/72cab88ce591d906ea1cfcbe4dee354cccb623f2
feat(file): update the api https://github.com/googleapis/google-api-python-client/commit/0cd409a2d15c68aca3ea864400fc4772b9b4e503
feat(firebaseappcheck): update the api https://github.com/googleapis/google-api-python-client/commit/9a0131b2326327109d1ba7af97b1f4808dd7a898
feat(healthcare): update the api https://github.com/googleapis/google-api-python-client/commit/45ee6b28b86a43f44c707e15a7e06fdf8fce6a0f
feat(ideahub): update the api https://github.com/googleapis/google-api-python-client/commit/73b86d9d37f33aeaed74772d0319ba1350e54ed5
feat(managedidentities): update the api https://github.com/googleapis/google-api-python-client/commit/a07ed4558c93cb8f7fae49c7b353f46ccfea6c10
feat(memcache): update the api https://github.com/googleapis/google-api-python-client/commit/665ce5b47b9b3238dcfa201b9343bf6447df5994
feat(metastore): update the api https://github.com/googleapis/google-api-python-client/commit/9fd5ffbf37fb052323f5fa68d307c68391c519ac
feat(ml): update the api https://github.com/googleapis/google-api-python-client/commit/cf54d564915a558569c093287b448a7819e215f6
feat(monitoring): update the api https://github.com/googleapis/google-api-python-client/commit/d1ffbfc041f23f904cd8bc35a450871b2909473b
feat(networkconnectivity): update the api https://github.com/googleapis/google-api-python-client/commit/2cc462638aec61f4e775bfce883e725b104eeabb
feat(notebooks): update the api https://github.com/googleapis/google-api-python-client/commit/831ba938855aa4bdefafedf63e01af43350e7ed2
feat(ondemandscanning): update the api https://github.com/googleapis/google-api-python-client/commit/c04b4023477393cbb41984b14e0c734fc8587d45
feat(paymentsresellersubscription): update the api https://github.com/googleapis/google-api-python-client/commit/2cd5b1c2ef524f3ab00630508710cce7bee53574
feat(prod_tt_sasportal): update the api https://github.com/googleapis/google-api-python-client/commit/8b6bd24e57a79f470c750ad04052f79a3cafe0fa
feat(realtimebidding): update the api https://github.com/googleapis/google-api-python-client/commit/fd514dc8d86182dc17698f3293144928535f709c
feat(reseller): update the api https://github.com/googleapis/google-api-python-client/commit/20226c4401956732772e2a563c7920666135e605
feat(sasportal): update the api https://github.com/googleapis/google-api-python-client/commit/38d5156350b79a9933b2806f4bbe443043a33185
feat(sts): update the api https://github.com/googleapis/google-api-python-client/commit/190e13ebe5a4660d8825d3a8708559077a342bdf
feat(transcoder): update the api https://github.com/googleapis/google-api-python-client/commit/fbcacce6a17c1cae45b22f4a2058e730ec84b55a
feat(youtube): update the api https://github.com/googleapis/google-api-python-client/commit/5046950872559fe93b954dc9a4f71fd724176247
diff --git a/googleapiclient/discovery_cache/documents/vault.v1.json b/googleapiclient/discovery_cache/documents/vault.v1.json
index d3d4af9..e4843e9 100644
--- a/googleapiclient/discovery_cache/documents/vault.v1.json
+++ b/googleapiclient/discovery_cache/documents/vault.v1.json
@@ -15,7 +15,7 @@
"baseUrl": "https://vault.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Vault",
- "description": "Retention and eDiscovery for Google Workspace. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. For example, to download an export, an account needs the **Manage Exports** privilege and the matter shared with them. ",
+ "description": "Retention and eDiscovery for Google Workspace. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. For example, to download an export, an account needs the **Manage Exports** privilege and the matter shared with them. ",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/vault",
"fullyEncodeReservedExpansion": true,
@@ -138,7 +138,7 @@
]
},
"close": {
- "description": "Closes the specified matter. Returns matter with updated state.",
+ "description": "Closes the specified matter. Returns the matter with updated state.",
"flatPath": "v1/matters/{matterId}:close",
"httpMethod": "POST",
"id": "vault.matters.close",
@@ -165,7 +165,7 @@
]
},
"count": {
- "description": "Counts the artifacts within the context of a matter and returns a detailed breakdown of metrics.",
+ "description": "Counts the accounts processed by the specified query.",
"flatPath": "v1/matters/{matterId}:count",
"httpMethod": "POST",
"id": "vault.matters.count",
@@ -192,7 +192,7 @@
]
},
"create": {
- "description": "Creates a new matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.",
+ "description": "Creates a matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.",
"flatPath": "v1/matters",
"httpMethod": "POST",
"id": "vault.matters.create",
@@ -210,7 +210,7 @@
]
},
"delete": {
- "description": "Deletes the specified matter. Returns matter with updated state.",
+ "description": "Deletes the specified matter. Returns the matter with updated state.",
"flatPath": "v1/matters/{matterId}",
"httpMethod": "DELETE",
"id": "vault.matters.delete",
@@ -249,16 +249,16 @@
"type": "string"
},
"view": {
- "description": "Specifies which parts of the Matter to return in the response.",
+ "description": "Specifies how much information about the matter to return in the response.",
"enum": [
"VIEW_UNSPECIFIED",
"BASIC",
"FULL"
],
"enumDescriptions": [
- "There is no specified view.",
- "Response includes the matter_id, name, description, and state. Default choice.",
- "Full representation of matter is returned. Everything above and including MatterPermissions list."
+ "The amount of detail is unspecified. Same as **BASIC**.",
+ "Returns the matter ID, name, description, and state. Default choice.",
+ "Returns the basic details and a list of matter owners and collaborators (see [MatterPermissions](https://developers.google.com/vault/reference/rest/v1/matters#matterpermission))."
],
"location": "query",
"type": "string"
@@ -274,7 +274,7 @@
]
},
"list": {
- "description": "Lists matters the user has access to.",
+ "description": "Lists matters the requestor has access to.",
"flatPath": "v1/matters",
"httpMethod": "GET",
"id": "vault.matters.list",
@@ -292,7 +292,7 @@
"type": "string"
},
"state": {
- "description": "If set, list only matters with that specific state. The default is listing matters of all states.",
+ "description": "If set, lists only matters with the specified state. The default lists matters of all states.",
"enum": [
"STATE_UNSPECIFIED",
"OPEN",
@@ -301,24 +301,24 @@
],
"enumDescriptions": [
"The matter has no specified state.",
- "This matter is open.",
- "This matter is closed.",
- "This matter is deleted."
+ "The matter is open.",
+ "The matter is closed.",
+ "The matter is deleted."
],
"location": "query",
"type": "string"
},
"view": {
- "description": "Specifies which parts of the matter to return in response.",
+ "description": "Specifies how much information about the matter to return in response.",
"enum": [
"VIEW_UNSPECIFIED",
"BASIC",
"FULL"
],
"enumDescriptions": [
- "There is no specified view.",
- "Response includes the matter_id, name, description, and state. Default choice.",
- "Full representation of matter is returned. Everything above and including MatterPermissions list."
+ "The amount of detail is unspecified. Same as **BASIC**.",
+ "Returns the matter ID, name, description, and state. Default choice.",
+ "Returns the basic details and a list of matter owners and collaborators (see [MatterPermissions](https://developers.google.com/vault/reference/rest/v1/matters#matterpermission))."
],
"location": "query",
"type": "string"
@@ -361,7 +361,7 @@
]
},
"reopen": {
- "description": "Reopens the specified matter. Returns matter with updated state.",
+ "description": "Reopens the specified matter. Returns the matter with updated state.",
"flatPath": "v1/matters/{matterId}:reopen",
"httpMethod": "POST",
"id": "vault.matters.reopen",
@@ -388,7 +388,7 @@
]
},
"undelete": {
- "description": "Undeletes the specified matter. Returns matter with updated state.",
+ "description": "Undeletes the specified matter. Returns the matter with updated state.",
"flatPath": "v1/matters/{matterId}:undelete",
"httpMethod": "POST",
"id": "vault.matters.undelete",
@@ -446,7 +446,7 @@
"exports": {
"methods": {
"create": {
- "description": "Creates an Export.",
+ "description": "Creates an export.",
"flatPath": "v1/matters/{matterId}/exports",
"httpMethod": "POST",
"id": "vault.matters.exports.create",
@@ -473,7 +473,7 @@
]
},
"delete": {
- "description": "Deletes an Export.",
+ "description": "Deletes an export.",
"flatPath": "v1/matters/{matterId}/exports/{exportId}",
"httpMethod": "DELETE",
"id": "vault.matters.exports.delete",
@@ -504,7 +504,7 @@
]
},
"get": {
- "description": "Gets an Export.",
+ "description": "Gets an export.",
"flatPath": "v1/matters/{matterId}/exports/{exportId}",
"httpMethod": "GET",
"id": "vault.matters.exports.get",
@@ -536,7 +536,7 @@
]
},
"list": {
- "description": "Lists Exports.",
+ "description": "Lists details about the exports in the specified matter.",
"flatPath": "v1/matters/{matterId}/exports",
"httpMethod": "GET",
"id": "vault.matters.exports.list",
@@ -576,7 +576,7 @@
"holds": {
"methods": {
"addHeldAccounts": {
- "description": "Adds HeldAccounts to a hold. Returns a list of accounts that have been successfully added. Accounts can only be added to an existing account-based hold.",
+ "description": "Adds accounts to a hold. Returns a list of accounts that have been successfully added. Accounts can be added only to an existing account-based hold.",
"flatPath": "v1/matters/{matterId}/holds/{holdId}:addHeldAccounts",
"httpMethod": "POST",
"id": "vault.matters.holds.addHeldAccounts",
@@ -610,7 +610,7 @@
]
},
"create": {
- "description": "Creates a hold in the given matter.",
+ "description": "Creates a hold in the specified matter.",
"flatPath": "v1/matters/{matterId}/holds",
"httpMethod": "POST",
"id": "vault.matters.holds.create",
@@ -637,7 +637,7 @@
]
},
"delete": {
- "description": "Removes a hold by ID. This will release any HeldAccounts on this Hold.",
+ "description": "Removes the specified hold and releases the accounts or organizational unit covered by the hold. If the data is not preserved by another hold or retention rule, it might be purged.",
"flatPath": "v1/matters/{matterId}/holds/{holdId}",
"httpMethod": "DELETE",
"id": "vault.matters.holds.delete",
@@ -668,7 +668,7 @@
]
},
"get": {
- "description": "Gets a hold by ID.",
+ "description": "Gets the specified hold.",
"flatPath": "v1/matters/{matterId}/holds/{holdId}",
"httpMethod": "GET",
"id": "vault.matters.holds.get",
@@ -690,16 +690,16 @@
"type": "string"
},
"view": {
- "description": "Specifies which parts of the Hold to return.",
+ "description": "The amount of detail to return for a hold.",
"enum": [
"HOLD_VIEW_UNSPECIFIED",
"BASIC_HOLD",
"FULL_HOLD"
],
"enumDescriptions": [
- "There is no specified view. Defaults to FULL_HOLD.",
- "Response includes the id, name, update time, corpus, and query.",
- "Full representation of a Hold. Response includes all fields of 'BASIC' and the entities the Hold applies to, such as accounts, or OU."
+ "Not specified. Defaults to **FULL_HOLD**.",
+ "Returns the hold ID, name, update time, service, and query.",
+ "Returns all details of **BASIC_HOLD** and the entities the hold applies to, such as accounts or organizational unit."
],
"location": "query",
"type": "string"
@@ -715,7 +715,7 @@
]
},
"list": {
- "description": "Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list.",
+ "description": "Lists the holds in a matter.",
"flatPath": "v1/matters/{matterId}/holds",
"httpMethod": "GET",
"id": "vault.matters.holds.list",
@@ -730,7 +730,7 @@
"type": "string"
},
"pageSize": {
- "description": "The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as page_size = 100.",
+ "description": "The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as **page_size** = 100.",
"format": "int32",
"location": "query",
"type": "integer"
@@ -741,16 +741,16 @@
"type": "string"
},
"view": {
- "description": "Specifies which parts of the Hold to return.",
+ "description": "The amount of detail to return for a hold.",
"enum": [
"HOLD_VIEW_UNSPECIFIED",
"BASIC_HOLD",
"FULL_HOLD"
],
"enumDescriptions": [
- "There is no specified view. Defaults to FULL_HOLD.",
- "Response includes the id, name, update time, corpus, and query.",
- "Full representation of a Hold. Response includes all fields of 'BASIC' and the entities the Hold applies to, such as accounts, or OU."
+ "Not specified. Defaults to **FULL_HOLD**.",
+ "Returns the hold ID, name, update time, service, and query.",
+ "Returns all details of **BASIC_HOLD** and the entities the hold applies to, such as accounts or organizational unit."
],
"location": "query",
"type": "string"
@@ -766,7 +766,7 @@
]
},
"removeHeldAccounts": {
- "description": "Removes HeldAccounts from a hold. Returns a list of statuses in the same order as the request. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.",
+ "description": "Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.",
"flatPath": "v1/matters/{matterId}/holds/{holdId}:removeHeldAccounts",
"httpMethod": "POST",
"id": "vault.matters.holds.removeHeldAccounts",
@@ -800,7 +800,7 @@
]
},
"update": {
- "description": "Updates the OU and/or query parameters of a hold. You cannot add accounts to a hold that covers an OU, nor can you add OUs to a hold that covers individual accounts. Accounts listed in the hold will be ignored.",
+ "description": "Updates the scope (organizational unit or accounts) and query parameters of a hold. You cannot add accounts to a hold that covers an organizational unit, nor can you add organizational units to a hold that covers individual accounts. If you try, the unsupported values are ignored.",
"flatPath": "v1/matters/{matterId}/holds/{holdId}",
"httpMethod": "PUT",
"id": "vault.matters.holds.update",
@@ -838,7 +838,7 @@
"accounts": {
"methods": {
"create": {
- "description": "Adds a HeldAccount to a hold. Accounts can only be added to a hold that has no held_org_unit set. Attempting to add an account to an OU-based hold will result in an error.",
+ "description": "Adds an account to a hold. Accounts can be added only to a hold that does not have an organizational unit set. If you try to add an account to an organizational unit-based hold, an error is returned.",
"flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts",
"httpMethod": "POST",
"id": "vault.matters.holds.accounts.create",
@@ -872,7 +872,7 @@
]
},
"delete": {
- "description": "Removes a HeldAccount from a hold. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.",
+ "description": "Removes an account from a hold.",
"flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}",
"httpMethod": "DELETE",
"id": "vault.matters.holds.accounts.delete",
@@ -910,7 +910,7 @@
]
},
"list": {
- "description": "Lists HeldAccounts for a hold. This will only list individually specified held accounts. If the hold is on an OU, then use Admin SDK to enumerate its members.",
+ "description": "Lists the accounts covered by a hold. This can list only individually-specified accounts covered by the hold. If the hold covers an organizational unit, use the [Admin SDK](https://developers.google.com/admin-sdk/). to list the members of the organizational unit on hold.",
"flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts",
"httpMethod": "GET",
"id": "vault.matters.holds.accounts.list",
@@ -957,7 +957,7 @@
],
"parameters": {
"matterId": {
- "description": "The matter ID of the parent matter for which the saved query is to be created.",
+ "description": "The ID of the matter to create the saved query in.",
"location": "path",
"required": true,
"type": "string"
@@ -975,7 +975,7 @@
]
},
"delete": {
- "description": "Deletes a saved query by Id.",
+ "description": "Deletes the specified saved query.",
"flatPath": "v1/matters/{matterId}/savedQueries/{savedQueryId}",
"httpMethod": "DELETE",
"id": "vault.matters.savedQueries.delete",
@@ -985,13 +985,13 @@
],
"parameters": {
"matterId": {
- "description": "The matter ID of the parent matter for which the saved query is to be deleted.",
+ "description": "The ID of the matter to delete the saved query from.",
"location": "path",
"required": true,
"type": "string"
},
"savedQueryId": {
- "description": "ID of the saved query to be deleted.",
+ "description": "ID of the saved query to delete.",
"location": "path",
"required": true,
"type": "string"
@@ -1006,7 +1006,7 @@
]
},
"get": {
- "description": "Retrieves a saved query by Id.",
+ "description": "Retrieves the specified saved query.",
"flatPath": "v1/matters/{matterId}/savedQueries/{savedQueryId}",
"httpMethod": "GET",
"id": "vault.matters.savedQueries.get",
@@ -1016,13 +1016,13 @@
],
"parameters": {
"matterId": {
- "description": "The matter ID of the parent matter for which the saved query is to be retrieved.",
+ "description": "The ID of the matter to get the saved query from.",
"location": "path",
"required": true,
"type": "string"
},
"savedQueryId": {
- "description": "ID of the saved query to be retrieved.",
+ "description": "ID of the saved query to retrieve.",
"location": "path",
"required": true,
"type": "string"
@@ -1038,7 +1038,7 @@
]
},
"list": {
- "description": "Lists saved queries within a matter. An empty page token in ListSavedQueriesResponse denotes no more saved queries to list.",
+ "description": "Lists the saved queries in a matter.",
"flatPath": "v1/matters/{matterId}/savedQueries",
"httpMethod": "GET",
"id": "vault.matters.savedQueries.list",
@@ -1047,7 +1047,7 @@
],
"parameters": {
"matterId": {
- "description": "The matter ID of the parent matter for which the saved queries are to be retrieved.",
+ "description": "The ID of the matter to get the saved queries for.",
"location": "path",
"required": true,
"type": "string"
@@ -1193,11 +1193,11 @@
}
}
},
- "revision": "20210609",
+ "revision": "20210621",
"rootUrl": "https://vault.googleapis.com/",
"schemas": {
"AccountCount": {
- "description": "Count number for each account.",
+ "description": "The results count for each account.",
"id": "AccountCount",
"properties": {
"account": {
@@ -1205,7 +1205,7 @@
"description": "Account owner."
},
"count": {
- "description": "The number of artifacts found for this account.",
+ "description": "The number of results (messages or files) found for this account.",
"format": "int64",
"type": "string"
}
@@ -1244,7 +1244,7 @@
"type": "object"
},
"AccountInfo": {
- "description": "Accounts to search",
+ "description": "The accounts to search",
"id": "AccountInfo",
"properties": {
"emails": {
@@ -1258,16 +1258,16 @@
"type": "object"
},
"AddHeldAccountResult": {
- "description": "A status detailing the status of each account creation, and the HeldAccount, if successful.",
+ "description": "The status of each account creation, and the **HeldAccount**, if successful.",
"id": "AddHeldAccountResult",
"properties": {
"account": {
"$ref": "HeldAccount",
- "description": "If present, this account was successfully created."
+ "description": "Returned when the account was successfully created."
},
"status": {
"$ref": "Status",
- "description": "This represents the success status. If failed, check message."
+ "description": "Reports the request status. If it failed, returns an error message."
}
},
"type": "object"
@@ -1277,14 +1277,14 @@
"id": "AddHeldAccountsRequest",
"properties": {
"accountIds": {
- "description": "Account IDs to identify which accounts to add. Only account_ids or only emails should be specified, but not both.",
+ "description": "A comma-separated list of the account IDs of the accounts to add to the hold. Specify either **emails** or **account_ids**, but not both.",
"items": {
"type": "string"
},
"type": "array"
},
"emails": {
- "description": "Emails to identify which accounts to add. Only emails or only account_ids should be specified, but not both.",
+ "description": "A comma-separated list of the emails of the accounts to add to the hold. Specify either **emails** or **account_ids**, but not both.",
"items": {
"type": "string"
},
@@ -1308,19 +1308,19 @@
"type": "object"
},
"AddMatterPermissionsRequest": {
- "description": "Add an account with the permission specified. The role cannot be owner. If an account already has a role in the matter, it will be overwritten.",
+ "description": "Add an account with the permission specified. The role cannot be owner. If an account already has a role in the matter, the existing role is overwritten.",
"id": "AddMatterPermissionsRequest",
"properties": {
"ccMe": {
- "description": "Only relevant if send_emails is true. True to CC requestor in the email message. False to not CC requestor.",
+ "description": "Only relevant if **sendEmails** is **true**. To CC the requestor in the email message, set to **true**. To not CC requestor, set to **false**.",
"type": "boolean"
},
"matterPermission": {
"$ref": "MatterPermission",
- "description": "The MatterPermission to add."
+ "description": "The account and its role to add."
},
"sendEmails": {
- "description": "True to send notification email to the added account. False to not send notification email.",
+ "description": "To send a notification email to the added account, set to **true**. To not send a notification email, set to **false**.",
"type": "boolean"
}
},
@@ -1344,17 +1344,17 @@
"properties": {
"matter": {
"$ref": "Matter",
- "description": "The updated matter, with state CLOSED."
+ "description": "The updated matter, with state **CLOSED**."
}
},
"type": "object"
},
"CloudStorageFile": {
- "description": "An export file on cloud storage",
+ "description": "The export file in Cloud Storage",
"id": "CloudStorageFile",
"properties": {
"bucketName": {
- "description": "The cloud storage bucket name of this export file. Can be used in cloud storage JSON/XML API, but not to list the bucket contents. Instead, you can get individual export files by object name.",
+ "description": "The name of the Cloud Storage bucket for the export file. You can use this value in the [Cloud Storage JSON or XML APIs](https://cloud.google.com/storage/docs/apis), but not to list the bucket contents. Instead, you can [get individual export files](https://cloud.google.com/storage/docs/json_api/v1/objects/get) by object name.",
"type": "string"
},
"md5Hash": {
@@ -1362,11 +1362,11 @@
"type": "string"
},
"objectName": {
- "description": "The cloud storage object name of this export file. Can be used in cloud storage JSON/XML API.",
+ "description": "The name of the Cloud Storage object for the export file. You can use this value in the [Cloud Storage JSON or XML APIs](https://cloud.google.com/storage/docs/apis).",
"type": "string"
},
"size": {
- "description": "The size of the export file.",
+ "description": "The export file size.",
"format": "int64",
"type": "string"
}
@@ -1374,11 +1374,11 @@
"type": "object"
},
"CloudStorageSink": {
- "description": "Export sink for cloud storage files.",
+ "description": "Export sink for Cloud Storage files.",
"id": "CloudStorageSink",
"properties": {
"files": {
- "description": "Output only. The exported files on cloud storage.",
+ "description": "Output only. The exported files in Cloud Storage.",
"items": {
"$ref": "CloudStorageFile"
},
@@ -1388,28 +1388,28 @@
"type": "object"
},
"CorpusQuery": {
- "description": "Corpus specific queries.",
+ "description": "Service-specific options for holds.",
"id": "CorpusQuery",
"properties": {
"driveQuery": {
"$ref": "HeldDriveQuery",
- "description": "Details pertaining to Drive holds. If set, corpus must be Drive."
+ "description": "Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**."
},
"groupsQuery": {
"$ref": "HeldGroupsQuery",
- "description": "Details pertaining to Groups holds. If set, corpus must be Groups."
+ "description": "Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**."
},
"hangoutsChatQuery": {
"$ref": "HeldHangoutsChatQuery",
- "description": "Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat."
+ "description": "Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**."
},
"mailQuery": {
"$ref": "HeldMailQuery",
- "description": "Details pertaining to mail holds. If set, corpus must be mail."
+ "description": "Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**."
},
"voiceQuery": {
"$ref": "HeldVoiceQuery",
- "description": "Details pertaining to Voice holds. If set, corpus must be Voice."
+ "description": "Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**."
}
},
"type": "object"
@@ -1448,16 +1448,16 @@
"description": "The search query."
},
"view": {
- "description": "Specifies the granularity of the count result returned in response.",
+ "description": "Sets the granularity of the count results.",
"enum": [
"COUNT_RESULT_VIEW_UNSPECIFIED",
"TOTAL_COUNT",
"ALL"
],
"enumDescriptions": [
- "Default. It works the same as TOTAL_COUNT.",
- "Response includes: total count, queried accounts count, matching accounts count, non-queryable accounts, queried account errors.",
- "Response includes additional breakdown of account count."
+ "Default. Same as **TOTAL_COUNT**.",
+ "Response includes counts of the total accounts, queried accounts, matching accounts, non-queryable accounts, and queried account errors.",
+ "Response includes the same details as **TOTAL_COUNT**, plus additional account breakdown."
],
"type": "string"
}
@@ -1470,14 +1470,14 @@
"properties": {
"groupsCountResult": {
"$ref": "GroupsCountResult",
- "description": "Count metrics of Groups."
+ "description": "Count metrics for Groups."
},
"mailCountResult": {
"$ref": "MailCountResult",
- "description": "Count metrics of Mail."
+ "description": "Count metrics for Gmail and classic Hangouts."
},
"totalCount": {
- "description": "Total count of artifacts. For mail and groups, artifacts refers to messages.",
+ "description": "Total count of messages.",
"format": "int64",
"type": "string"
}
@@ -1485,22 +1485,22 @@
"type": "object"
},
"DriveExportOptions": {
- "description": "The options for Drive export.",
+ "description": "Options for Drive exports.",
"id": "DriveExportOptions",
"properties": {
"includeAccessInfo": {
- "description": "Set to true to include access level information for users with indirect access to files.",
+ "description": "To include access level information for users with [indirect access](https://support.google.com/vault/answer/6099459#metadata) to files, set to **true**.",
"type": "boolean"
}
},
"type": "object"
},
"DriveOptions": {
- "description": "Drive search advanced options",
+ "description": "Additional options for Drive search",
"id": "DriveOptions",
"properties": {
"includeSharedDrives": {
- "description": "Set to true to include shared drive.",
+ "description": "Set to **true** to include shared drives.",
"type": "boolean"
},
"includeTeamDrives": {
@@ -1508,7 +1508,7 @@
"type": "boolean"
},
"versionDate": {
- "description": "Search the versions of the Drive file as of the reference date. These timestamps are in GMT and rounded down to the given date.",
+ "description": "Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.",
"format": "google-datetime",
"type": "string"
}
@@ -1522,12 +1522,12 @@
"type": "object"
},
"Export": {
- "description": "An export To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.",
+ "description": "An export. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.",
"id": "Export",
"properties": {
"cloudStorageSink": {
"$ref": "CloudStorageSink",
- "description": "Output only. Export sink for cloud storage files."
+ "description": "Output only. The sink for export files in Cloud Storage."
},
"createTime": {
"description": "Output only. The time when the export was created.",
@@ -1536,7 +1536,7 @@
},
"exportOptions": {
"$ref": "ExportOptions",
- "description": "Advanced options of the export."
+ "description": "Additional export options."
},
"id": {
"description": "Output only. The generated export ID.",
@@ -1552,7 +1552,7 @@
},
"query": {
"$ref": "Query",
- "description": "The search query being exported."
+ "description": "The query parameters used to create the export."
},
"requester": {
"$ref": "UserInfo",
@@ -1560,10 +1560,10 @@
},
"stats": {
"$ref": "ExportStats",
- "description": "Output only. Export statistics."
+ "description": "Output only. Details about the export progress and size."
},
"status": {
- "description": "Output only. The export status.",
+ "description": "Output only. The status of the export.",
"enum": [
"EXPORT_STATUS_UNSPECIFIED",
"COMPLETED",
@@ -1574,7 +1574,7 @@
"The status is unspecified.",
"The export completed.",
"The export failed.",
- "The export is still being executed."
+ "The export is in progress."
],
"type": "string"
}
@@ -1582,27 +1582,27 @@
"type": "object"
},
"ExportOptions": {
- "description": "Export advanced options",
+ "description": "Additional options for exports",
"id": "ExportOptions",
"properties": {
"driveOptions": {
"$ref": "DriveExportOptions",
- "description": "Option available for Drive export."
+ "description": "Options for Drive exports."
},
"groupsOptions": {
"$ref": "GroupsExportOptions",
- "description": "Option available for groups export."
+ "description": "Options for Groups exports."
},
"hangoutsChatOptions": {
"$ref": "HangoutsChatExportOptions",
- "description": "Option available for hangouts chat export."
+ "description": "Options for Chat exports."
},
"mailOptions": {
"$ref": "MailExportOptions",
- "description": "Option available for mail export."
+ "description": "Options for Gmail exports."
},
"region": {
- "description": "The requested export location.",
+ "description": "The requested data region for the export.",
"enum": [
"EXPORT_REGION_UNSPECIFIED",
"ANY",
@@ -1610,26 +1610,26 @@
"EUROPE"
],
"enumDescriptions": [
- "The region is unspecified. Will be treated the same as ANY.",
+ "The region is unspecified. Defaults to ANY.",
"Any region.",
- "US region.",
+ "United States region.",
"Europe region."
],
"type": "string"
},
"voiceOptions": {
"$ref": "VoiceExportOptions",
- "description": "Option available for voice export."
+ "description": "Options for Voice exports."
}
},
"type": "object"
},
"ExportStats": {
- "description": "Stats of an export.",
+ "description": "Progress information for an export.",
"id": "ExportStats",
"properties": {
"exportedArtifactCount": {
- "description": "The number of documents already processed by the export.",
+ "description": "The number of messages or files already processed for export.",
"format": "int64",
"type": "string"
},
@@ -1639,7 +1639,7 @@
"type": "string"
},
"totalArtifactCount": {
- "description": "The number of documents to be exported.",
+ "description": "The number of messages or files to be exported.",
"format": "int64",
"type": "string"
}
@@ -1670,7 +1670,7 @@
"type": "string"
},
"nonQueryableAccounts": {
- "description": "When data scope is HELD_DATA in the request Query, these accounts in the request are not queried because they are not on hold. For other data scope, this field is not set.",
+ "description": "When **DataScope** is **HELD_DATA**, these accounts in the request are not queried because they are not on hold. For other data scope, this field is not set.",
"items": {
"type": "string"
},
@@ -1685,11 +1685,11 @@
"type": "object"
},
"GroupsExportOptions": {
- "description": "The options for groups export.",
+ "description": "Options for Groups exports.",
"id": "GroupsExportOptions",
"properties": {
"exportFormat": {
- "description": "The export format for groups export.",
+ "description": "The file format for exported messages.",
"enum": [
"EXPORT_FORMAT_UNSPECIFIED",
"MBOX",
@@ -1697,8 +1697,8 @@
],
"enumDescriptions": [
"No export format specified.",
- "MBOX as export format.",
- "PST as export format"
+ "Export as MBOX.",
+ "Export as PST."
],
"type": "string"
}
@@ -1706,11 +1706,11 @@
"type": "object"
},
"HangoutsChatExportOptions": {
- "description": "The options for hangouts chat export.",
+ "description": "Options for Chat exports.",
"id": "HangoutsChatExportOptions",
"properties": {
"exportFormat": {
- "description": "The export format for hangouts chat export.",
+ "description": "The file format for exported messages.",
"enum": [
"EXPORT_FORMAT_UNSPECIFIED",
"MBOX",
@@ -1718,8 +1718,8 @@
],
"enumDescriptions": [
"No export format specified.",
- "MBOX as export format.",
- "PST as export format"
+ "Export as MBOX.",
+ "Export as PST."
],
"type": "string"
}
@@ -1727,11 +1727,11 @@
"type": "object"
},
"HangoutsChatInfo": {
- "description": "Accounts to search",
+ "description": "The Chat spaces to search",
"id": "HangoutsChatInfo",
"properties": {
"roomId": {
- "description": "A set of rooms to search.",
+ "description": "A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).",
"items": {
"type": "string"
},
@@ -1741,26 +1741,26 @@
"type": "object"
},
"HangoutsChatOptions": {
- "description": "Hangouts chat search advanced options",
+ "description": "Additional options for Google Chat search",
"id": "HangoutsChatOptions",
"properties": {
"includeRooms": {
- "description": "Set to true to include rooms.",
+ "description": "For searches by account or organizational unit, set to **true** to include rooms.",
"type": "boolean"
}
},
"type": "object"
},
"HeldAccount": {
- "description": "An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.",
+ "description": "An account covered by a hold. This structure is immutable. It can be an individual account or a Google Group, depending on the service. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.",
"id": "HeldAccount",
"properties": {
"accountId": {
- "description": "The account's ID as provided by the Admin SDK.",
+ "description": "The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).",
"type": "string"
},
"email": {
- "description": "The primary email address of the account. If used as an input, this takes precedence over account ID.",
+ "description": "The primary email address of the account. If used as an input, this takes precedence over **accountId**.",
"type": "string"
},
"firstName": {
@@ -1780,15 +1780,15 @@
"type": "object"
},
"HeldDriveQuery": {
- "description": "Query options for Drive holds.",
+ "description": "Options for Drive holds.",
"id": "HeldDriveQuery",
"properties": {
"includeSharedDriveFiles": {
- "description": "If true, include files in shared drives in the hold.",
+ "description": "To include files in shared drives in the hold, set to **true**.",
"type": "boolean"
},
"includeTeamDriveFiles": {
- "description": "If true, include files in Team Drives in the hold.",
+ "description": "To include files in Team Drives in the hold, set to **true**.",
"type": "boolean"
}
},
@@ -1799,76 +1799,76 @@
"id": "HeldGroupsQuery",
"properties": {
"endTime": {
- "description": "The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.",
+ "description": "The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.",
"format": "google-datetime",
"type": "string"
},
"startTime": {
- "description": "The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.",
+ "description": "The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.",
"format": "google-datetime",
"type": "string"
},
"terms": {
- "description": "The search terms for the hold.",
+ "description": "The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.",
"type": "string"
}
},
"type": "object"
},
"HeldHangoutsChatQuery": {
- "description": "Query options for hangouts chat holds.",
+ "description": "Options for Chat holds.",
"id": "HeldHangoutsChatQuery",
"properties": {
"includeRooms": {
- "description": "If true, include rooms the user has participated in.",
+ "description": "To include messages in Chat spaces the user was a member of, set to **true**.",
"type": "boolean"
}
},
"type": "object"
},
"HeldMailQuery": {
- "description": "Query options for mail holds.",
+ "description": "Query options for Gmail holds.",
"id": "HeldMailQuery",
"properties": {
"endTime": {
- "description": "The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.",
+ "description": "The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.",
"format": "google-datetime",
"type": "string"
},
"startTime": {
- "description": "The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.",
+ "description": "The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.",
"format": "google-datetime",
"type": "string"
},
"terms": {
- "description": "The search terms for the hold.",
+ "description": "The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.",
"type": "string"
}
},
"type": "object"
},
"HeldOrgUnit": {
- "description": "A organizational unit being held in a particular hold. This structure is immutable.",
+ "description": "The organizational unit covered by a hold. This structure is immutable.",
"id": "HeldOrgUnit",
"properties": {
"holdTime": {
- "description": "When the org unit was put on hold. This property is immutable.",
+ "description": "When the organizational unit was put on hold. This property is immutable.",
"format": "google-datetime",
"type": "string"
},
"orgUnitId": {
- "description": "The org unit's immutable ID as provided by the Admin SDK.",
+ "description": "The organizational unit's immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).",
"type": "string"
}
},
"type": "object"
},
"HeldVoiceQuery": {
- "description": "Query options for Voice holds.",
+ "description": "Options for Voice holds.",
"id": "HeldVoiceQuery",
"properties": {
"coveredData": {
- "description": "Data covered by this rule. Should be non-empty. Order does not matter and duplicates will be ignored.",
+ "description": "A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.",
"items": {
"enum": [
"COVERED_DATA_UNSPECIFIED",
@@ -1878,9 +1878,9 @@
],
"enumDescriptions": [
"Covered data unspecified.",
- "Voice text message will be covered.",
- "Voicemail will be covered.",
- "Call logs will be covered."
+ "Voice text messages.",
+ "Voicemails and their transcripts.",
+ "Call logs."
],
"type": "string"
},
@@ -1890,18 +1890,18 @@
"type": "object"
},
"Hold": {
- "description": "Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.",
+ "description": "A hold. A hold prevents the specified Google Workspace service from purging data for specific accounts or all members of an organizational unit. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.",
"id": "Hold",
"properties": {
"accounts": {
- "description": "If set, the hold applies to the enumerated accounts and org_unit must be empty.",
+ "description": "If set, the hold applies to the specified accounts and **orgUnit** must be empty.",
"items": {
"$ref": "HeldAccount"
},
"type": "array"
},
"corpus": {
- "description": "The corpus to be searched.",
+ "description": "The service to be searched.",
"enum": [
"CORPUS_TYPE_UNSPECIFIED",
"DRIVE",
@@ -1911,11 +1911,11 @@
"VOICE"
],
"enumDescriptions": [
- "No corpus specified.",
- "Drive.",
- "Mail.",
+ "No service specified.",
+ "Drive, including Meet and Sites.",
+ "For search, Gmail and classic Hangouts. For holds, Gmail only.",
"Groups.",
- "Hangouts Chat.",
+ "For search, Google Chat only. For holds, Google Chat and classic Hangouts.",
"Google Voice."
],
"type": "string"
@@ -1930,11 +1930,11 @@
},
"orgUnit": {
"$ref": "HeldOrgUnit",
- "description": "If set, the hold applies to all members of the organizational unit and accounts must be empty. This property is mutable. For groups holds, set the accounts field."
+ "description": "If set, the hold applies to all members of the organizational unit and **accounts** must be empty. This property is mutable. For Groups holds, set **accounts**."
},
"query": {
"$ref": "CorpusQuery",
- "description": "The corpus-specific query. If set, the corpusQuery must match corpus type."
+ "description": "Service-specific options. If set, **CorpusQuery** must match **CorpusType**."
},
"updateTime": {
"description": "The last time this hold was modified.",
@@ -1945,7 +1945,7 @@
"type": "object"
},
"ListExportsResponse": {
- "description": "The holds for a matter.",
+ "description": "The exports for a matter.",
"id": "ListExportsResponse",
"properties": {
"exports": {
@@ -1963,7 +1963,7 @@
"type": "object"
},
"ListHeldAccountsResponse": {
- "description": "Returns a list of held accounts for a hold.",
+ "description": "Returns a list of the accounts covered by a hold.",
"id": "ListHeldAccountsResponse",
"properties": {
"accounts": {
@@ -2039,7 +2039,7 @@
"type": "string"
},
"savedQueries": {
- "description": "List of output saved queries.",
+ "description": "List of saved queries.",
"items": {
"$ref": "SavedQuery"
},
@@ -2049,11 +2049,11 @@
"type": "object"
},
"MailCountResult": {
- "description": "Mail specific count metrics.",
+ "description": "Gmail and classic Hangouts-specific count metrics.",
"id": "MailCountResult",
"properties": {
"accountCountErrors": {
- "description": "Error occurred when querying these accounts.",
+ "description": "Errors occurred when querying these accounts.",
"items": {
"$ref": "AccountCountError"
},
@@ -2072,7 +2072,7 @@
"type": "string"
},
"nonQueryableAccounts": {
- "description": "When data scope is HELD_DATA in the request Query, these accounts in the request are not queried because they are not on hold. For other data scope, this field is not set.",
+ "description": "When **DataScope** is **HELD_DATA**, the number of accounts in the request that are not queried because they are not on hold. For other data scopes, this field is not set.",
"items": {
"type": "string"
},
@@ -2087,11 +2087,11 @@
"type": "object"
},
"MailExportOptions": {
- "description": "The options for mail export.",
+ "description": "Options for Gmail exports.",
"id": "MailExportOptions",
"properties": {
"exportFormat": {
- "description": "The export file format.",
+ "description": "The file format for exported messages.",
"enum": [
"EXPORT_FORMAT_UNSPECIFIED",
"MBOX",
@@ -2099,24 +2099,24 @@
],
"enumDescriptions": [
"No export format specified.",
- "MBOX as export format.",
- "PST as export format"
+ "Export as MBOX.",
+ "Export as PST."
],
"type": "string"
},
"showConfidentialModeContent": {
- "description": "Set to true to export confidential mode content.",
+ "description": "To export confidential mode content, set to **true**.",
"type": "boolean"
}
},
"type": "object"
},
"MailOptions": {
- "description": "Mail search advanced options",
+ "description": "Additional options for Gmail search",
"id": "MailOptions",
"properties": {
"excludeDrafts": {
- "description": "Set to true to exclude drafts.",
+ "description": "Set to **true** to exclude drafts.",
"type": "boolean"
}
},
@@ -2127,15 +2127,15 @@
"id": "Matter",
"properties": {
"description": {
- "description": "The description of the matter.",
+ "description": "An optional description for the matter.",
"type": "string"
},
"matterId": {
- "description": "The matter ID which is generated by the server. Should be blank when creating a new matter.",
+ "description": "The matter ID, which is generated by the server. Leave blank when creating a matter.",
"type": "string"
},
"matterPermissions": {
- "description": "List of users and access to the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.",
+ "description": "Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.",
"items": {
"$ref": "MatterPermission"
},
@@ -2155,9 +2155,9 @@
],
"enumDescriptions": [
"The matter has no specified state.",
- "This matter is open.",
- "This matter is closed.",
- "This matter is deleted."
+ "The matter is open.",
+ "The matter is closed.",
+ "The matter is deleted."
],
"type": "string"
}
@@ -2165,15 +2165,15 @@
"type": "object"
},
"MatterPermission": {
- "description": "Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.",
+ "description": "Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.",
"id": "MatterPermission",
"properties": {
"accountId": {
- "description": "The account ID, as provided by Admin SDK.",
+ "description": "The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).",
"type": "string"
},
"role": {
- "description": "The user's role in this matter.",
+ "description": "The user's role for the matter.",
"enum": [
"ROLE_UNSPECIFIED",
"COLLABORATOR",
@@ -2181,7 +2181,7 @@
],
"enumDescriptions": [
"No role assigned.",
- "A collaborator to the matter.",
+ "A collaborator on the matter.",
"The owner of the matter."
],
"type": "string"
@@ -2225,26 +2225,26 @@
"type": "object"
},
"OrgUnitInfo": {
- "description": "Org Unit to search",
+ "description": "The organizational unit to search",
"id": "OrgUnitInfo",
"properties": {
"orgUnitId": {
- "description": "Org unit to search, as provided by the Admin SDK Directory API.",
+ "description": "The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).",
"type": "string"
}
},
"type": "object"
},
"Query": {
- "description": "A query definition relevant for search & export.",
+ "description": "The query definition used for search and export.",
"id": "Query",
"properties": {
"accountInfo": {
"$ref": "AccountInfo",
- "description": "When 'ACCOUNT' is chosen as search method, account_info needs to be specified."
+ "description": "Required when **SearchMethod** is **ACCOUNT**."
},
"corpus": {
- "description": "The corpus to search.",
+ "description": "The Google Workspace service to search.",
"enum": [
"CORPUS_TYPE_UNSPECIFIED",
"DRIVE",
@@ -2254,17 +2254,17 @@
"VOICE"
],
"enumDescriptions": [
- "No corpus specified.",
- "Drive.",
- "Mail.",
+ "No service specified.",
+ "Drive, including Meet and Sites.",
+ "For search, Gmail and classic Hangouts. For holds, Gmail only.",
"Groups.",
- "Hangouts Chat.",
+ "For search, Google Chat only. For holds, Google Chat and classic Hangouts.",
"Google Voice."
],
"type": "string"
},
"dataScope": {
- "description": "The data source to search from.",
+ "description": "The data source to search.",
"enum": [
"DATA_SCOPE_UNSPECIFIED",
"ALL_DATA",
@@ -2272,36 +2272,36 @@
"UNPROCESSED_DATA"
],
"enumDescriptions": [
- "No data scope specified.",
+ "No data source specified.",
"All available data.",
- "Data on hold.",
- "Data not processed."
+ "Only data on hold.",
+ "Only data not yet processed by Vault. (Gmail and Groups only)"
],
"type": "string"
},
"driveOptions": {
"$ref": "DriveOptions",
- "description": "For Drive search, specify more options in this field."
+ "description": "Set Drive search-specific options."
},
"endTime": {
- "description": "The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.",
+ "description": "The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.",
"format": "google-datetime",
"type": "string"
},
"hangoutsChatInfo": {
"$ref": "HangoutsChatInfo",
- "description": "When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only)"
+ "description": "Required when **SearchMethod** is **ROOM**. (read-only)"
},
"hangoutsChatOptions": {
"$ref": "HangoutsChatOptions",
- "description": "For hangouts chat search, specify more options in this field. (read-only)"
+ "description": "Set Chat search-specific options. (read-only)"
},
"mailOptions": {
"$ref": "MailOptions",
- "description": "For mail search, specify more options in this field."
+ "description": "Set Gmail search-specific options."
},
"method": {
- "description": "The search method to use. This field is similar to the search_method field but is introduced to support shared drives. It supports all search method types. In case the search_method is TEAM_DRIVE the response of this field will be SHARED_DRIVE only.",
+ "description": "The entity to search. This field replaces **searchMethod** to support shared drives. When **searchMethod** is **TEAM_DRIVE**, the response of this field is **SHARED_DRIVE**.",
"enum": [
"SEARCH_METHOD_UNSPECIFIED",
"ACCOUNT",
@@ -2312,19 +2312,19 @@
"SHARED_DRIVE"
],
"enumDescriptions": [
- "A search method must be specified. If a request does not specify a search method, it will be rejected.",
- "Will search all accounts provided in account_info.",
- "Will search all accounts in the OU specified in org_unit_info.",
- "Will search for all accounts in the Team Drive specified in team_drive_info.",
- "Will search for all accounts in the organization. No need to set account_info or org_unit_info. Not all CORPUS_TYPE support this scope. Supported by MAIL.",
- "Will search in the Room specified in hangout_chats_info. (read-only)",
- "Will search for all accounts in the shared drive specified in shared_drive_info."
+ "A search method must be specified or else it is rejected.",
+ "Search the data of the accounts specified in [AccountInfo](https://developers.google.com/vault/reference/rest/v1/Query#accountinfo).",
+ "Search the data of all accounts in the organizational unit specified in [OrgUnitInfo](https://developers.google.com/vault/reference/rest/v1/Query#orgunitinfo).",
+ "Search the data in the Team Drive specified in **team_drive_info**.",
+ "Search the data of all accounts in the organization. Supported only for Gmail. When specified, you don't need to specify **AccountInfo** or **OrgUnitInfo**.",
+ "Search messages in the Chat spaces specified in [HangoutsChatInfo](https://developers.google.com/vault/reference/rest/v1/Query#hangoutschatinfo).",
+ "Search the files in the shared drives specified in [SharedDriveInfo](https://developers.devsite.corp.google.com/vault/reference/rest/v1/Query#shareddriveinfo)."
],
"type": "string"
},
"orgUnitInfo": {
"$ref": "OrgUnitInfo",
- "description": "When 'ORG_UNIT' is chosen as as search method, org_unit_info needs to be specified."
+ "description": "Required when **SearchMethod** is **ORG_UNIT**."
},
"searchMethod": {
"description": "The search method to use.",
@@ -2338,40 +2338,40 @@
"SHARED_DRIVE"
],
"enumDescriptions": [
- "A search method must be specified. If a request does not specify a search method, it will be rejected.",
- "Will search all accounts provided in account_info.",
- "Will search all accounts in the OU specified in org_unit_info.",
- "Will search for all accounts in the Team Drive specified in team_drive_info.",
- "Will search for all accounts in the organization. No need to set account_info or org_unit_info. Not all CORPUS_TYPE support this scope. Supported by MAIL.",
- "Will search in the Room specified in hangout_chats_info. (read-only)",
- "Will search for all accounts in the shared drive specified in shared_drive_info."
+ "A search method must be specified or else it is rejected.",
+ "Search the data of the accounts specified in [AccountInfo](https://developers.google.com/vault/reference/rest/v1/Query#accountinfo).",
+ "Search the data of all accounts in the organizational unit specified in [OrgUnitInfo](https://developers.google.com/vault/reference/rest/v1/Query#orgunitinfo).",
+ "Search the data in the Team Drive specified in **team_drive_info**.",
+ "Search the data of all accounts in the organization. Supported only for Gmail. When specified, you don't need to specify **AccountInfo** or **OrgUnitInfo**.",
+ "Search messages in the Chat spaces specified in [HangoutsChatInfo](https://developers.google.com/vault/reference/rest/v1/Query#hangoutschatinfo).",
+ "Search the files in the shared drives specified in [SharedDriveInfo](https://developers.devsite.corp.google.com/vault/reference/rest/v1/Query#shareddriveinfo)."
],
"type": "string"
},
"sharedDriveInfo": {
"$ref": "SharedDriveInfo",
- "description": "When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs to be specified."
+ "description": "Required when **SearchMethod** is **SHARED_DRIVE**."
},
"startTime": {
- "description": "The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.",
+ "description": "The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.",
"format": "google-datetime",
"type": "string"
},
"teamDriveInfo": {
"$ref": "TeamDriveInfo",
- "description": "When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be specified."
+ "description": "Required when **SearchMethod** is **TEAM_DRIVE**."
},
"terms": {
- "description": "The corpus-specific search operators used to generate search results.",
+ "description": "Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.",
"type": "string"
},
"timeZone": {
- "description": "The time zone name. It should be an IANA TZ name, such as \"America/Los_Angeles\". For more information, see Time Zone.",
+ "description": "The time zone name. It should be an IANA TZ name, such as \"America/Los_Angeles\". For a list of time zone names, see [Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For more information about how Vault uses time zones, see [the Vault help center](https://support.google.com/vault/answer/6092995#time).",
"type": "string"
},
"voiceOptions": {
"$ref": "VoiceOptions",
- "description": "For voice search, specify more options in this field."
+ "description": "Set Voice search-specific options."
}
},
"type": "object"
@@ -2381,7 +2381,7 @@
"id": "RemoveHeldAccountsRequest",
"properties": {
"accountIds": {
- "description": "Account IDs to identify HeldAccounts to remove.",
+ "description": "The account IDs of the accounts to remove from the hold.",
"items": {
"type": "string"
},
@@ -2395,7 +2395,7 @@
"id": "RemoveHeldAccountsResponse",
"properties": {
"statuses": {
- "description": "A list of statuses for deleted accounts. Results have the same order as the request.",
+ "description": "A list of statuses for the deleted accounts. Results have the same order as the request.",
"items": {
"$ref": "Status"
},
@@ -2427,31 +2427,31 @@
"properties": {
"matter": {
"$ref": "Matter",
- "description": "The updated matter, with state OPEN."
+ "description": "The updated matter, with state **OPEN**."
}
},
"type": "object"
},
"SavedQuery": {
- "description": "Definition of the saved query. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.",
+ "description": "The definition of a saved query. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.",
"id": "SavedQuery",
"properties": {
"createTime": {
- "description": "Output only. The server generated timestamp at which saved query was created.",
+ "description": "Output only. The server-generated timestamp when the saved query was created.",
"format": "google-datetime",
"type": "string"
},
"displayName": {
- "description": "Name of the saved query.",
+ "description": "The name of the saved query.",
"type": "string"
},
"matterId": {
- "description": "Output only. The matter ID of the associated matter. The server does not look at this field during create and always uses matter id in the URL.",
+ "description": "Output only. The matter ID of the matter the saved query is saved in. The server does not use this field during create and always uses matter ID in the URL.",
"type": "string"
},
"query": {
"$ref": "Query",
- "description": "The underlying Query object which contains all the information of the saved query."
+ "description": "The search parameters of the saved query."
},
"savedQueryId": {
"description": "A unique identifier for the saved query.",
@@ -2461,11 +2461,11 @@
"type": "object"
},
"SharedDriveInfo": {
- "description": "Shared drives to search",
+ "description": "The shared drives to search",
"id": "SharedDriveInfo",
"properties": {
"sharedDriveIds": {
- "description": "List of Shared drive IDs, as provided by Drive API.",
+ "description": "A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).",
"items": {
"type": "string"
},
@@ -2506,7 +2506,7 @@
"id": "TeamDriveInfo",
"properties": {
"teamDriveIds": {
- "description": "List of Team Drive IDs, as provided by Drive API.",
+ "description": "List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).",
"items": {
"type": "string"
},
@@ -2537,11 +2537,11 @@
"type": "object"
},
"VoiceExportOptions": {
- "description": "The options for voice export.",
+ "description": "The options for Voice exports.",
"id": "VoiceExportOptions",
"properties": {
"exportFormat": {
- "description": "The export format for voice export.",
+ "description": "The file format for exported text messages.",
"enum": [
"EXPORT_FORMAT_UNSPECIFIED",
"MBOX",
@@ -2549,8 +2549,8 @@
],
"enumDescriptions": [
"No export format specified.",
- "MBOX as export format.",
- "PST as export format"
+ "Export as MBOX.",
+ "Export as PST."
],
"type": "string"
}
@@ -2558,7 +2558,7 @@
"type": "object"
},
"VoiceOptions": {
- "description": "Voice search options",
+ "description": "Additional options for Voice search",
"id": "VoiceOptions",
"properties": {
"coveredData": {
@@ -2572,9 +2572,9 @@
],
"enumDescriptions": [
"Covered data unspecified.",
- "Voice text message will be covered.",
- "Voicemail will be covered.",
- "Call logs will be covered."
+ "Voice text messages.",
+ "Voicemails and their transcripts.",
+ "Call logs."
],
"type": "string"
},