chore: update docs/dyn (#1106)
diff --git a/docs/dyn/vault_v1.matters.holds.html b/docs/dyn/vault_v1.matters.holds.html
index 35d7a68..468ac17 100644
--- a/docs/dyn/vault_v1.matters.holds.html
+++ b/docs/dyn/vault_v1.matters.holds.html
@@ -95,7 +95,7 @@
<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="toc_element">
- <code><a href="#list">list(matterId, view=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(matterId, pageToken=None, pageSize=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="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -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.
+ "emails": [ # Emails to identify which accounts to add. Only emails or only account_ids should be specified, 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.
+ "accountIds": [ # Account IDs to identify which accounts to add. Only account_ids or only emails should be specified, but not both.
"A String",
],
}
@@ -137,22 +137,22 @@
{ # 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. # If present, this account was successfully created.
+ "firstName": "A String", # Output only. The first name of the account holder.
+ "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.
+ "holdTime": "A String", # Output only. When the account was put on hold.
+ "lastName": "A String", # Output only. The last name of the account holder.
+ "accountId": "A String", # The account's ID as provided by the Admin SDK.
+ },
"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.
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
- "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. # 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.
- "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.
- },
},
],
}</pre>
@@ -173,43 +173,48 @@
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.
- "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
- "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
- "terms": "A String", # The search terms for the hold.
- "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.
+ "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.
},
- "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.
+ "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.
+ "firstName": "A String", # Output only. The first name of the account holder.
+ "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.
+ "holdTime": "A String", # Output only. When the account was put on hold.
+ "lastName": "A String", # Output only. The last name of the account holder.
+ "accountId": "A String", # The account's ID as provided by the Admin SDK.
+ },
+ ],
+ "name": "A String", # The name of the hold.
+ "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
+ "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
+ "terms": "A String", # The search terms for the hold.
+ "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.
+ "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.
+ },
+ "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
+ "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.
+ "includeSharedDriveFiles": True or False, # If true, include files in shared drives in 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.
+ "A String",
+ ],
+ },
+ "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.
+ "terms": "A String", # The search terms for the hold.
+ "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.
+ },
+ "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.
+ },
},
- "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
- "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.
- "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.
- "terms": "A String", # The search terms for 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.
- },
- },
- "updateTime": "A String", # The last time this hold was modified.
- "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.
- "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
- "holdTime": "A String", # When the org unit was put on hold. This property is immutable.
- },
- "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.
- "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.
- "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.
- "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
- "name": "A String", # The name of the hold.
-}
+ "corpus": "A String", # The corpus to be searched.
+ "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
+ "updateTime": "A String", # The last time this hold was modified.
+ }
x__xgafv: string, V1 error format.
Allowed values
@@ -220,43 +225,48 @@
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.
- "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
- "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
- "terms": "A String", # The search terms for the hold.
- "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.
+ "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.
},
- "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.
+ "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.
+ "firstName": "A String", # Output only. The first name of the account holder.
+ "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.
+ "holdTime": "A String", # Output only. When the account was put on hold.
+ "lastName": "A String", # Output only. The last name of the account holder.
+ "accountId": "A String", # The account's ID as provided by the Admin SDK.
+ },
+ ],
+ "name": "A String", # The name of the hold.
+ "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
+ "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
+ "terms": "A String", # The search terms for the hold.
+ "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.
+ "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.
+ },
+ "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
+ "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.
+ "includeSharedDriveFiles": True or False, # If true, include files in shared drives in 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.
+ "A String",
+ ],
+ },
+ "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.
+ "terms": "A String", # The search terms for the hold.
+ "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.
+ },
+ "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.
+ },
},
- "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
- "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.
- "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.
- "terms": "A String", # The search terms for 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.
- },
- },
- "updateTime": "A String", # The last time this hold was modified.
- "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.
- "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
- "holdTime": "A String", # When the org unit was put on hold. This property is immutable.
- },
- "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.
- "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.
- "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.
- "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
- "name": "A String", # The name of the hold.
- }</pre>
+ "corpus": "A String", # The corpus to be searched.
+ "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
+ "updateTime": "A String", # The last time this hold was modified.
+ }</pre>
</div>
<div class="method">
@@ -299,58 +309,63 @@
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.
- "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
- "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
- "terms": "A String", # The search terms for the hold.
- "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.
+ "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.
},
- "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.
+ "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.
+ "firstName": "A String", # Output only. The first name of the account holder.
+ "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.
+ "holdTime": "A String", # Output only. When the account was put on hold.
+ "lastName": "A String", # Output only. The last name of the account holder.
+ "accountId": "A String", # The account's ID as provided by the Admin SDK.
+ },
+ ],
+ "name": "A String", # The name of the hold.
+ "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
+ "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
+ "terms": "A String", # The search terms for the hold.
+ "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.
+ "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.
+ },
+ "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
+ "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.
+ "includeSharedDriveFiles": True or False, # If true, include files in shared drives in 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.
+ "A String",
+ ],
+ },
+ "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.
+ "terms": "A String", # The search terms for the hold.
+ "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.
+ },
+ "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.
+ },
},
- "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
- "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.
- "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.
- "terms": "A String", # The search terms for 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.
- },
- },
- "updateTime": "A String", # The last time this hold was modified.
- "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.
- "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
- "holdTime": "A String", # When the org unit was put on hold. This property is immutable.
- },
- "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.
- "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.
- "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.
- "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
- "name": "A String", # The name of the hold.
- }</pre>
+ "corpus": "A String", # The corpus to be searched.
+ "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
+ "updateTime": "A String", # The last time this hold was modified.
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(matterId, view=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(matterId, pageToken=None, pageSize=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.
Args:
matterId: string, The matter ID. (required)
+ pageToken: string, The pagination token as returned in the response. An empty token means start from the beginning.
+ 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.
view: string, Specifies which parts of the Hold to return.
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.
- pageToken: string, The pagination token as returned in the response. An empty token means start from the beginning.
- 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -363,43 +378,48 @@
"nextPageToken": "A String", # Page token to retrieve the next page of results in the list. If this is empty, then there are no more holds to list.
"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.
- "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
- "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
- "terms": "A String", # The search terms for the hold.
- "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.
+ "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.
},
- "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.
+ "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.
+ "firstName": "A String", # Output only. The first name of the account holder.
+ "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.
+ "holdTime": "A String", # Output only. When the account was put on hold.
+ "lastName": "A String", # Output only. The last name of the account holder.
+ "accountId": "A String", # The account's ID as provided by the Admin SDK.
+ },
+ ],
+ "name": "A String", # The name of the hold.
+ "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
+ "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
+ "terms": "A String", # The search terms for the hold.
+ "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.
+ "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.
+ },
+ "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
+ "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.
+ "includeSharedDriveFiles": True or False, # If true, include files in shared drives in 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.
+ "A String",
+ ],
+ },
+ "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.
+ "terms": "A String", # The search terms for the hold.
+ "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.
+ },
+ "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.
+ },
},
- "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
- "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.
- "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.
- "terms": "A String", # The search terms for 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.
- },
+ "corpus": "A String", # The corpus to be searched.
+ "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
+ "updateTime": "A String", # The last time this hold was modified.
},
- "updateTime": "A String", # The last time this hold was modified.
- "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.
- "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
- "holdTime": "A String", # When the org unit was put on hold. This property is immutable.
- },
- "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.
- "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.
- "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.
- "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
- "name": "A String", # The name of the hold.
- },
],
}</pre>
</div>
@@ -445,12 +465,12 @@
{ # Response for batch delete held accounts.
"statuses": [ # A list of statuses for 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).
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
],
@@ -468,43 +488,48 @@
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.
- "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
- "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
- "terms": "A String", # The search terms for the hold.
- "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.
+ "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.
},
- "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.
+ "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.
+ "firstName": "A String", # Output only. The first name of the account holder.
+ "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.
+ "holdTime": "A String", # Output only. When the account was put on hold.
+ "lastName": "A String", # Output only. The last name of the account holder.
+ "accountId": "A String", # The account's ID as provided by the Admin SDK.
+ },
+ ],
+ "name": "A String", # The name of the hold.
+ "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
+ "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
+ "terms": "A String", # The search terms for the hold.
+ "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.
+ "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.
+ },
+ "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
+ "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.
+ "includeSharedDriveFiles": True or False, # If true, include files in shared drives in 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.
+ "A String",
+ ],
+ },
+ "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.
+ "terms": "A String", # The search terms for the hold.
+ "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.
+ },
+ "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.
+ },
},
- "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
- "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.
- "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.
- "terms": "A String", # The search terms for 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.
- },
- },
- "updateTime": "A String", # The last time this hold was modified.
- "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.
- "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
- "holdTime": "A String", # When the org unit was put on hold. This property is immutable.
- },
- "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.
- "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.
- "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.
- "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
- "name": "A String", # The name of the hold.
-}
+ "corpus": "A String", # The corpus to be searched.
+ "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
+ "updateTime": "A String", # The last time this hold was modified.
+ }
x__xgafv: string, V1 error format.
Allowed values
@@ -515,43 +540,48 @@
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.
- "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
- "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
- "terms": "A String", # The search terms for the hold.
- "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.
+ "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.
},
- "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.
+ "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.
+ "firstName": "A String", # Output only. The first name of the account holder.
+ "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over account ID.
+ "holdTime": "A String", # Output only. When the account was put on hold.
+ "lastName": "A String", # Output only. The last name of the account holder.
+ "accountId": "A String", # The account's ID as provided by the Admin SDK.
+ },
+ ],
+ "name": "A String", # The name of the hold.
+ "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus type.
+ "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
+ "terms": "A String", # The search terms for the hold.
+ "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.
+ "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.
+ },
+ "driveQuery": { # Query options for Drive holds. # Details pertaining to Drive holds. If set, corpus must be Drive.
+ "includeTeamDriveFiles": True or False, # If true, include files in Team Drives in the hold.
+ "includeSharedDriveFiles": True or False, # If true, include files in shared drives in 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.
+ "A String",
+ ],
+ },
+ "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.
+ "terms": "A String", # The search terms for the hold.
+ "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.
+ },
+ "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.
+ },
},
- "groupsQuery": { # Query options for group holds. # Details pertaining to Groups holds. If set, corpus must be Groups.
- "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.
- "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.
- "terms": "A String", # The search terms for 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.
- },
- },
- "updateTime": "A String", # The last time this hold was modified.
- "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.
- "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
- "holdTime": "A String", # When the org unit was put on hold. This property is immutable.
- },
- "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.
- "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.
- "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.
- "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
- "name": "A String", # The name of the hold.
- }</pre>
+ "corpus": "A String", # The corpus to be searched.
+ "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
+ "updateTime": "A String", # The last time this hold was modified.
+ }</pre>
</div>
</body></html>
\ No newline at end of file