docs: update generated docs (#981)
diff --git a/docs/dyn/bigqueryreservation_v1beta1.projects.locations.capacityCommitments.html b/docs/dyn/bigqueryreservation_v1beta1.projects.locations.capacityCommitments.html
index 3e458ce..0a10db2 100644
--- a/docs/dyn/bigqueryreservation_v1beta1.projects.locations.capacityCommitments.html
+++ b/docs/dyn/bigqueryreservation_v1beta1.projects.locations.capacityCommitments.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns information about the capacity commitment.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the capacity commitments for the admin project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -119,11 +119,8 @@
#
# A capacity commitment resource exists as a child resource of the admin
# project.
- "plan": "A String", # Capacity commitment commitment plan.
"slotCount": "A String", # Number of slots in this commitment.
- "renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time
- # passes. Once the plan is changed, committed period is extended according to
- # commitment plan. Only applicable for ANNUAL commitments.
+ "plan": "A String", # Capacity commitment commitment plan.
"failureStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED commitment plan, provides the reason of failure.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -142,11 +139,16 @@
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
},
+ "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for
+ # ACTIVE capacity commitments.
+ "name": "A String", # Output only. The resource name of the capacity commitment, e.g.,
+ # `projects/myproject/locations/US/capacityCommitments/123`
+ "renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time
+ # passes. Once the plan is changed, committed period is extended according to
+ # commitment plan. Only applicable for ANNUAL commitments.
"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE
# capacity commitments.
"state": "A String", # Output only. State of the commitment.
- "name": "A String", # Output only. The resource name of the capacity commitment, e.g.,
- # `projects/myproject/locations/US/capacityCommitments/123`
}
enforceSingleAdminProjectPerOrg: boolean, If true, fail the request if another project in the organization has a
@@ -169,11 +171,8 @@
#
# A capacity commitment resource exists as a child resource of the admin
# project.
- "plan": "A String", # Capacity commitment commitment plan.
"slotCount": "A String", # Number of slots in this commitment.
- "renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time
- # passes. Once the plan is changed, committed period is extended according to
- # commitment plan. Only applicable for ANNUAL commitments.
+ "plan": "A String", # Capacity commitment commitment plan.
"failureStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED commitment plan, provides the reason of failure.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -192,11 +191,16 @@
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
},
+ "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for
+ # ACTIVE capacity commitments.
+ "name": "A String", # Output only. The resource name of the capacity commitment, e.g.,
+ # `projects/myproject/locations/US/capacityCommitments/123`
+ "renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time
+ # passes. Once the plan is changed, committed period is extended according to
+ # commitment plan. Only applicable for ANNUAL commitments.
"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE
# capacity commitments.
"state": "A String", # Output only. State of the commitment.
- "name": "A String", # Output only. The resource name of the capacity commitment, e.g.,
- # `projects/myproject/locations/US/capacityCommitments/123`
}</pre>
</div>
@@ -254,11 +258,8 @@
#
# A capacity commitment resource exists as a child resource of the admin
# project.
- "plan": "A String", # Capacity commitment commitment plan.
"slotCount": "A String", # Number of slots in this commitment.
- "renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time
- # passes. Once the plan is changed, committed period is extended according to
- # commitment plan. Only applicable for ANNUAL commitments.
+ "plan": "A String", # Capacity commitment commitment plan.
"failureStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED commitment plan, provides the reason of failure.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -277,23 +278,28 @@
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
},
+ "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for
+ # ACTIVE capacity commitments.
+ "name": "A String", # Output only. The resource name of the capacity commitment, e.g.,
+ # `projects/myproject/locations/US/capacityCommitments/123`
+ "renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time
+ # passes. Once the plan is changed, committed period is extended according to
+ # commitment plan. Only applicable for ANNUAL commitments.
"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE
# capacity commitments.
"state": "A String", # Output only. State of the commitment.
- "name": "A String", # Output only. The resource name of the capacity commitment, e.g.,
- # `projects/myproject/locations/US/capacityCommitments/123`
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all the capacity commitments for the admin project.
Args:
parent: string, Required. Resource name of the parent reservation. E.g.,
`projects/myproject/locations/US` (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.
+ pageToken: string, The next_page_token value returned from a previous List request, if any.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -303,6 +309,8 @@
An object of the form:
{ # The response for ReservationService.ListCapacityCommitments.
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
+ # more results in the list.
"capacityCommitments": [ # List of capacity commitments visible to the user.
{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs
# (in the form of slots) with some committed period of usage. Annual
@@ -314,11 +322,8 @@
#
# A capacity commitment resource exists as a child resource of the admin
# project.
- "plan": "A String", # Capacity commitment commitment plan.
"slotCount": "A String", # Number of slots in this commitment.
- "renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time
- # passes. Once the plan is changed, committed period is extended according to
- # commitment plan. Only applicable for ANNUAL commitments.
+ "plan": "A String", # Capacity commitment commitment plan.
"failureStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED commitment plan, provides the reason of failure.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -337,15 +342,18 @@
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
},
+ "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for
+ # ACTIVE capacity commitments.
+ "name": "A String", # Output only. The resource name of the capacity commitment, e.g.,
+ # `projects/myproject/locations/US/capacityCommitments/123`
+ "renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time
+ # passes. Once the plan is changed, committed period is extended according to
+ # commitment plan. Only applicable for ANNUAL commitments.
"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE
# capacity commitments.
"state": "A String", # Output only. State of the commitment.
- "name": "A String", # Output only. The resource name of the capacity commitment, e.g.,
- # `projects/myproject/locations/US/capacityCommitments/123`
},
],
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
- # more results in the list.
}</pre>
</div>
@@ -383,6 +391,8 @@
"capacityCommitmentIds": [ # Ids of capacity commitments to merge.
# These capacity commitments must exist under admin project and location
# specified in the parent.
+ # ID is the last portion of capacity commitment name e.g., 'abc' for
+ # projects/myproject/locations/US/capacityCommitments/abc
"A String",
],
}
@@ -405,11 +415,8 @@
#
# A capacity commitment resource exists as a child resource of the admin
# project.
- "plan": "A String", # Capacity commitment commitment plan.
"slotCount": "A String", # Number of slots in this commitment.
- "renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time
- # passes. Once the plan is changed, committed period is extended according to
- # commitment plan. Only applicable for ANNUAL commitments.
+ "plan": "A String", # Capacity commitment commitment plan.
"failureStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED commitment plan, provides the reason of failure.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -428,11 +435,16 @@
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
},
+ "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for
+ # ACTIVE capacity commitments.
+ "name": "A String", # Output only. The resource name of the capacity commitment, e.g.,
+ # `projects/myproject/locations/US/capacityCommitments/123`
+ "renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time
+ # passes. Once the plan is changed, committed period is extended according to
+ # commitment plan. Only applicable for ANNUAL commitments.
"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE
# capacity commitments.
"state": "A String", # Output only. State of the commitment.
- "name": "A String", # Output only. The resource name of the capacity commitment, e.g.,
- # `projects/myproject/locations/US/capacityCommitments/123`
}</pre>
</div>
@@ -462,11 +474,8 @@
#
# A capacity commitment resource exists as a child resource of the admin
# project.
- "plan": "A String", # Capacity commitment commitment plan.
"slotCount": "A String", # Number of slots in this commitment.
- "renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time
- # passes. Once the plan is changed, committed period is extended according to
- # commitment plan. Only applicable for ANNUAL commitments.
+ "plan": "A String", # Capacity commitment commitment plan.
"failureStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED commitment plan, provides the reason of failure.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -485,11 +494,16 @@
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
},
+ "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for
+ # ACTIVE capacity commitments.
+ "name": "A String", # Output only. The resource name of the capacity commitment, e.g.,
+ # `projects/myproject/locations/US/capacityCommitments/123`
+ "renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time
+ # passes. Once the plan is changed, committed period is extended according to
+ # commitment plan. Only applicable for ANNUAL commitments.
"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE
# capacity commitments.
"state": "A String", # Output only. State of the commitment.
- "name": "A String", # Output only. The resource name of the capacity commitment, e.g.,
- # `projects/myproject/locations/US/capacityCommitments/123`
}
updateMask: string, Standard field mask for the set of fields to be updated.
@@ -511,11 +525,8 @@
#
# A capacity commitment resource exists as a child resource of the admin
# project.
- "plan": "A String", # Capacity commitment commitment plan.
"slotCount": "A String", # Number of slots in this commitment.
- "renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time
- # passes. Once the plan is changed, committed period is extended according to
- # commitment plan. Only applicable for ANNUAL commitments.
+ "plan": "A String", # Capacity commitment commitment plan.
"failureStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED commitment plan, provides the reason of failure.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -534,11 +545,16 @@
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
},
+ "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for
+ # ACTIVE capacity commitments.
+ "name": "A String", # Output only. The resource name of the capacity commitment, e.g.,
+ # `projects/myproject/locations/US/capacityCommitments/123`
+ "renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time
+ # passes. Once the plan is changed, committed period is extended according to
+ # commitment plan. Only applicable for ANNUAL commitments.
"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE
# capacity commitments.
"state": "A String", # Output only. State of the commitment.
- "name": "A String", # Output only. The resource name of the capacity commitment, e.g.,
- # `projects/myproject/locations/US/capacityCommitments/123`
}</pre>
</div>
@@ -582,11 +598,8 @@
#
# A capacity commitment resource exists as a child resource of the admin
# project.
- "plan": "A String", # Capacity commitment commitment plan.
"slotCount": "A String", # Number of slots in this commitment.
- "renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time
- # passes. Once the plan is changed, committed period is extended according to
- # commitment plan. Only applicable for ANNUAL commitments.
+ "plan": "A String", # Capacity commitment commitment plan.
"failureStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED commitment plan, provides the reason of failure.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -605,11 +618,16 @@
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
},
+ "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for
+ # ACTIVE capacity commitments.
+ "name": "A String", # Output only. The resource name of the capacity commitment, e.g.,
+ # `projects/myproject/locations/US/capacityCommitments/123`
+ "renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time
+ # passes. Once the plan is changed, committed period is extended according to
+ # commitment plan. Only applicable for ANNUAL commitments.
"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE
# capacity commitments.
"state": "A String", # Output only. State of the commitment.
- "name": "A String", # Output only. The resource name of the capacity commitment, e.g.,
- # `projects/myproject/locations/US/capacityCommitments/123`
},
"first": { # Capacity commitment is a way to purchase compute capacity for BigQuery jobs # First capacity commitment, result of a split.
# (in the form of slots) with some committed period of usage. Annual
@@ -621,11 +639,8 @@
#
# A capacity commitment resource exists as a child resource of the admin
# project.
- "plan": "A String", # Capacity commitment commitment plan.
"slotCount": "A String", # Number of slots in this commitment.
- "renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time
- # passes. Once the plan is changed, committed period is extended according to
- # commitment plan. Only applicable for ANNUAL commitments.
+ "plan": "A String", # Capacity commitment commitment plan.
"failureStatus": { # The `Status` type defines a logical error model that is suitable for # Output only. For FAILED commitment plan, provides the reason of failure.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
@@ -644,11 +659,16 @@
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
},
+ "commitmentStartTime": "A String", # Output only. The start of the current commitment period. It is applicable only for
+ # ACTIVE capacity commitments.
+ "name": "A String", # Output only. The resource name of the capacity commitment, e.g.,
+ # `projects/myproject/locations/US/capacityCommitments/123`
+ "renewalPlan": "A String", # The plan this capacity commitment is converted to after commitment_end_time
+ # passes. Once the plan is changed, committed period is extended according to
+ # commitment plan. Only applicable for ANNUAL commitments.
"commitmentEndTime": "A String", # Output only. The end of the current commitment period. It is applicable only for ACTIVE
# capacity commitments.
"state": "A String", # Output only. State of the commitment.
- "name": "A String", # Output only. The resource name of the capacity commitment, e.g.,
- # `projects/myproject/locations/US/capacityCommitments/123`
},
}</pre>
</div>