docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/vault_v1.matters.holds.html b/docs/dyn/vault_v1.matters.holds.html
index 23eec18..27f559f 100644
--- a/docs/dyn/vault_v1.matters.holds.html
+++ b/docs/dyn/vault_v1.matters.holds.html
@@ -139,6 +139,16 @@
"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. # If present, this account was successfully created.
+ # 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.
+ "holdTime": "A String", # Output only. When the account was put on hold.
+ "lastName": "A String", # Output only. The last 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.
+ "accountId": "A String", # The account's ID as provided by the
+ # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ },
"status": { # The `Status` type defines a logical error model that is suitable for # This represents the success status. If failed, check message.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -157,16 +167,6 @@
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
},
- "account": { # An account being held in a particular hold. This structure is immutable. # If present, this account was successfully created.
- # This can be either a single user or a google group, depending on the corpus.
- "holdTime": "A String", # Output only. When the account was put on hold.
- "lastName": "A String", # Output only. The last 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.
- "accountId": "A String", # The account's ID as provided by the
- # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
- "firstName": "A String", # Output only. The first name of the account holder.
- },
},
],
}</pre>
@@ -182,93 +182,28 @@
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.
- "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.
- "holdTime": "A String", # Output only. When the account was put on hold.
- "lastName": "A String", # Output only. The last 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.
- "accountId": "A String", # The account's ID as provided by the
- # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
- "firstName": "A String", # Output only. The first name of the account holder.
- },
- ],
- "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.
- },
- "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.
- },
- "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.
- },
- "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.
- },
- },
- "orgUnit": { # A organizational unit being held in a particular hold. # 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.
- # This structure is immutable.
- "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.
- },
- "corpus": "A String", # The corpus to be searched.
- "updateTime": "A String", # The last time this hold was modified.
- "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
- "name": "A String", # The name of the hold.
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-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.
- "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.
- "holdTime": "A String", # Output only. When the account was put on hold.
- "lastName": "A String", # Output only. The last 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.
- "accountId": "A String", # The account's ID as provided by the
- # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
- "firstName": "A String", # Output only. The first name of the account holder.
- },
- ],
+ "orgUnit": { # A organizational unit being held in a particular hold. # 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.
+ # This structure is immutable.
+ "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.
+ },
"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.
+ "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.
+ },
"mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
+ "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.
"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.
},
"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
@@ -281,23 +216,88 @@
# Hangouts Chat.
"includeRooms": True or False, # If true, include rooms the user has participated in.
},
- "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.
- },
- },
- "orgUnit": { # A organizational unit being held in a particular hold. # 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.
- # This structure is immutable.
- "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.
},
"corpus": "A String", # The corpus to be searched.
"updateTime": "A String", # The last time this hold was modified.
"holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
"name": "A String", # The name of the hold.
- }</pre>
+ "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.
+ "holdTime": "A String", # Output only. When the account was put on hold.
+ "lastName": "A String", # Output only. The last 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.
+ "accountId": "A String", # The account's ID as provided by the
+ # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ },
+ ],
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+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.
+ "orgUnit": { # A organizational unit being held in a particular hold. # 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.
+ # This structure is immutable.
+ "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.
+ },
+ "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.
+ "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.
+ },
+ "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
+ "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.
+ "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.
+ },
+ "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.
+ },
+ "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.
+ "updateTime": "A String", # The last time this hold was modified.
+ "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
+ "name": "A String", # The name of 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.
+ "holdTime": "A String", # Output only. When the account was put on hold.
+ "lastName": "A String", # Output only. The last 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.
+ "accountId": "A String", # The account's ID as provided by the
+ # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ },
+ ],
+ }</pre>
</div>
<div class="method">
@@ -344,59 +344,59 @@
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.
- "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.
- "holdTime": "A String", # Output only. When the account was put on hold.
- "lastName": "A String", # Output only. The last 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.
- "accountId": "A String", # The account's ID as provided by the
- # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
- "firstName": "A String", # Output only. The first name of the account holder.
+ # 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.
+ "orgUnit": { # A organizational unit being held in a particular hold. # 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.
+ # This structure is immutable.
+ "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.
},
- ],
- "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.
+ "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.
+ "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.
+ },
+ "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
+ "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.
+ "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.
+ },
+ "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.
+ },
+ "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.
- "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.
- },
- "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.
- },
- "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.
- },
- },
- "orgUnit": { # A organizational unit being held in a particular hold. # 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.
- # This structure is immutable.
- "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.
- },
- "corpus": "A String", # The corpus to be searched.
- "updateTime": "A String", # The last time this hold was modified.
- "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.
+ "updateTime": "A String", # The last time this hold was modified.
+ "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
+ "name": "A String", # The name of 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.
+ "holdTime": "A String", # Output only. When the account was put on hold.
+ "lastName": "A String", # Output only. The last 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.
+ "accountId": "A String", # The account's ID as provided by the
+ # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ },
+ ],
+ }</pre>
</div>
<div class="method">
@@ -424,59 +424,59 @@
# 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.
- "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.
- "holdTime": "A String", # Output only. When the account was put on hold.
- "lastName": "A String", # Output only. The last 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.
- "accountId": "A String", # The account's ID as provided by the
- # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
- "firstName": "A String", # Output only. The first name of the account holder.
+ # 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.
+ "orgUnit": { # A organizational unit being held in a particular hold. # 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.
+ # This structure is immutable.
+ "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.
},
- ],
- "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.
+ "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.
+ "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.
+ },
+ "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
+ "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.
+ "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.
+ },
+ "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.
+ },
+ "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.
- "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.
- },
- "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.
- },
- "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.
- },
+ "corpus": "A String", # The corpus to be searched.
+ "updateTime": "A String", # The last time this hold was modified.
+ "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
+ "name": "A String", # The name of 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.
+ "holdTime": "A String", # Output only. When the account was put on hold.
+ "lastName": "A String", # Output only. The last 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.
+ "accountId": "A String", # The account's ID as provided by the
+ # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ },
+ ],
},
- "orgUnit": { # A organizational unit being held in a particular hold. # 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.
- # This structure is immutable.
- "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.
- },
- "corpus": "A String", # The corpus to be searched.
- "updateTime": "A String", # The last time this hold was modified.
- "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
- "name": "A String", # The name of the hold.
- },
],
}</pre>
</div>
@@ -559,93 +559,28 @@
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.
- "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.
- "holdTime": "A String", # Output only. When the account was put on hold.
- "lastName": "A String", # Output only. The last 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.
- "accountId": "A String", # The account's ID as provided by the
- # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
- "firstName": "A String", # Output only. The first name of the account holder.
- },
- ],
- "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.
- },
- "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.
- },
- "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.
- },
- "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.
- },
- },
- "orgUnit": { # A organizational unit being held in a particular hold. # 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.
- # This structure is immutable.
- "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.
- },
- "corpus": "A String", # The corpus to be searched.
- "updateTime": "A String", # The last time this hold was modified.
- "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
- "name": "A String", # The name of the hold.
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-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.
- "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.
- "holdTime": "A String", # Output only. When the account was put on hold.
- "lastName": "A String", # Output only. The last 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.
- "accountId": "A String", # The account's ID as provided by the
- # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
- "firstName": "A String", # Output only. The first name of the account holder.
- },
- ],
+ "orgUnit": { # A organizational unit being held in a particular hold. # 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.
+ # This structure is immutable.
+ "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.
+ },
"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.
+ "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.
+ },
"mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
+ "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.
"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.
},
"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
@@ -658,23 +593,88 @@
# Hangouts Chat.
"includeRooms": True or False, # If true, include rooms the user has participated in.
},
- "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.
- },
- },
- "orgUnit": { # A organizational unit being held in a particular hold. # 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.
- # This structure is immutable.
- "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.
},
"corpus": "A String", # The corpus to be searched.
"updateTime": "A String", # The last time this hold was modified.
"holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
"name": "A String", # The name of the hold.
- }</pre>
+ "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.
+ "holdTime": "A String", # Output only. When the account was put on hold.
+ "lastName": "A String", # Output only. The last 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.
+ "accountId": "A String", # The account's ID as provided by the
+ # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ },
+ ],
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+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.
+ "orgUnit": { # A organizational unit being held in a particular hold. # 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.
+ # This structure is immutable.
+ "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.
+ },
+ "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.
+ "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.
+ },
+ "mailQuery": { # Query options for mail holds. # Details pertaining to mail holds. If set, corpus must be mail.
+ "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.
+ "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.
+ },
+ "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.
+ },
+ "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.
+ "updateTime": "A String", # The last time this hold was modified.
+ "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
+ "name": "A String", # The name of 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.
+ "holdTime": "A String", # Output only. When the account was put on hold.
+ "lastName": "A String", # Output only. The last 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.
+ "accountId": "A String", # The account's ID as provided by the
+ # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ },
+ ],
+ }</pre>
</div>
</body></html>
\ No newline at end of file