docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/bigqueryreservation_v1beta1.projects.locations.reservations.assignments.html b/docs/dyn/bigqueryreservation_v1beta1.projects.locations.reservations.assignments.html
index 18c2ef5..2417903 100644
--- a/docs/dyn/bigqueryreservation_v1beta1.projects.locations.reservations.assignments.html
+++ b/docs/dyn/bigqueryreservation_v1beta1.projects.locations.reservations.assignments.html
@@ -76,7 +76,7 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have</p>
+<p class="firstline">Creates an assignment object which allows the given project to submit jobs</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a assignment. No expansion will happen.</p>
@@ -88,19 +88,44 @@
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#move">move(name, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Moves a assignment under a new reservation. Customers can do this by</p>
+<p class="firstline">Moves an assignment under a new reservation.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
- <pre>Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have
+ <pre>Creates an assignment object which allows the given project to submit jobs
+of a certain type using slots from the specified reservation.
+
+Currently a
+resource (project, folder, organization) can only have one assignment per
+each (job_type, location) combination, and that reservation will be used
+for all jobs of the matching type.
+
+Different assignments can be created on different levels of the
+projects, folders or organization hierarchy. During query execution,
+the assignment is looked up at the project, folder and organization levels
+in that order. The first assignment found is applied to the query.
+
+When creating assignments, it does not matter if other assignments exist at
+higher levels.
+
+Example:
+
+* The organization `organizationA` contains two projects, `project1`
+ and `project2`.
+* Assignments for all three entities (`organizationA`, `project1`, and
+ `project2`) could all be created and mapped to the same or different
+ reservations.
+
+Returns `google.rpc.Code.PERMISSION_DENIED` if user does not have
'bigquery.admin' permissions on the project using the reservation
and the project that owns this reservation.
+
Returns `google.rpc.Code.INVALID_ARGUMENT` when location of the assignment
does not match location of the reservation.
Args:
parent: string, Required. The parent resource name of the assignment
-E.g.: projects/myproject/locations/US/reservations/team1-prod (required)
+E.g. `projects/myproject/locations/US/reservations/team1-prod` (required)
body: object, The request body.
The object takes the form of:
@@ -109,9 +134,9 @@
"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`.
}
x__xgafv: string, V1 error format.
@@ -127,28 +152,33 @@
"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`.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a assignment. No expansion will happen.
-E.g:
-organizationA contains project1 and project2. Reservation res1 exists.
-CreateAssignment was invoked previously and following assignments were
-created explicitly:
- <organizationA, res1>
- <project1, res1>
-Then deletion of <organizationA, res1> won't affect <project1, res1>. After
-deletion of <organizationA, res1>, queries from project1 will still use
-res1, while queries from project2 will use on-demand mode.
+
+Example:
+
+* Organization `organizationA` contains two projects, `project1` and
+ `project2`.
+* Reservation `res1` exists and was created previously.
+* CreateAssignment was used previously to define the following
+ associations between entities and reservations: `<organizationA, res1>`
+ and `<project1, res1>`
+
+In this example, deletion of the `<organizationA, res1>` assignment won't
+affect the other assignment `<project1, res1>`. After said deletion,
+queries from `project1` will still use `res1` while queries from
+`project2` will switch to use on-demand mode.
Args:
- name: string, Required. Name of the resource, e.g.:
- projects/myproject/locations/US/reservations/team1-prod/assignments/123 (required)
+ name: string, Required. Name of the resource, e.g.
+ `projects/myproject/locations/US/reservations/team1-prod/assignments/123` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -172,23 +202,35 @@
<div class="method">
<code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists assignments.
-Only explicitly created assignments will be returned. E.g:
-organizationA contains project1 and project2. Reservation res1 exists.
-CreateAssignment was invoked previously and following assignments were
-created explicitly:
- <organizationA, res1>
- <project1, res1>
-Then this API will just return the above two assignments for reservation
-res1, and no expansion/merge will happen. Wildcard "-" can be used for
+
+Only explicitly created assignments will be returned.
+
+Example:
+
+* Organization `organizationA` contains two projects, `project1` and
+ `project2`.
+* Reservation `res1` exists and was created previously.
+* CreateAssignment was used previously to define the following
+ associations between entities and reservations: `<organizationA, res1>`
+ and `<project1, res1>`
+
+In this example, ListAssignments will just return the above two assignments
+for reservation `res1`, and no expansion/merge will happen.
+
+The wildcard "-" can be used for
reservations in the request. In that case all assignments belongs to the
-specified project and location will be listed. Note
-"-" cannot be used for projects nor locations.
+specified project and location will be listed.
+
+**Note** "-" cannot be used for projects nor locations.
Args:
parent: string, Required. The parent resource name e.g.:
-projects/myproject/locations/US/reservations/team1-prod
+
+`projects/myproject/locations/US/reservations/team1-prod`
+
Or:
-projects/myproject/locations/US/reservations/- (required)
+
+`projects/myproject/locations/US/reservations/-` (required)
pageToken: string, The next_page_token value returned from a previous List request, if any.
pageSize: integer, The maximum number of items to return.
x__xgafv: string, V1 error format.
@@ -200,19 +242,19 @@
An object of the form:
{ # The response for ReservationService.ListAssignments.
- "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>
@@ -232,28 +274,30 @@
<div class="method">
<code class="details" id="move">move(name, body=None, x__xgafv=None)</code>
- <pre>Moves a assignment under a new reservation. Customers can do this by
-deleting the existing assignment followed by creating another assignment
-under the new reservation, but this method provides a transactional way to
-do so, to make sure the assignee always has an associated reservation.
-Without the method customers might see some queries run on-demand which
-might be unexpected.
+ <pre>Moves an assignment under a new reservation.
+
+This differs from removing an existing assignment and recreating a new one
+by providing a transactional change that ensures an assignee always has an
+associated reservation.
Args:
name: string, Required. The resource name of the assignment,
-e.g.:
- projects/myproject/locations/US/reservations/team1-prod/assignments/123 (required)
+e.g.
+`projects/myproject/locations/US/reservations/team1-prod/assignments/123` (required)
body: object, The request body.
The object takes the form of:
{ # The request for
# ReservationService.MoveAssignment.
- # Note: "bigquery.reservationAssignments.create" permission is required on the
- # destination_id. Note: "bigquery.reservationAssignments.create" and
- # "bigquery.reservationAssignments.delete" permission is required on the
+ #
+ # **Note**: "bigquery.reservationAssignments.create" permission is required on
+ # the destination_id.
+ #
+ # **Note**: "bigquery.reservationAssignments.create" and
+ # "bigquery.reservationAssignments.delete" permission are required on the
# related assignee.
"destinationId": "A String", # The new reservation ID, e.g.:
- # projects/myotherproject/locations/US/reservations/team2-prod
+ # `projects/myotherproject/locations/US/reservations/team2-prod`
}
x__xgafv: string, V1 error format.
@@ -269,9 +313,9 @@
"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`.
}</pre>
</div>