docs: update generated docs (#981)
diff --git a/docs/dyn/vault_v1.matters.holds.html b/docs/dyn/vault_v1.matters.holds.html
index 27f559f..dc2d04c 100644
--- a/docs/dyn/vault_v1.matters.holds.html
+++ b/docs/dyn/vault_v1.matters.holds.html
@@ -92,7 +92,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, pageToken=None, pageSize=None, view=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(matterId, view=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists holds within a matter. An empty page token in ListHoldsResponse</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -139,16 +139,6 @@
"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
@@ -156,17 +146,27 @@
#
# 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.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"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.
},
+ "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.
+ "lastName": "A String", # Output only. The last name of the account holder.
+ "accountId": "A String", # The account's ID as provided by the
+ # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ "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.
+ },
},
],
}</pre>
@@ -185,26 +185,29 @@
# 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.
+ "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
"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.
+ "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
},
+ "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.
+ "lastName": "A String", # Output only. The last name of the account holder.
+ "accountId": "A String", # The account's ID as provided by the
+ # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ "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.
+ },
+ ],
"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.
@@ -212,28 +215,25 @@
# rounded down to the start of the given date.
"terms": "A String", # The search terms for 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.
+ "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.
+ },
+ "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.
+ },
"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.
},
},
+ "name": "A String", # The name of 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>.
- },
- ],
}
x__xgafv: string, V1 error format.
@@ -248,26 +248,29 @@
# 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.
+ "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
"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.
+ "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
},
+ "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.
+ "lastName": "A String", # Output only. The last name of the account holder.
+ "accountId": "A String", # The account's ID as provided by the
+ # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ "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.
+ },
+ ],
"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.
@@ -275,28 +278,25 @@
# rounded down to the start of the given date.
"terms": "A String", # The search terms for 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.
+ "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.
+ },
+ "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.
+ },
"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.
},
},
+ "name": "A String", # The name of 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>.
- },
- ],
}</pre>
</div>
@@ -347,26 +347,29 @@
# 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.
+ "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
"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.
+ "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
},
+ "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.
+ "lastName": "A String", # Output only. The last name of the account holder.
+ "accountId": "A String", # The account's ID as provided by the
+ # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ "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.
+ },
+ ],
"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.
@@ -374,43 +377,40 @@
# rounded down to the start of the given date.
"terms": "A String", # The search terms for 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.
+ "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.
+ },
+ "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.
+ },
"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.
},
},
+ "name": "A String", # The name of 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>.
- },
- ],
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(matterId, pageToken=None, pageSize=None, view=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(matterId, view=None, pageSize=None, pageToken=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.
+ view: string, Specifies which parts of the Hold to return.
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.
+ pageToken: string, The pagination token as returned in the response.
+An empty token means start from the beginning.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -427,26 +427,29 @@
# 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.
+ "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
"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.
+ "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
},
+ "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.
+ "lastName": "A String", # Output only. The last name of the account holder.
+ "accountId": "A String", # The account's ID as provided by the
+ # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ "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.
+ },
+ ],
"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.
@@ -454,28 +457,25 @@
# rounded down to the start of the given date.
"terms": "A String", # The search terms for 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.
+ "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.
+ },
+ "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.
+ },
"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.
},
},
+ "name": "A String", # The name of 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>.
- },
- ],
},
],
}</pre>
@@ -531,13 +531,13 @@
#
# 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.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
"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.
@@ -562,26 +562,29 @@
# 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.
+ "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
"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.
+ "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
},
+ "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.
+ "lastName": "A String", # Output only. The last name of the account holder.
+ "accountId": "A String", # The account's ID as provided by the
+ # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ "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.
+ },
+ ],
"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.
@@ -589,28 +592,25 @@
# rounded down to the start of the given date.
"terms": "A String", # The search terms for 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.
+ "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.
+ },
+ "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.
+ },
"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.
},
},
+ "name": "A String", # The name of 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>.
- },
- ],
}
x__xgafv: string, V1 error format.
@@ -625,26 +625,29 @@
# 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.
+ "holdId": "A String", # The unique immutable ID of the hold. Assigned during creation.
"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.
+ "orgUnitId": "A String", # The org unit's immutable ID as provided by the Admin SDK.
},
+ "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.
+ "lastName": "A String", # Output only. The last name of the account holder.
+ "accountId": "A String", # The account's ID as provided by the
+ # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
+ "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.
+ },
+ ],
"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.
@@ -652,28 +655,25 @@
# rounded down to the start of the given date.
"terms": "A String", # The search terms for 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.
+ "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.
+ },
+ "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.
+ },
"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.
},
},
+ "name": "A String", # The name of 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>.
- },
- ],
}</pre>
</div>