docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/vault_v1.matters.holds.html b/docs/dyn/vault_v1.matters.holds.html
index fd92312..23eec18 100644
--- a/docs/dyn/vault_v1.matters.holds.html
+++ b/docs/dyn/vault_v1.matters.holds.html
@@ -89,10 +89,10 @@
<code><a href="#delete">delete(matterId, holdId, x__xgafv=None)</a></code></p>
<p class="firstline">Removes a hold by ID. This will release any HeldAccounts on this Hold.</p>
<p class="toc_element">
- <code><a href="#get">get(matterId, holdId, x__xgafv=None, view=None)</a></code></p>
+ <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, pageSize=None, pageToken=None, x__xgafv=None, view=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</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -117,13 +117,13 @@
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.
- "A String",
- ],
- "emails": [ # Emails to identify which accounts to add. Only emails or only account_ids
+ "emails": [ # Emails to identify which accounts to add. Only emails or only account_ids
# should be specified, but not both.
- "A String",
+ "A String",
+ ],
+ "accountIds": [ # Account IDs to identify which accounts to add. Only account_ids or only
+ # emails should be specified, but not both.
+ "A String",
],
}
@@ -136,36 +136,36 @@
An object of the form:
{ # Response for batch create held accounts.
- "responses": [ # The list of responses, in the same order as the batch request.
+ "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.
- "status": { # The `Status` type defines a logical error model that is suitable for # This represents the success status. If failed, check message.
+ "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
# 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.
- "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
+ "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.
+ "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.
+ "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.
- "lastName": "A String", # Output only. The last name of the account holder.
- "holdTime": "A String", # Output only. When the account was put on hold.
- "email": "A String", # The primary email address of the account. If used as an input, this takes
+ "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.
- "firstName": "A String", # Output only. The first 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>.
+ "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.
},
},
],
@@ -185,55 +185,55 @@
# 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.
- "updateTime": "A String", # The last time this hold was modified.
- "name": "A String", # The name of 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.
- },
- "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be
+ "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.
- "lastName": "A String", # Output only. The last name of the account holder.
- "holdTime": "A String", # Output only. When the account was put on hold.
- "email": "A String", # The primary email address of the account. If used as an input, this takes
+ "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.
- "firstName": "A String", # Output only. The first 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>.
+ "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
+ "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus
# type.
- "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be
+ "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.
+ "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.
- "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.
- },
- "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.
- },
- "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.
- "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.
+ "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.
- "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.
+ "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.
@@ -248,55 +248,55 @@
# 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.
- "updateTime": "A String", # The last time this hold was modified.
- "name": "A String", # The name of 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.
- },
- "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be
+ "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.
- "lastName": "A String", # Output only. The last name of the account holder.
- "holdTime": "A String", # Output only. When the account was put on hold.
- "email": "A String", # The primary email address of the account. If used as an input, this takes
+ "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.
- "firstName": "A String", # Output only. The first 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>.
+ "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
+ "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus
# type.
- "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be
+ "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.
+ "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.
- "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.
- },
- "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.
- },
- "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.
- "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.
+ "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.
- "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.
+ "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>
@@ -328,17 +328,17 @@
</div>
<div class="method">
- <code class="details" id="get">get(matterId, holdId, x__xgafv=None, view=None)</code>
+ <code class="details" id="get">get(matterId, holdId, view=None, x__xgafv=None)</code>
<pre>Gets a hold by ID.
Args:
matterId: string, The matter ID. (required)
holdId: string, The hold ID. (required)
+ view: string, Specifies which parts of the Hold to return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- view: string, Specifies which parts of the Hold to return.
Returns:
An object of the form:
@@ -347,135 +347,135 @@
# 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.
- "updateTime": "A String", # The last time this hold was modified.
- "name": "A String", # The name of 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.
- },
- "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be
+ "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.
- "lastName": "A String", # Output only. The last name of the account holder.
- "holdTime": "A String", # Output only. When the account was put on hold.
- "email": "A String", # The primary email address of the account. If used as an input, this takes
+ "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.
- "firstName": "A String", # Output only. The first 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>.
+ "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
+ "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus
# type.
- "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be
+ "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.
+ "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.
- "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.
- },
- "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.
- },
- "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.
- "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.
+ "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.
- "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.
+ "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>
<div class="method">
- <code class="details" id="list">list(matterId, pageSize=None, pageToken=None, x__xgafv=None, view=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)
- pageSize: integer, The number of holds to return in the response, between 0 and 100 inclusive.
-Leaving this empty, or as 0, is the same as page_size = 100.
pageToken: string, The pagination token as returned in the response.
An empty token means start from the beginning.
+ 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- view: string, Specifies which parts of the Hold to return.
Returns:
An object of the form:
{ # The holds for a matter.
- "nextPageToken": "A String", # Page token to retrieve the next page of results in the list.
+ "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.
+ "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.
- "updateTime": "A String", # The last time this hold was modified.
- "name": "A String", # The name of 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.
- },
- "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be
+ "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.
- "lastName": "A String", # Output only. The last name of the account holder.
- "holdTime": "A String", # Output only. When the account was put on hold.
- "email": "A String", # The primary email address of the account. If used as an input, this takes
+ "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.
- "firstName": "A String", # Output only. The first 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>.
+ "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
+ "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus
# type.
- "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be
+ "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.
+ "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.
- "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.
- },
- "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.
- },
- "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.
- "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.
+ "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.
- "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.
+ "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>
@@ -490,7 +490,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -508,8 +508,8 @@
The object takes the form of:
{ # Remove a list of accounts from a hold.
- "accountIds": [ # Account IDs to identify HeldAccounts to remove.
- "A String",
+ "accountIds": [ # Account IDs to identify HeldAccounts to remove.
+ "A String",
],
}
@@ -522,7 +522,7 @@
An object of the form:
{ # Response for batch delete held accounts.
- "statuses": [ # A list of statuses for deleted accounts. Results have the
+ "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
@@ -531,16 +531,16 @@
#
# 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.
- "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
+ "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.
+ "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.
},
],
}</pre>
@@ -562,55 +562,55 @@
# 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.
- "updateTime": "A String", # The last time this hold was modified.
- "name": "A String", # The name of 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.
- },
- "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be
+ "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.
- "lastName": "A String", # Output only. The last name of the account holder.
- "holdTime": "A String", # Output only. When the account was put on hold.
- "email": "A String", # The primary email address of the account. If used as an input, this takes
+ "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.
- "firstName": "A String", # Output only. The first 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>.
+ "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
+ "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus
# type.
- "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be
+ "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.
+ "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.
- "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.
- },
- "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.
- },
- "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.
- "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.
+ "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.
- "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.
+ "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.
@@ -625,55 +625,55 @@
# 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.
- "updateTime": "A String", # The last time this hold was modified.
- "name": "A String", # The name of 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.
- },
- "accounts": [ # If set, the hold applies to the enumerated accounts and org_unit must be
+ "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.
- "lastName": "A String", # Output only. The last name of the account holder.
- "holdTime": "A String", # Output only. When the account was put on hold.
- "email": "A String", # The primary email address of the account. If used as an input, this takes
+ "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.
- "firstName": "A String", # Output only. The first 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>.
+ "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
+ "query": { # Corpus specific queries. # The corpus-specific query. If set, the corpusQuery must match corpus
# type.
- "hangoutsChatQuery": { # Query options for hangouts chat holds. # Details pertaining to Hangouts Chat holds. If set, corpus must be
+ "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.
+ "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.
- "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.
- },
- "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.
- },
- "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.
- "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.
+ "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.
- "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.
+ "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>