build: run docs regen in synth.py (#1059)
diff --git a/docs/dyn/vault_v1.matters.html b/docs/dyn/vault_v1.matters.html
index e409cd1..0f8731a 100644
--- a/docs/dyn/vault_v1.matters.html
+++ b/docs/dyn/vault_v1.matters.html
@@ -96,6 +96,9 @@
<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="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="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="toc_element">
@@ -105,7 +108,7 @@
<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(view=None, pageToken=None, pageSize=None, state=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(pageSize=None, view=None, state=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists matters the user has access to.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -133,11 +136,11 @@
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.
+ "sendEmails": True or False, # True to send notification email to the added account. False to not send notification email.
"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.
},
- "sendEmails": True or False, # True to send notification email to the added account. False to not send notification email.
"ccMe": True or False, # Only relevant if send_emails is true. True to CC requestor in the email message. False to not CC requestor.
}
@@ -177,6 +180,7 @@
{ # Response to a CloseMatterRequest.
"matter": { # Represents a matter. # The updated matter, with state CLOSED.
+ "name": "A String", # The name of the matter.
"description": "A String", # The description of the 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.
@@ -184,14 +188,99 @@
"role": "A String", # The user's role in this matter.
},
],
- "name": "A String", # The name of the matter.
- "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
"state": "A String", # The state of the matter.
+ "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
},
}</pre>
</div>
<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.
+
+Args:
+ matterId: string, The matter ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Count artifacts request.
+ "view": "A String", # Specifies the granularity of the count result returned in response.
+ "query": { # A query definition relevant for search & export. # The search query.
+ "dataScope": "A String", # The data source to search from.
+ "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.
+ "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.
+ "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.
+ "includeTeamDrives": True or False, # Set to true to include Team Drive.
+ },
+ "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.
+ "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.
+ },
+ "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.
+ "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.
+ "searchMethod": "A String", # The search method to use.
+ "terms": "A String", # The corpus-specific search operators used to generate search results.
+ "accountInfo": { # Accounts to search # When 'ACCOUNT' is chosen as search method, account_info needs to be specified.
+ "emails": [ # A set of accounts to search.
+ "A String",
+ ],
+ },
+ "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.
+ },
+ "corpus": "A String", # The corpus to search.
+ "mailOptions": { # Mail search advanced options # For mail search, specify more options in this field.
+ "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.
+ "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.
+ "A String",
+ ],
+ },
+ "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.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "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.
+ "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.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ }</pre>
+</div>
+
+<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.
@@ -200,6 +289,7 @@
The object takes the form of:
{ # Represents a matter.
+ "name": "A String", # The name of the matter.
"description": "A String", # The description of the 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.
@@ -207,9 +297,8 @@
"role": "A String", # The user's role in this matter.
},
],
- "name": "A String", # The name of the matter.
- "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
"state": "A String", # The state of the matter.
+ "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
}
x__xgafv: string, V1 error format.
@@ -221,6 +310,7 @@
An object of the form:
{ # Represents a matter.
+ "name": "A String", # The name of the matter.
"description": "A String", # The description of the 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.
@@ -228,9 +318,8 @@
"role": "A String", # The user's role in this matter.
},
],
- "name": "A String", # The name of the matter.
- "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
"state": "A String", # The state of the matter.
+ "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
}</pre>
</div>
@@ -249,6 +338,7 @@
An object of the form:
{ # Represents a matter.
+ "name": "A String", # The name of the matter.
"description": "A String", # The description of the 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.
@@ -256,9 +346,8 @@
"role": "A String", # The user's role in this matter.
},
],
- "name": "A String", # The name of the matter.
- "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
"state": "A String", # The state of the matter.
+ "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
}</pre>
</div>
@@ -282,6 +371,7 @@
An object of the form:
{ # Represents a matter.
+ "name": "A String", # The name of the matter.
"description": "A String", # The description of the 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.
@@ -289,30 +379,29 @@
"role": "A String", # The user's role in this matter.
},
],
- "name": "A String", # The name of the matter.
- "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
"state": "A String", # The state of the matter.
+ "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(view=None, pageToken=None, pageSize=None, state=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(pageSize=None, view=None, state=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists matters the user has access to.
Args:
+ pageSize: integer, The number of matters to return in the response. Default and maximum are 100.
view: string, Specifies which parts of 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.
- pageToken: string, The pagination token as returned in the response.
- pageSize: integer, The number of matters to return in the response. Default and maximum are 100.
state: string, If set, list only matters with that specific state. The default is listing 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.
+ pageToken: string, The pagination token as returned in the response.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -325,6 +414,7 @@
"nextPageToken": "A String", # Page token to retrieve the next page of results in the list.
"matters": [ # List of matters.
{ # Represents a matter.
+ "name": "A String", # The name of the matter.
"description": "A String", # The description of the 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.
@@ -332,9 +422,8 @@
"role": "A String", # The user's role in this matter.
},
],
- "name": "A String", # The name of the matter.
- "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
"state": "A String", # The state of the matter.
+ "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
},
],
}</pre>
@@ -401,6 +490,7 @@
{ # Response to a ReopenMatterRequest.
"matter": { # Represents a matter. # The updated matter, with state OPEN.
+ "name": "A String", # The name of the matter.
"description": "A String", # The description of the 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.
@@ -408,9 +498,8 @@
"role": "A String", # The user's role in this matter.
},
],
- "name": "A String", # The name of the matter.
- "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
"state": "A String", # The state of the matter.
+ "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
},
}</pre>
</div>
@@ -436,6 +525,7 @@
An object of the form:
{ # Represents a matter.
+ "name": "A String", # The name of the matter.
"description": "A String", # The description of the 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.
@@ -443,9 +533,8 @@
"role": "A String", # The user's role in this matter.
},
],
- "name": "A String", # The name of the matter.
- "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
"state": "A String", # The state of the matter.
+ "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
}</pre>
</div>
@@ -459,6 +548,7 @@
The object takes the form of:
{ # Represents a matter.
+ "name": "A String", # The name of the matter.
"description": "A String", # The description of the 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.
@@ -466,9 +556,8 @@
"role": "A String", # The user's role in this matter.
},
],
- "name": "A String", # The name of the matter.
- "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
"state": "A String", # The state of the matter.
+ "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
}
x__xgafv: string, V1 error format.
@@ -480,6 +569,7 @@
An object of the form:
{ # Represents a matter.
+ "name": "A String", # The name of the matter.
"description": "A String", # The description of the 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.
@@ -487,9 +577,8 @@
"role": "A String", # The user's role in this matter.
},
],
- "name": "A String", # The name of the matter.
- "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
"state": "A String", # The state of the matter.
+ "matterId": "A String", # The matter ID which is generated by the server. Should be blank when creating a new matter.
}</pre>
</div>