docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/bigqueryreservation_v1beta1.projects.locations.html b/docs/dyn/bigqueryreservation_v1beta1.projects.locations.html
index 45b42e2..b8f1fef 100644
--- a/docs/dyn/bigqueryreservation_v1beta1.projects.locations.html
+++ b/docs/dyn/bigqueryreservation_v1beta1.projects.locations.html
@@ -88,7 +88,7 @@
<code><a href="#getBiReservation">getBiReservation(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a BI reservation.</p>
<p class="toc_element">
- <code><a href="#searchAssignments">searchAssignments(parent, pageToken=None, pageSize=None, query=None, x__xgafv=None)</a></code></p>
+ <code><a href="#searchAssignments">searchAssignments(parent, query=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Looks up assignments for a specified resource for a particular region.</p>
<p class="toc_element">
<code><a href="#searchAssignments_next">searchAssignments_next(previous_request, previous_response)</a></code></p>
@@ -122,34 +122,44 @@
</div>
<div class="method">
- <code class="details" id="searchAssignments">searchAssignments(parent, pageToken=None, pageSize=None, query=None, x__xgafv=None)</code>
+ <code class="details" id="searchAssignments">searchAssignments(parent, query=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Looks up assignments for a specified resource for a particular region.
If the request is about a project:
- 1) Assignments created on the project will be returned if they exist.
- 2) Otherwise assignments created on the closest ancestor will be
- returned. 3) Assignments for different JobTypes will all be returned.
-Same logic applies if the request is about a folder.
+
+1. Assignments created on the project will be returned if they exist.
+2. Otherwise assignments created on the closest ancestor will be
+ returned.
+3. Assignments for different JobTypes will all be returned.
+
+The same logic applies if the request is about a folder.
+
If the request is about an organization, then assignments created on the
organization will be returned (organization doesn't have ancestors).
+
Comparing to ListAssignments, there are some behavior
differences:
- 1) permission on the assignee will be verified in this API.
- 2) Hierarchy lookup (project->folder->organization) happens in this API.
- 3) Parent here is projects/*/locations/*, instead of
- projects/*/locations/*reservations/*.
-Note "-" cannot be used for projects
+
+1. permission on the assignee will be verified in this API.
+2. Hierarchy lookup (project->folder->organization) happens in this API.
+3. Parent here is `projects/*/locations/*`, instead of
+ `projects/*/locations/*reservations/*`.
+
+**Note** "-" cannot be used for projects
nor locations.
Args:
parent: string, Required. The resource name of the admin project(containing project and location),
e.g.:
- "projects/myproject/locations/US". (required)
+ `projects/myproject/locations/US`. (required)
+ query: string, Please specify resource name as assignee in the query.
+
+Examples:
+
+* `assignee=projects/myproject`
+* `assignee=folders/123`
+* `assignee=organizations/456`
pageToken: string, The next_page_token value returned from a previous List request, if any.
pageSize: integer, The maximum number of items to return.
- query: string, Please specify resource name as assignee in the query.
-e.g., "assignee=projects/myproject"
- "assignee=folders/123"
- "assignee=organizations/456"
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -159,19 +169,19 @@
An object of the form:
{ # The response for ReservationService.SearchAssignments.
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
+ # more results in the list.
"assignments": [ # List of assignments visible to the user.
{ # A Assignment allows a project to submit jobs
# of a certain type using slots from the specified reservation.
"jobType": "A String", # Which type of jobs will use the reservation.
"state": "A String", # Output only. State of the assignment.
"name": "A String", # Output only. Name of the resource. E.g.:
- # projects/myproject/locations/US/reservations/team1-prod/assignments/123.
+ # `projects/myproject/locations/US/reservations/team1-prod/assignments/123`.
"assignee": "A String", # The resource which will use the reservation. E.g.
- # projects/myproject, folders/123, organizations/456.
+ # `projects/myproject`, `folders/123`, or `organizations/456`.
},
],
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
- # more results in the list.
}</pre>
</div>
@@ -192,8 +202,10 @@
<div class="method">
<code class="details" id="updateBiReservation">updateBiReservation(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a BI reservation.
-Only fields specified in the field_mask are updated.
-Singleton BI reservation always exists with default size 0.
+
+Only fields specified in the `field_mask` are updated.
+
+A singleton BI reservation always exists with default size 0.
In order to reserve BI capacity it needs to be updated to an amount
greater than 0. In order to release BI capacity reservation size
must be set to 0.