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/docs/dyn/vault_v1.matters.holds.html b/docs/dyn/vault_v1.matters.holds.html
index 8689057..1626d4f 100644
--- a/docs/dyn/vault_v1.matters.holds.html
+++ b/docs/dyn/vault_v1.matters.holds.html
@@ -81,35 +81,35 @@
<p class="toc_element">
<code><a href="#addHeldAccounts">addHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">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.</p>
+<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(matterId, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a hold in the given matter.</p>
+<p class="firstline">Creates a hold in the specified matter.</p>
<p class="toc_element">
<code><a href="#delete">delete(matterId, holdId, x__xgafv=None)</a></code></p>
-<p class="firstline">Removes a hold by ID. This will release any HeldAccounts on this Hold.</p>
+<p class="firstline">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.</p>
<p class="toc_element">
<code><a href="#get">get(matterId, holdId, view=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets a hold by ID.</p>
+<p class="firstline">Gets the specified hold.</p>
<p class="toc_element">
<code><a href="#list">list(matterId, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list.</p>
+<p class="firstline">Lists the holds in a matter.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#removeHeldAccounts">removeHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">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.</p>
+<p class="firstline">Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.</p>
<p class="toc_element">
<code><a href="#update">update(matterId, holdId, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">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.</p>
+<p class="firstline">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.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="addHeldAccounts">addHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</code>
- <pre>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.
+ <pre>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.
Args:
matterId: string, The matter ID. (required)
@@ -118,10 +118,10 @@
The object takes the form of:
{ # Add a list of accounts to a hold.
- "accountIds": [ # Account IDs to identify which accounts to add. Only account_ids or only emails should be specified, but not both.
+ "accountIds": [ # 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.
"A String",
],
- "emails": [ # Emails to identify which accounts to add. Only emails or only account_ids should be specified, but not both.
+ "emails": [ # A comma-separated list of the emails of the accounts to add to the hold. Specify either **emails** or **account_ids**, but not both.
"A String",
],
}
@@ -136,15 +136,15 @@
{ # Response for batch create held accounts.
"responses": [ # The list of responses, in the same order as the batch request.
- { # A status detailing the status of each account creation, and the HeldAccount, if successful.
- "account": { # 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. # If present, this account was successfully created.
- "accountId": "A String", # The account's ID as provided by the Admin SDK.
- "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.
+ { # The status of each account creation, and the **HeldAccount**, if successful.
+ "account": { # 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. # Returned when the account was successfully created.
+ "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
+ "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over **accountId**.
"firstName": "A String", # Output only. The first name of the account holder.
"holdTime": "A String", # Output only. When the account was put on hold.
"lastName": "A String", # Output only. The last name of the account holder.
},
- "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # This represents the success status. If failed, check message.
+ "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Reports the request status. If it failed, returns an error message.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
@@ -165,50 +165,50 @@
<div class="method">
<code class="details" id="create">create(matterId, body=None, x__xgafv=None)</code>
- <pre>Creates a hold in the given matter.
+ <pre>Creates a hold in the specified matter.
Args:
matterId: string, The matter ID. (required)
body: object, The request body.
The object takes the form of:
-{ # 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.
- "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be empty.
- { # 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.
- "accountId": "A String", # The account's ID as provided by the Admin SDK.
- "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.
+{ # 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.
+ "accounts": [ # If set, the hold applies to the specified accounts and **orgUnit** must be empty.
+ { # 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.
+ "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
+ "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over **accountId**.
"firstName": "A String", # Output only. The first name of the account holder.
"holdTime": "A String", # Output only. When the account was put on hold.
"lastName": "A String", # Output only. The last name of the account holder.
},
],
- "corpus": "A String", # The corpus to be searched.
+ "corpus": "A String", # The service to be searched.
"holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
"name": "A String", # The name of the hold.
- "orgUnit": { # A organizational unit being held in a particular hold. This structure is immutable. # 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.
- "holdTime": "A String", # When the org unit was put on hold. This property is immutable.
- "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
+ "orgUnit": { # The organizational unit covered by a hold. This structure is immutable. # 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**.
+ "holdTime": "A String", # When the organizational unit was put on hold. This property is immutable.
+ "orgUnitId": "A String", # The organizational unit's immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
},
- "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
- "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
- "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold.
- "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.
+ "query": { # Service-specific options for holds. # Service-specific options. If set, **CorpusQuery** must match **CorpusType**.
+ "driveQuery": { # Options for Drive holds. # Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**.
+ "includeSharedDriveFiles": True or False, # To include files in shared drives in the hold, set to **true**.
+ "includeTeamDriveFiles": True or False, # To include files in Team Drives in the hold, set to **true**.
},
- "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
- "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "terms": "A String", # The search terms for the hold.
+ "groupsQuery": { # Query options for group holds. # Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**.
+ "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
},
- "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.
- "includeRooms": True or False, # If true, include rooms the user has participated in.
+ "hangoutsChatQuery": { # Options for Chat holds. # Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**.
+ "includeRooms": True or False, # To include messages in Chat spaces the user was a member of, set to **true**.
},
- "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
- "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "terms": "A String", # The search terms for the hold.
+ "mailQuery": { # Query options for Gmail holds. # Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**.
+ "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
},
- "voiceQuery": { # Query options for Voice holds. # Details pertaining to Voice holds. If set, corpus must be Voice.
- "coveredData": [ # Data covered by this rule. Should be non-empty. Order does not matter and duplicates will be ignored.
+ "voiceQuery": { # Options for Voice holds. # Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**.
+ "coveredData": [ # A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.
"A String",
],
},
@@ -224,43 +224,43 @@
Returns:
An object of the form:
- { # 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.
- "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be empty.
- { # 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.
- "accountId": "A String", # The account's ID as provided by the Admin SDK.
- "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.
+ { # 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.
+ "accounts": [ # If set, the hold applies to the specified accounts and **orgUnit** must be empty.
+ { # 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.
+ "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
+ "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over **accountId**.
"firstName": "A String", # Output only. The first name of the account holder.
"holdTime": "A String", # Output only. When the account was put on hold.
"lastName": "A String", # Output only. The last name of the account holder.
},
],
- "corpus": "A String", # The corpus to be searched.
+ "corpus": "A String", # The service to be searched.
"holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
"name": "A String", # The name of the hold.
- "orgUnit": { # A organizational unit being held in a particular hold. This structure is immutable. # 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.
- "holdTime": "A String", # When the org unit was put on hold. This property is immutable.
- "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
+ "orgUnit": { # The organizational unit covered by a hold. This structure is immutable. # 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**.
+ "holdTime": "A String", # When the organizational unit was put on hold. This property is immutable.
+ "orgUnitId": "A String", # The organizational unit's immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
},
- "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
- "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
- "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold.
- "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.
+ "query": { # Service-specific options for holds. # Service-specific options. If set, **CorpusQuery** must match **CorpusType**.
+ "driveQuery": { # Options for Drive holds. # Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**.
+ "includeSharedDriveFiles": True or False, # To include files in shared drives in the hold, set to **true**.
+ "includeTeamDriveFiles": True or False, # To include files in Team Drives in the hold, set to **true**.
},
- "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
- "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "terms": "A String", # The search terms for the hold.
+ "groupsQuery": { # Query options for group holds. # Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**.
+ "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
},
- "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.
- "includeRooms": True or False, # If true, include rooms the user has participated in.
+ "hangoutsChatQuery": { # Options for Chat holds. # Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**.
+ "includeRooms": True or False, # To include messages in Chat spaces the user was a member of, set to **true**.
},
- "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
- "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "terms": "A String", # The search terms for the hold.
+ "mailQuery": { # Query options for Gmail holds. # Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**.
+ "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
},
- "voiceQuery": { # Query options for Voice holds. # Details pertaining to Voice holds. If set, corpus must be Voice.
- "coveredData": [ # Data covered by this rule. Should be non-empty. Order does not matter and duplicates will be ignored.
+ "voiceQuery": { # Options for Voice holds. # Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**.
+ "coveredData": [ # A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.
"A String",
],
},
@@ -271,7 +271,7 @@
<div class="method">
<code class="details" id="delete">delete(matterId, holdId, x__xgafv=None)</code>
- <pre>Removes a hold by ID. This will release any HeldAccounts on this Hold.
+ <pre>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.
Args:
matterId: string, The matter ID. (required)
@@ -290,16 +290,16 @@
<div class="method">
<code class="details" id="get">get(matterId, holdId, view=None, x__xgafv=None)</code>
- <pre>Gets a hold by ID.
+ <pre>Gets the specified hold.
Args:
matterId: string, The matter ID. (required)
holdId: string, The hold ID. (required)
- view: string, Specifies which parts of the Hold to return.
+ view: string, The amount of detail to return for a hold.
Allowed values
- HOLD_VIEW_UNSPECIFIED - There is no specified view. Defaults to FULL_HOLD.
- BASIC_HOLD - Response includes the id, name, update time, corpus, and query.
- FULL_HOLD - Full representation of a Hold. Response includes all fields of 'BASIC' and the entities the Hold applies to, such as accounts, or OU.
+ HOLD_VIEW_UNSPECIFIED - Not specified. Defaults to **FULL_HOLD**.
+ BASIC_HOLD - Returns the hold ID, name, update time, service, and query.
+ FULL_HOLD - Returns all details of **BASIC_HOLD** and the entities the hold applies to, such as accounts or organizational unit.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -308,43 +308,43 @@
Returns:
An object of the form:
- { # 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.
- "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be empty.
- { # 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.
- "accountId": "A String", # The account's ID as provided by the Admin SDK.
- "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.
+ { # 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.
+ "accounts": [ # If set, the hold applies to the specified accounts and **orgUnit** must be empty.
+ { # 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.
+ "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
+ "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over **accountId**.
"firstName": "A String", # Output only. The first name of the account holder.
"holdTime": "A String", # Output only. When the account was put on hold.
"lastName": "A String", # Output only. The last name of the account holder.
},
],
- "corpus": "A String", # The corpus to be searched.
+ "corpus": "A String", # The service to be searched.
"holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
"name": "A String", # The name of the hold.
- "orgUnit": { # A organizational unit being held in a particular hold. This structure is immutable. # 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.
- "holdTime": "A String", # When the org unit was put on hold. This property is immutable.
- "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
+ "orgUnit": { # The organizational unit covered by a hold. This structure is immutable. # 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**.
+ "holdTime": "A String", # When the organizational unit was put on hold. This property is immutable.
+ "orgUnitId": "A String", # The organizational unit's immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
},
- "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
- "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
- "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold.
- "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.
+ "query": { # Service-specific options for holds. # Service-specific options. If set, **CorpusQuery** must match **CorpusType**.
+ "driveQuery": { # Options for Drive holds. # Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**.
+ "includeSharedDriveFiles": True or False, # To include files in shared drives in the hold, set to **true**.
+ "includeTeamDriveFiles": True or False, # To include files in Team Drives in the hold, set to **true**.
},
- "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
- "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "terms": "A String", # The search terms for the hold.
+ "groupsQuery": { # Query options for group holds. # Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**.
+ "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
},
- "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.
- "includeRooms": True or False, # If true, include rooms the user has participated in.
+ "hangoutsChatQuery": { # Options for Chat holds. # Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**.
+ "includeRooms": True or False, # To include messages in Chat spaces the user was a member of, set to **true**.
},
- "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
- "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "terms": "A String", # The search terms for the hold.
+ "mailQuery": { # Query options for Gmail holds. # Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**.
+ "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
},
- "voiceQuery": { # Query options for Voice holds. # Details pertaining to Voice holds. If set, corpus must be Voice.
- "coveredData": [ # Data covered by this rule. Should be non-empty. Order does not matter and duplicates will be ignored.
+ "voiceQuery": { # Options for Voice holds. # Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**.
+ "coveredData": [ # A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.
"A String",
],
},
@@ -355,17 +355,17 @@
<div class="method">
<code class="details" id="list">list(matterId, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
- <pre>Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list.
+ <pre>Lists the holds in a matter.
Args:
matterId: string, The matter ID. (required)
- pageSize: integer, 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.
+ pageSize: integer, 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.
pageToken: string, The pagination token as returned in the response. An empty token means start from the beginning.
- view: string, Specifies which parts of the Hold to return.
+ view: string, The amount of detail to return for a hold.
Allowed values
- HOLD_VIEW_UNSPECIFIED - There is no specified view. Defaults to FULL_HOLD.
- BASIC_HOLD - Response includes the id, name, update time, corpus, and query.
- FULL_HOLD - Full representation of a Hold. Response includes all fields of 'BASIC' and the entities the Hold applies to, such as accounts, or OU.
+ HOLD_VIEW_UNSPECIFIED - Not specified. Defaults to **FULL_HOLD**.
+ BASIC_HOLD - Returns the hold ID, name, update time, service, and query.
+ FULL_HOLD - Returns all details of **BASIC_HOLD** and the entities the hold applies to, such as accounts or organizational unit.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -376,43 +376,43 @@
{ # The holds for a matter.
"holds": [ # The list of holds.
- { # 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.
- "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be empty.
- { # 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.
- "accountId": "A String", # The account's ID as provided by the Admin SDK.
- "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.
+ { # 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.
+ "accounts": [ # If set, the hold applies to the specified accounts and **orgUnit** must be empty.
+ { # 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.
+ "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
+ "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over **accountId**.
"firstName": "A String", # Output only. The first name of the account holder.
"holdTime": "A String", # Output only. When the account was put on hold.
"lastName": "A String", # Output only. The last name of the account holder.
},
],
- "corpus": "A String", # The corpus to be searched.
+ "corpus": "A String", # The service to be searched.
"holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
"name": "A String", # The name of the hold.
- "orgUnit": { # A organizational unit being held in a particular hold. This structure is immutable. # 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.
- "holdTime": "A String", # When the org unit was put on hold. This property is immutable.
- "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
+ "orgUnit": { # The organizational unit covered by a hold. This structure is immutable. # 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**.
+ "holdTime": "A String", # When the organizational unit was put on hold. This property is immutable.
+ "orgUnitId": "A String", # The organizational unit's immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
},
- "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
- "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
- "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold.
- "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.
+ "query": { # Service-specific options for holds. # Service-specific options. If set, **CorpusQuery** must match **CorpusType**.
+ "driveQuery": { # Options for Drive holds. # Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**.
+ "includeSharedDriveFiles": True or False, # To include files in shared drives in the hold, set to **true**.
+ "includeTeamDriveFiles": True or False, # To include files in Team Drives in the hold, set to **true**.
},
- "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
- "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "terms": "A String", # The search terms for the hold.
+ "groupsQuery": { # Query options for group holds. # Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**.
+ "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
},
- "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.
- "includeRooms": True or False, # If true, include rooms the user has participated in.
+ "hangoutsChatQuery": { # Options for Chat holds. # Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**.
+ "includeRooms": True or False, # To include messages in Chat spaces the user was a member of, set to **true**.
},
- "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
- "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "terms": "A String", # The search terms for the hold.
+ "mailQuery": { # Query options for Gmail holds. # Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**.
+ "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
},
- "voiceQuery": { # Query options for Voice holds. # Details pertaining to Voice holds. If set, corpus must be Voice.
- "coveredData": [ # Data covered by this rule. Should be non-empty. Order does not matter and duplicates will be ignored.
+ "voiceQuery": { # Options for Voice holds. # Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**.
+ "coveredData": [ # A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.
"A String",
],
},
@@ -440,7 +440,7 @@
<div class="method">
<code class="details" id="removeHeldAccounts">removeHeldAccounts(matterId, holdId, body=None, x__xgafv=None)</code>
- <pre>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.
+ <pre>Removes the specified accounts from a hold. Returns a list of statuses in the same order as the request.
Args:
matterId: string, The matter ID. (required)
@@ -449,7 +449,7 @@
The object takes the form of:
{ # Remove a list of accounts from a hold.
- "accountIds": [ # Account IDs to identify HeldAccounts to remove.
+ "accountIds": [ # The account IDs of the accounts to remove from the hold.
"A String",
],
}
@@ -463,7 +463,7 @@
An object of the form:
{ # Response for batch delete held accounts.
- "statuses": [ # A list of statuses for deleted accounts. Results have the same order as the request.
+ "statuses": [ # A list of statuses for the deleted accounts. Results have the same order as the request.
{ # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
@@ -479,7 +479,7 @@
<div class="method">
<code class="details" id="update">update(matterId, holdId, body=None, x__xgafv=None)</code>
- <pre>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.
+ <pre>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.
Args:
matterId: string, The matter ID. (required)
@@ -487,43 +487,43 @@
body: object, The request body.
The object takes the form of:
-{ # 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.
- "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be empty.
- { # 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.
- "accountId": "A String", # The account's ID as provided by the Admin SDK.
- "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.
+{ # 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.
+ "accounts": [ # If set, the hold applies to the specified accounts and **orgUnit** must be empty.
+ { # 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.
+ "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
+ "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over **accountId**.
"firstName": "A String", # Output only. The first name of the account holder.
"holdTime": "A String", # Output only. When the account was put on hold.
"lastName": "A String", # Output only. The last name of the account holder.
},
],
- "corpus": "A String", # The corpus to be searched.
+ "corpus": "A String", # The service to be searched.
"holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
"name": "A String", # The name of the hold.
- "orgUnit": { # A organizational unit being held in a particular hold. This structure is immutable. # 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.
- "holdTime": "A String", # When the org unit was put on hold. This property is immutable.
- "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
+ "orgUnit": { # The organizational unit covered by a hold. This structure is immutable. # 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**.
+ "holdTime": "A String", # When the organizational unit was put on hold. This property is immutable.
+ "orgUnitId": "A String", # The organizational unit's immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
},
- "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
- "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
- "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold.
- "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.
+ "query": { # Service-specific options for holds. # Service-specific options. If set, **CorpusQuery** must match **CorpusType**.
+ "driveQuery": { # Options for Drive holds. # Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**.
+ "includeSharedDriveFiles": True or False, # To include files in shared drives in the hold, set to **true**.
+ "includeTeamDriveFiles": True or False, # To include files in Team Drives in the hold, set to **true**.
},
- "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
- "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "terms": "A String", # The search terms for the hold.
+ "groupsQuery": { # Query options for group holds. # Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**.
+ "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
},
- "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.
- "includeRooms": True or False, # If true, include rooms the user has participated in.
+ "hangoutsChatQuery": { # Options for Chat holds. # Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**.
+ "includeRooms": True or False, # To include messages in Chat spaces the user was a member of, set to **true**.
},
- "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
- "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "terms": "A String", # The search terms for the hold.
+ "mailQuery": { # Query options for Gmail holds. # Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**.
+ "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
},
- "voiceQuery": { # Query options for Voice holds. # Details pertaining to Voice holds. If set, corpus must be Voice.
- "coveredData": [ # Data covered by this rule. Should be non-empty. Order does not matter and duplicates will be ignored.
+ "voiceQuery": { # Options for Voice holds. # Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**.
+ "coveredData": [ # A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.
"A String",
],
},
@@ -539,43 +539,43 @@
Returns:
An object of the form:
- { # 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.
- "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be empty.
- { # 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.
- "accountId": "A String", # The account's ID as provided by the Admin SDK.
- "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.
+ { # 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.
+ "accounts": [ # If set, the hold applies to the specified accounts and **orgUnit** must be empty.
+ { # 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.
+ "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
+ "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over **accountId**.
"firstName": "A String", # Output only. The first name of the account holder.
"holdTime": "A String", # Output only. When the account was put on hold.
"lastName": "A String", # Output only. The last name of the account holder.
},
],
- "corpus": "A String", # The corpus to be searched.
+ "corpus": "A String", # The service to be searched.
"holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
"name": "A String", # The name of the hold.
- "orgUnit": { # A organizational unit being held in a particular hold. This structure is immutable. # 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.
- "holdTime": "A String", # When the org unit was put on hold. This property is immutable.
- "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
+ "orgUnit": { # The organizational unit covered by a hold. This structure is immutable. # 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**.
+ "holdTime": "A String", # When the organizational unit was put on hold. This property is immutable.
+ "orgUnitId": "A String", # The organizational unit's immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
},
- "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
- "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
- "includeSharedDriveFiles": True or False, # If true, include files in shared drives in the hold.
- "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.
+ "query": { # Service-specific options for holds. # Service-specific options. If set, **CorpusQuery** must match **CorpusType**.
+ "driveQuery": { # Options for Drive holds. # Service-specific options for Drive holds. If set, **CorpusType** must be **DRIVE**.
+ "includeSharedDriveFiles": True or False, # To include files in shared drives in the hold, set to **true**.
+ "includeTeamDriveFiles": True or False, # To include files in Team Drives in the hold, set to **true**.
},
- "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
- "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "terms": "A String", # The search terms for the hold.
+ "groupsQuery": { # Query options for group holds. # Service-specific options for Groups holds. If set, **CorpusType** must be **GROUPS**.
+ "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
},
- "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be Hangouts Chat.
- "includeRooms": True or False, # If true, include rooms the user has participated in.
+ "hangoutsChatQuery": { # Options for Chat holds. # Service-specific options for Chat holds. If set, **CorpusType** must be **HANGOUTS_CHAT**.
+ "includeRooms": True or False, # To include messages in Chat spaces the user was a member of, set to **true**.
},
- "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
- "endTime": "A String", # The end time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "startTime": "A String", # The start time range for the search query. These timestamps are in GMT and rounded down to the start of the given date.
- "terms": "A String", # The search terms for the hold.
+ "mailQuery": { # Query options for Gmail holds. # Service-specific options for Gmail holds. If set, **CorpusType** must be **MAIL**.
+ "endTime": "A String", # The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "startTime": "A String", # The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "terms": "A String", # The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
},
- "voiceQuery": { # Query options for Voice holds. # Details pertaining to Voice holds. If set, corpus must be Voice.
- "coveredData": [ # Data covered by this rule. Should be non-empty. Order does not matter and duplicates will be ignored.
+ "voiceQuery": { # Options for Voice holds. # Service-specific options for Voice holds. If set, **CorpusType** must be **VOICE**.
+ "coveredData": [ # A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.
"A String",
],
},