chore: Update discovery artifacts (#1425)
## Deleted keys were detected in the following stable discovery artifacts:
admin directory_v1 https://github.com/googleapis/google-api-python-client/commit/1534f8926019f43dc87a29c1ca32191884556e3b
bigquery v2 https://github.com/googleapis/google-api-python-client/commit/59c51e319602741632201d2ce61a6b03f13e4003
file v1 https://github.com/googleapis/google-api-python-client/commit/0cd409a2d15c68aca3ea864400fc4772b9b4e503
memcache v1 https://github.com/googleapis/google-api-python-client/commit/665ce5b47b9b3238dcfa201b9343bf6447df5994
youtube v3 https://github.com/googleapis/google-api-python-client/commit/5046950872559fe93b954dc9a4f71fd724176247
## Deleted keys were detected in the following pre-stable discovery artifacts:
analyticsadmin v1alpha https://github.com/googleapis/google-api-python-client/commit/934358e5c041ffd1449e7c744463e61e94381ed5
documentai v1beta3 https://github.com/googleapis/google-api-python-client/commit/e8aaabbc7670aefc4a745916fccb31424745f748
file v1beta1 https://github.com/googleapis/google-api-python-client/commit/0cd409a2d15c68aca3ea864400fc4772b9b4e503
memcache v1beta2 https://github.com/googleapis/google-api-python-client/commit/665ce5b47b9b3238dcfa201b9343bf6447df5994
networkconnectivity v1alpha1 https://github.com/googleapis/google-api-python-client/commit/2cc462638aec61f4e775bfce883e725b104eeabb
## Discovery Artifact Change Summary:
feat(admin): update the api https://github.com/googleapis/google-api-python-client/commit/1534f8926019f43dc87a29c1ca32191884556e3b
feat(alertcenter): update the api https://github.com/googleapis/google-api-python-client/commit/7a488d3f0deef3e1f106cff63b1e4f66ad1727bb
feat(analyticsadmin): update the api https://github.com/googleapis/google-api-python-client/commit/934358e5c041ffd1449e7c744463e61e94381ed5
feat(analyticsdata): update the api https://github.com/googleapis/google-api-python-client/commit/40f712130674cec09c1dd7560f69a330a335b226
feat(androiddeviceprovisioning): update the api https://github.com/googleapis/google-api-python-client/commit/81a0002a7051aeab647a3296fb18ce7973bf7137
feat(apigee): update the api https://github.com/googleapis/google-api-python-client/commit/2e6c78a93b2c0ee7001eb163ec95f9afc8f35575
feat(appengine): update the api https://github.com/googleapis/google-api-python-client/commit/125f74a61a94af17c01930841a79db46d3a059c5
feat(bigquery): update the api https://github.com/googleapis/google-api-python-client/commit/59c51e319602741632201d2ce61a6b03f13e4003
feat(cloudasset): update the api https://github.com/googleapis/google-api-python-client/commit/e615264971ccee6eb9b450fe3d85614209c0fee8
feat(cloudbuild): update the api https://github.com/googleapis/google-api-python-client/commit/ceddaccf23eb8b809688907cfdef8906cd77d65d
feat(cloudidentity): update the api https://github.com/googleapis/google-api-python-client/commit/22cd08b69b034c2cdfd854e1ac784f834539db3a
feat(container): update the api https://github.com/googleapis/google-api-python-client/commit/f494c63a42dc418559292c6269289317d9cebc23
feat(documentai): update the api https://github.com/googleapis/google-api-python-client/commit/e8aaabbc7670aefc4a745916fccb31424745f748
feat(drive): update the api https://github.com/googleapis/google-api-python-client/commit/72cab88ce591d906ea1cfcbe4dee354cccb623f2
feat(file): update the api https://github.com/googleapis/google-api-python-client/commit/0cd409a2d15c68aca3ea864400fc4772b9b4e503
feat(firebaseappcheck): update the api https://github.com/googleapis/google-api-python-client/commit/9a0131b2326327109d1ba7af97b1f4808dd7a898
feat(healthcare): update the api https://github.com/googleapis/google-api-python-client/commit/45ee6b28b86a43f44c707e15a7e06fdf8fce6a0f
feat(ideahub): update the api https://github.com/googleapis/google-api-python-client/commit/73b86d9d37f33aeaed74772d0319ba1350e54ed5
feat(managedidentities): update the api https://github.com/googleapis/google-api-python-client/commit/a07ed4558c93cb8f7fae49c7b353f46ccfea6c10
feat(memcache): update the api https://github.com/googleapis/google-api-python-client/commit/665ce5b47b9b3238dcfa201b9343bf6447df5994
feat(metastore): update the api https://github.com/googleapis/google-api-python-client/commit/9fd5ffbf37fb052323f5fa68d307c68391c519ac
feat(ml): update the api https://github.com/googleapis/google-api-python-client/commit/cf54d564915a558569c093287b448a7819e215f6
feat(monitoring): update the api https://github.com/googleapis/google-api-python-client/commit/d1ffbfc041f23f904cd8bc35a450871b2909473b
feat(networkconnectivity): update the api https://github.com/googleapis/google-api-python-client/commit/2cc462638aec61f4e775bfce883e725b104eeabb
feat(notebooks): update the api https://github.com/googleapis/google-api-python-client/commit/831ba938855aa4bdefafedf63e01af43350e7ed2
feat(ondemandscanning): update the api https://github.com/googleapis/google-api-python-client/commit/c04b4023477393cbb41984b14e0c734fc8587d45
feat(paymentsresellersubscription): update the api https://github.com/googleapis/google-api-python-client/commit/2cd5b1c2ef524f3ab00630508710cce7bee53574
feat(prod_tt_sasportal): update the api https://github.com/googleapis/google-api-python-client/commit/8b6bd24e57a79f470c750ad04052f79a3cafe0fa
feat(realtimebidding): update the api https://github.com/googleapis/google-api-python-client/commit/fd514dc8d86182dc17698f3293144928535f709c
feat(reseller): update the api https://github.com/googleapis/google-api-python-client/commit/20226c4401956732772e2a563c7920666135e605
feat(sasportal): update the api https://github.com/googleapis/google-api-python-client/commit/38d5156350b79a9933b2806f4bbe443043a33185
feat(sts): update the api https://github.com/googleapis/google-api-python-client/commit/190e13ebe5a4660d8825d3a8708559077a342bdf
feat(transcoder): update the api https://github.com/googleapis/google-api-python-client/commit/fbcacce6a17c1cae45b22f4a2058e730ec84b55a
feat(youtube): update the api https://github.com/googleapis/google-api-python-client/commit/5046950872559fe93b954dc9a4f71fd724176247
diff --git a/docs/dyn/vault_v1.matters.html b/docs/dyn/vault_v1.matters.html
index 2d8c69f..f806353 100644
--- a/docs/dyn/vault_v1.matters.html
+++ b/docs/dyn/vault_v1.matters.html
@@ -94,22 +94,22 @@
<p class="firstline">Adds an account as a matter collaborator.</p>
<p class="toc_element">
<code><a href="#close">close(matterId, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Closes the specified matter. Returns matter with updated state.</p>
+<p class="firstline">Closes the specified matter. Returns the matter with updated state.</p>
<p class="toc_element">
<code><a href="#count">count(matterId, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Counts the artifacts within the context of a matter and returns a detailed breakdown of metrics.</p>
+<p class="firstline">Counts the accounts processed by the specified query.</p>
<p class="toc_element">
<code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a new matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.</p>
+<p class="firstline">Creates a matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.</p>
<p class="toc_element">
<code><a href="#delete">delete(matterId, x__xgafv=None)</a></code></p>
-<p class="firstline">Deletes the specified matter. Returns matter with updated state.</p>
+<p class="firstline">Deletes the specified matter. Returns the matter with updated state.</p>
<p class="toc_element">
<code><a href="#get">get(matterId, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the specified matter.</p>
<p class="toc_element">
<code><a href="#list">list(pageSize=None, pageToken=None, state=None, view=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists matters the user has access to.</p>
+<p class="firstline">Lists matters the requestor has access to.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -118,10 +118,10 @@
<p class="firstline">Removes an account as a matter collaborator.</p>
<p class="toc_element">
<code><a href="#reopen">reopen(matterId, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Reopens the specified matter. Returns matter with updated state.</p>
+<p class="firstline">Reopens the specified matter. Returns the matter with updated state.</p>
<p class="toc_element">
<code><a href="#undelete">undelete(matterId, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Undeletes the specified matter. Returns matter with updated state.</p>
+<p class="firstline">Undeletes the specified matter. Returns the matter with updated state.</p>
<p class="toc_element">
<code><a href="#update">update(matterId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the specified matter. This updates only the name and description of the matter, identified by matter ID. Changes to any other fields are ignored. Returns the default view of the matter.</p>
@@ -135,13 +135,13 @@
body: object, The request body.
The object takes the form of:
-{ # Add an account with the permission specified. The role cannot be owner. If an account already has a role in the matter, it will be overwritten.
- "ccMe": True or False, # Only relevant if send_emails is true. True to CC requestor in the email message. False to not CC requestor.
- "matterPermission": { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. # The MatterPermission to add.
- "accountId": "A String", # The account ID, as provided by Admin SDK.
- "role": "A String", # The user's role in this matter.
+{ # Add an account with the permission specified. The role cannot be owner. If an account already has a role in the matter, the existing role is overwritten.
+ "ccMe": True or False, # Only relevant if **sendEmails** is **true**. To CC the requestor in the email message, set to **true**. To not CC requestor, set to **false**.
+ "matterPermission": { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist. # The account and its role to add.
+ "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
+ "role": "A String", # The user's role for the matter.
},
- "sendEmails": True or False, # True to send notification email to the added account. False to not send notification email.
+ "sendEmails": True or False, # To send a notification email to the added account, set to **true**. To not send a notification email, set to **false**.
}
x__xgafv: string, V1 error format.
@@ -152,15 +152,15 @@
Returns:
An object of the form:
- { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
- "accountId": "A String", # The account ID, as provided by Admin SDK.
- "role": "A String", # The user's role in this matter.
+ { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
+ "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
+ "role": "A String", # The user's role for the matter.
}</pre>
</div>
<div class="method">
<code class="details" id="close">close(matterId, body=None, x__xgafv=None)</code>
- <pre>Closes the specified matter. Returns matter with updated state.
+ <pre>Closes the specified matter. Returns the matter with updated state.
Args:
matterId: string, The matter ID. (required)
@@ -179,13 +179,13 @@
An object of the form:
{ # Response to a CloseMatterRequest.
- "matter": { # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. # The updated matter, with state CLOSED.
- "description": "A String", # The description of the matter.
- "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
- "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
- { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
- "accountId": "A String", # The account ID, as provided by Admin SDK.
- "role": "A String", # The user's role in this matter.
+ "matter": { # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. # The updated matter, with state **CLOSED**.
+ "description": "A String", # An optional description for the matter.
+ "matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
+ "matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
+ { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
+ "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
+ "role": "A String", # The user's role for the matter.
},
],
"name": "A String", # The name of the matter.
@@ -196,7 +196,7 @@
<div class="method">
<code class="details" id="count">count(matterId, body=None, x__xgafv=None)</code>
- <pre>Counts the artifacts within the context of a matter and returns a detailed breakdown of metrics.
+ <pre>Counts the accounts processed by the specified query.
Args:
matterId: string, The matter ID. (required)
@@ -204,56 +204,56 @@
The object takes the form of:
{ # Count artifacts request.
- "query": { # A query definition relevant for search & export. # The search query.
- "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method, account_info needs to be specified.
+ "query": { # The query definition used for search and export. # The search query.
+ "accountInfo": { # The accounts to search # Required when **SearchMethod** is **ACCOUNT**.
"emails": [ # A set of accounts to search.
"A String",
],
},
- "corpus": "A String", # The corpus to search.
- "dataScope": "A String", # The data source to search from.
- "driveOptions": { # Drive search advanced options # For Drive search, specify more options in this field.
- "includeSharedDrives": True or False, # Set to true to include shared drive.
+ "corpus": "A String", # The Google Workspace service to search.
+ "dataScope": "A String", # The data source to search.
+ "driveOptions": { # Additional options for Drive search # Set Drive search-specific options.
+ "includeSharedDrives": True or False, # Set to **true** to include shared drives.
"includeTeamDrives": True or False, # Set to true to include Team Drive.
- "versionDate": "A String", # Search the versions of the Drive file as of the reference date. These timestamps are in GMT and rounded down to the given date.
+ "versionDate": "A String", # Search the current version of the Drive file, but export the contents of the last version saved before 12:00 AM UTC on the specified date. Enter the date in UTC.
},
- "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.
- "hangoutsChatInfo": { # Accounts to search # When 'ROOM' is chosen as search method, hangout_chats_info needs to be specified. (read-only)
- "roomId": [ # A set of rooms to search.
+ "endTime": "A String", # The end time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "hangoutsChatInfo": { # The Chat spaces to search # Required when **SearchMethod** is **ROOM**. (read-only)
+ "roomId": [ # A list of Chat spaces IDs, as provided by the [Chat API](https://developers.google.com/hangouts/chat).
"A String",
],
},
- "hangoutsChatOptions": { # Hangouts chat search advanced options # For hangouts chat search, specify more options in this field. (read-only)
- "includeRooms": True or False, # Set to true to include rooms.
+ "hangoutsChatOptions": { # Additional options for Google Chat search # Set Chat search-specific options. (read-only)
+ "includeRooms": True or False, # For searches by account or organizational unit, set to **true** to include rooms.
},
- "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.
- "excludeDrafts": True or False, # Set to true to exclude drafts.
+ "mailOptions": { # Additional options for Gmail search # Set Gmail search-specific options.
+ "excludeDrafts": True or False, # Set to **true** to exclude drafts.
},
- "method": "A String", # The search method to use. This field is similar to the search_method field but is introduced to support shared drives. It supports all search method types. In case the search_method is TEAM_DRIVE the response of this field will be SHARED_DRIVE only.
- "orgUnitInfo": { # Org Unit to search # When 'ORG_UNIT' is chosen as as search method, org_unit_info needs to be specified.
- "orgUnitId": "A String", # Org unit to search, as provided by the Admin SDK Directory API.
+ "method": "A String", # The entity to search. This field replaces **searchMethod** to support shared drives. When **searchMethod** is **TEAM_DRIVE**, the response of this field is **SHARED_DRIVE**.
+ "orgUnitInfo": { # The organizational unit to search # Required when **SearchMethod** is **ORG_UNIT**.
+ "orgUnitId": "A String", # The name of the organizational unit to search, as provided by the [Admin SDK Directory API](https://developers.google.com/admin-sdk/directory/).
},
"searchMethod": "A String", # The search method to use.
- "sharedDriveInfo": { # Shared drives to search # When 'SHARED_DRIVE' is chosen as search method, shared_drive_info needs to be specified.
- "sharedDriveIds": [ # List of Shared drive IDs, as provided by Drive API.
+ "sharedDriveInfo": { # The shared drives to search # Required when **SearchMethod** is **SHARED_DRIVE**.
+ "sharedDriveIds": [ # A list of shared drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
"A String",
],
},
- "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.
- "teamDriveInfo": { # Team Drives to search # When 'TEAM_DRIVE' is chosen as search method, team_drive_info needs to be specified.
- "teamDriveIds": [ # List of Team Drive IDs, as provided by Drive API.
+ "startTime": "A String", # The start time for the search query. Specify in GMT. The value is rounded to 12 AM on the specified date.
+ "teamDriveInfo": { # Team Drives to search # Required when **SearchMethod** is **TEAM_DRIVE**.
+ "teamDriveIds": [ # List of Team Drive IDs, as provided by the [Drive API](https://developers.google.com/drive).
"A String",
],
},
- "terms": "A String", # The corpus-specific search operators used to generate search results.
- "timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see Time Zone.
- "voiceOptions": { # Voice search options # For voice search, specify more options in this field.
+ "terms": "A String", # Service-specific [search operators](https://support.google.com/vault/answer/2474474) to filter search results.
+ "timeZone": "A String", # The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For a list of time zone names, see [Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For more information about how Vault uses time zones, see [the Vault help center](https://support.google.com/vault/answer/6092995#time).
+ "voiceOptions": { # Additional options for Voice search # Set Voice search-specific options.
"coveredData": [ # Datatypes to search
"A String",
],
},
},
- "view": "A String", # Specifies the granularity of the count result returned in response.
+ "view": "A String", # Sets the granularity of the count results.
}
x__xgafv: string, V1 error format.
@@ -287,19 +287,19 @@
<div class="method">
<code class="details" id="create">create(body=None, x__xgafv=None)</code>
- <pre>Creates a new matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.
+ <pre>Creates a matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.
Args:
body: object, The request body.
The object takes the form of:
{ # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
- "description": "A String", # The description of the matter.
- "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
- "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
- { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
- "accountId": "A String", # The account ID, as provided by Admin SDK.
- "role": "A String", # The user's role in this matter.
+ "description": "A String", # An optional description for the matter.
+ "matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
+ "matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
+ { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
+ "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
+ "role": "A String", # The user's role for the matter.
},
],
"name": "A String", # The name of the matter.
@@ -315,12 +315,12 @@
An object of the form:
{ # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
- "description": "A String", # The description of the matter.
- "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
- "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
- { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
- "accountId": "A String", # The account ID, as provided by Admin SDK.
- "role": "A String", # The user's role in this matter.
+ "description": "A String", # An optional description for the matter.
+ "matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
+ "matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
+ { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
+ "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
+ "role": "A String", # The user's role for the matter.
},
],
"name": "A String", # The name of the matter.
@@ -330,7 +330,7 @@
<div class="method">
<code class="details" id="delete">delete(matterId, x__xgafv=None)</code>
- <pre>Deletes the specified matter. Returns matter with updated state.
+ <pre>Deletes the specified matter. Returns the matter with updated state.
Args:
matterId: string, The matter ID (required)
@@ -343,12 +343,12 @@
An object of the form:
{ # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
- "description": "A String", # The description of the matter.
- "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
- "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
- { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
- "accountId": "A String", # The account ID, as provided by Admin SDK.
- "role": "A String", # The user's role in this matter.
+ "description": "A String", # An optional description for the matter.
+ "matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
+ "matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
+ { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
+ "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
+ "role": "A String", # The user's role for the matter.
},
],
"name": "A String", # The name of the matter.
@@ -362,11 +362,11 @@
Args:
matterId: string, The matter ID. (required)
- view: string, Specifies which parts of the Matter to return in the response.
+ view: string, Specifies how much information about the matter to return in the response.
Allowed values
- VIEW_UNSPECIFIED - There is no specified view.
- BASIC - Response includes the matter_id, name, description, and state. Default choice.
- FULL - Full representation of matter is returned. Everything above and including MatterPermissions list.
+ VIEW_UNSPECIFIED - The amount of detail is unspecified. Same as **BASIC**.
+ BASIC - Returns the matter ID, name, description, and state. Default choice.
+ FULL - Returns the basic details and a list of matter owners and collaborators (see [MatterPermissions](https://developers.google.com/vault/reference/rest/v1/matters#matterpermission)).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -376,12 +376,12 @@
An object of the form:
{ # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
- "description": "A String", # The description of the matter.
- "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
- "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
- { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
- "accountId": "A String", # The account ID, as provided by Admin SDK.
- "role": "A String", # The user's role in this matter.
+ "description": "A String", # An optional description for the matter.
+ "matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
+ "matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
+ { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
+ "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
+ "role": "A String", # The user's role for the matter.
},
],
"name": "A String", # The name of the matter.
@@ -391,22 +391,22 @@
<div class="method">
<code class="details" id="list">list(pageSize=None, pageToken=None, state=None, view=None, x__xgafv=None)</code>
- <pre>Lists matters the user has access to.
+ <pre>Lists matters the requestor has access to.
Args:
pageSize: integer, The number of matters to return in the response. Default and maximum are 100.
pageToken: string, The pagination token as returned in the response.
- state: string, If set, list only matters with that specific state. The default is listing matters of all states.
+ state: string, If set, lists only matters with the specified state. The default lists matters of all states.
Allowed values
STATE_UNSPECIFIED - The matter has no specified state.
- OPEN - This matter is open.
- CLOSED - This matter is closed.
- DELETED - This matter is deleted.
- view: string, Specifies which parts of the matter to return in response.
+ OPEN - The matter is open.
+ CLOSED - The matter is closed.
+ DELETED - The matter is deleted.
+ view: string, Specifies how much information about the matter to return in response.
Allowed values
- VIEW_UNSPECIFIED - There is no specified view.
- BASIC - Response includes the matter_id, name, description, and state. Default choice.
- FULL - Full representation of matter is returned. Everything above and including MatterPermissions list.
+ VIEW_UNSPECIFIED - The amount of detail is unspecified. Same as **BASIC**.
+ BASIC - Returns the matter ID, name, description, and state. Default choice.
+ FULL - Returns the basic details and a list of matter owners and collaborators (see [MatterPermissions](https://developers.google.com/vault/reference/rest/v1/matters#matterpermission)).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -418,12 +418,12 @@
{ # Provides the list of matters.
"matters": [ # List of matters.
{ # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
- "description": "A String", # The description of the matter.
- "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
- "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
- { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
- "accountId": "A String", # The account ID, as provided by Admin SDK.
- "role": "A String", # The user's role in this matter.
+ "description": "A String", # An optional description for the matter.
+ "matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
+ "matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
+ { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
+ "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
+ "role": "A String", # The user's role for the matter.
},
],
"name": "A String", # The name of the matter.
@@ -475,7 +475,7 @@
<div class="method">
<code class="details" id="reopen">reopen(matterId, body=None, x__xgafv=None)</code>
- <pre>Reopens the specified matter. Returns matter with updated state.
+ <pre>Reopens the specified matter. Returns the matter with updated state.
Args:
matterId: string, The matter ID. (required)
@@ -494,13 +494,13 @@
An object of the form:
{ # Response to a ReopenMatterRequest.
- "matter": { # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. # The updated matter, with state OPEN.
- "description": "A String", # The description of the matter.
- "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
- "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
- { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
- "accountId": "A String", # The account ID, as provided by Admin SDK.
- "role": "A String", # The user's role in this matter.
+ "matter": { # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. # The updated matter, with state **OPEN**.
+ "description": "A String", # An optional description for the matter.
+ "matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
+ "matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
+ { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
+ "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
+ "role": "A String", # The user's role for the matter.
},
],
"name": "A String", # The name of the matter.
@@ -511,7 +511,7 @@
<div class="method">
<code class="details" id="undelete">undelete(matterId, body=None, x__xgafv=None)</code>
- <pre>Undeletes the specified matter. Returns matter with updated state.
+ <pre>Undeletes the specified matter. Returns the matter with updated state.
Args:
matterId: string, The matter ID. (required)
@@ -530,12 +530,12 @@
An object of the form:
{ # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
- "description": "A String", # The description of the matter.
- "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
- "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
- { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
- "accountId": "A String", # The account ID, as provided by Admin SDK.
- "role": "A String", # The user's role in this matter.
+ "description": "A String", # An optional description for the matter.
+ "matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
+ "matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
+ { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
+ "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
+ "role": "A String", # The user's role for the matter.
},
],
"name": "A String", # The name of the matter.
@@ -553,12 +553,12 @@
The object takes the form of:
{ # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
- "description": "A String", # The description of the matter.
- "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
- "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
- { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
- "accountId": "A String", # The account ID, as provided by Admin SDK.
- "role": "A String", # The user's role in this matter.
+ "description": "A String", # An optional description for the matter.
+ "matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
+ "matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
+ { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
+ "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
+ "role": "A String", # The user's role for the matter.
},
],
"name": "A String", # The name of the matter.
@@ -574,12 +574,12 @@
An object of the form:
{ # Represents a matter. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
- "description": "A String", # The description of the matter.
- "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
- "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
- { # Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
- "accountId": "A String", # The account ID, as provided by Admin SDK.
- "role": "A String", # The user's role in this matter.
+ "description": "A String", # An optional description for the matter.
+ "matterId": "A String", # The matter ID, which is generated by the server. Leave blank when creating a matter.
+ "matterPermissions": [ # Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.
+ { # Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.
+ "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
+ "role": "A String", # The user's role for the matter.
},
],
"name": "A String", # The name of the matter.