docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/bigqueryreservation_v1beta1.projects.locations.capacityCommitments.html b/docs/dyn/bigqueryreservation_v1beta1.projects.locations.capacityCommitments.html
index 7b3f608..3e458ce 100644
--- a/docs/dyn/bigqueryreservation_v1beta1.projects.locations.capacityCommitments.html
+++ b/docs/dyn/bigqueryreservation_v1beta1.projects.locations.capacityCommitments.html
@@ -91,7 +91,7 @@
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#merge">merge(parent, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Merges capacity commitments of the same plan into one. Resulting capacity</p>
+<p class="firstline">Merges capacity commitments of the same plan into a single commitment.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing capacity commitment.</p>
@@ -105,71 +105,20 @@
Args:
parent: string, Required. Resource name of the parent reservation. E.g.,
- projects/myproject/locations/US (required)
+ `projects/myproject/locations/US` (required)
body: object, The request body.
The object takes the form of:
{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs
- # (in the form of slots) with some committed period of usage. Annual
- # commitments renew by default. Commitments can be removed after their
- # commitment end time passes. In order to remove annual commitment, its plan
- # needs to be changed to monthly or flex first.
- #
- # A capacity commitment resource exists as a child resource of the admin
- # project.
- "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
- "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.
- "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
- # 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).
- "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.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
-}
-
- enforceSingleAdminProjectPerOrg: boolean, If true, fail the request if another project in the organization has a
-capacity commitment.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Capacity commitment is a way to purchase compute capacity for BigQuery jobs
# (in the form of slots) with some committed period of usage. Annual
# commitments renew by default. Commitments can be removed after their
- # commitment end time passes. In order to remove annual commitment, its plan
- # needs to be changed to monthly or flex first.
- #
+ # commitment end time passes.
+ #
+ # In order to remove annual commitment, its plan needs to be changed
+ # to monthly or flex first.
+ #
# A capacity commitment resource exists as a child resource of the admin
# project.
- "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
"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
@@ -182,9 +131,6 @@
#
# 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).
- "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.
{
@@ -192,8 +138,66 @@
},
],
"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.
},
- }</pre>
+ "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
+capacity commitment.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Capacity commitment is a way to purchase compute capacity for BigQuery jobs
+ # (in the form of slots) with some committed period of usage. Annual
+ # commitments renew by default. Commitments can be removed after their
+ # commitment end time passes.
+ #
+ # In order to remove annual commitment, its plan needs to be changed
+ # to monthly or flex first.
+ #
+ # 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.
+ "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
+ # 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).
+ "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.
+ },
+ ],
+ "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.
+ },
+ "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">
@@ -204,7 +208,7 @@
Args:
name: string, Required. Resource name of the capacity commitment to delete. E.g.,
- projects/myproject/locations/US/capacityCommitments/123 (required)
+ `projects/myproject/locations/US/capacityCommitments/123` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -231,7 +235,7 @@
Args:
name: string, Required. Resource name of the capacity commitment to retrieve. E.g.,
- projects/myproject/locations/US/capacityCommitments/123 (required)
+ `projects/myproject/locations/US/capacityCommitments/123` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -241,42 +245,44 @@
An object of the form:
{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs
- # (in the form of slots) with some committed period of usage. Annual
- # commitments renew by default. Commitments can be removed after their
- # commitment end time passes. In order to remove annual commitment, its plan
- # needs to be changed to monthly or flex first.
- #
- # A capacity commitment resource exists as a child resource of the admin
- # project.
- "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
- "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.
- "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
- # three pieces of data: error code, error message, and error details.
+ # (in the form of slots) with some committed period of usage. Annual
+ # commitments renew by default. Commitments can be removed after their
+ # commitment end time passes.
#
- # 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).
- "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.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
- }</pre>
+ # In order to remove annual commitment, its plan needs to be changed
+ # to monthly or flex first.
+ #
+ # 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.
+ "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
+ # 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).
+ "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.
+ },
+ ],
+ "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.
+ },
+ "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">
@@ -285,7 +291,7 @@
Args:
parent: string, Required. Resource name of the parent reservation. E.g.,
- projects/myproject/locations/US (required)
+ `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.
x__xgafv: string, V1 error format.
@@ -299,42 +305,44 @@
{ # The response for ReservationService.ListCapacityCommitments.
"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
- # commitments renew by default. Commitments can be removed after their
- # commitment end time passes. In order to remove annual commitment, its plan
- # needs to be changed to monthly or flex first.
- #
- # A capacity commitment resource exists as a child resource of the admin
- # project.
- "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
- "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.
- "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
- # three pieces of data: error code, error message, and error details.
+ # (in the form of slots) with some committed period of usage. Annual
+ # commitments renew by default. Commitments can be removed after their
+ # commitment end time passes.
#
- # 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).
- "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.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ # In order to remove annual commitment, its plan needs to be changed
+ # to monthly or flex first.
+ #
+ # 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.
+ "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
+ # 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).
+ "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.
+ },
+ ],
+ "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.
+ },
+ "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.
@@ -357,14 +365,17 @@
<div class="method">
<code class="details" id="merge">merge(parent, body=None, x__xgafv=None)</code>
- <pre>Merges capacity commitments of the same plan into one. Resulting capacity
-commitment has the longer commitment_end_time out of the two. Attempting to
-merge capacity commitments of different plan will fail with the error code
-`google.rpc.Code.FAILED_PRECONDITION`.
+ <pre>Merges capacity commitments of the same plan into a single commitment.
+
+The resulting capacity commitment has the greater commitment_end_time
+out of the to-be-merged capacity commitments.
+
+Attempting to merge capacity commitments of different plan will fail
+with the error code `google.rpc.Code.FAILED_PRECONDITION`.
Args:
parent: string, Parent resource that identifies admin project and location e.g.,
-projects/myproject/locations/us (required)
+ `projects/myproject/locations/us` (required)
body: object, The request body.
The object takes the form of:
@@ -385,18 +396,72 @@
An object of the form:
{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs
+ # (in the form of slots) with some committed period of usage. Annual
+ # commitments renew by default. Commitments can be removed after their
+ # commitment end time passes.
+ #
+ # In order to remove annual commitment, its plan needs to be changed
+ # to monthly or flex first.
+ #
+ # 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.
+ "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
+ # 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).
+ "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.
+ },
+ ],
+ "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.
+ },
+ "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="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
+ <pre>Updates an existing capacity commitment.
+
+Only `plan` and `renewal_plan` fields can be updated.
+
+Plan can only be changed to a plan of a longer commitment period.
+Attempting to change to a plan with shorter commitment period will fail
+with the error code `google.rpc.Code.FAILED_PRECONDITION`.
+
+Args:
+ name: string, Output only. The resource name of the capacity commitment, e.g.,
+`projects/myproject/locations/US/capacityCommitments/123` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs
# (in the form of slots) with some committed period of usage. Annual
# commitments renew by default. Commitments can be removed after their
- # commitment end time passes. In order to remove annual commitment, its plan
- # needs to be changed to monthly or flex first.
- #
+ # commitment end time passes.
+ #
+ # In order to remove annual commitment, its plan needs to be changed
+ # to monthly or flex first.
+ #
# A capacity commitment resource exists as a child resource of the admin
# project.
- "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
"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
@@ -409,9 +474,6 @@
#
# 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).
- "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.
{
@@ -419,62 +481,16 @@
},
],
"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.
},
- }</pre>
-</div>
-
-<div class="method">
- <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
- <pre>Updates an existing capacity commitment.
-
-Only plan and renewal_plan fields can be updated.
-Plan can only be changed to a plan of a longer commitment period.
-Attempting to change to a plan with shorter commitment period will fail
-with the error code `google.rpc.Code.FAILED_PRECONDITION`.
-
-Args:
- name: string, Output only. The resource name of the capacity commitment, e.g.,
- projects/myproject/locations/US/capacityCommitments/123 (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs
- # (in the form of slots) with some committed period of usage. Annual
- # commitments renew by default. Commitments can be removed after their
- # commitment end time passes. In order to remove annual commitment, its plan
- # needs to be changed to monthly or flex first.
- #
- # A capacity commitment resource exists as a child resource of the admin
- # project.
- "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
- "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.
- "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
- # 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).
- "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.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
-}
+ "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.
x__xgafv: string, V1 error format.
@@ -486,55 +502,60 @@
An object of the form:
{ # Capacity commitment is a way to purchase compute capacity for BigQuery jobs
- # (in the form of slots) with some committed period of usage. Annual
- # commitments renew by default. Commitments can be removed after their
- # commitment end time passes. In order to remove annual commitment, its plan
- # needs to be changed to monthly or flex first.
- #
- # A capacity commitment resource exists as a child resource of the admin
- # project.
- "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
- "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.
- "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
- # three pieces of data: error code, error message, and error details.
+ # (in the form of slots) with some committed period of usage. Annual
+ # commitments renew by default. Commitments can be removed after their
+ # commitment end time passes.
#
- # 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).
- "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.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- },
- }</pre>
+ # In order to remove annual commitment, its plan needs to be changed
+ # to monthly or flex first.
+ #
+ # 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.
+ "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
+ # 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).
+ "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.
+ },
+ ],
+ "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.
+ },
+ "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="split">split(name, body=None, x__xgafv=None)</code>
<pre>Splits capacity commitment to two commitments of the same plan and
-commitment_end_time. A common use case to do that is to perform a downgrade
-e.g., in order to downgrade from 10000 slots to 8000, one might split 10000
-capacity commitment to 2000 and 8000, change the plan of the first one to
-flex and then delete it.
+`commitment_end_time`.
+
+A common use case is to enable downgrading commitments.
+
+For example, in order to downgrade from 10000 slots to 8000, you might
+split a 10000 capacity commitment into commitments of 2000 and 8000. Then,
+you would change the plan of the first one to `FLEX` and then delete it.
Args:
name: string, Required. The resource name e.g.,:
- projects/myproject/locations/US/capacityCommitments/123 (required)
+ `projects/myproject/locations/US/capacityCommitments/123` (required)
body: object, The request body.
The object takes the form of:
@@ -552,79 +573,83 @@
{ # The response for ReservationService.SplitCapacityCommitment.
"second": { # Capacity commitment is a way to purchase compute capacity for BigQuery jobs # Second capacity commitment, result of a split.
- # (in the form of slots) with some committed period of usage. Annual
- # commitments renew by default. Commitments can be removed after their
- # commitment end time passes. In order to remove annual commitment, its plan
- # needs to be changed to monthly or flex first.
- #
- # A capacity commitment resource exists as a child resource of the admin
- # project.
- "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
- "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.
- "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
- # three pieces of data: error code, error message, and error details.
+ # (in the form of slots) with some committed period of usage. Annual
+ # commitments renew by default. Commitments can be removed after their
+ # commitment end time passes.
#
- # 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).
- "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.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ # In order to remove annual commitment, its plan needs to be changed
+ # to monthly or flex first.
+ #
+ # 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.
+ "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
+ # 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).
+ "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.
+ },
+ ],
+ "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.
+ },
+ "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
- # commitments renew by default. Commitments can be removed after their
- # commitment end time passes. In order to remove annual commitment, its plan
- # needs to be changed to monthly or flex first.
- #
- # A capacity commitment resource exists as a child resource of the admin
- # project.
- "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
- "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.
- "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
- # three pieces of data: error code, error message, and error details.
+ # (in the form of slots) with some committed period of usage. Annual
+ # commitments renew by default. Commitments can be removed after their
+ # commitment end time passes.
#
- # 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).
- "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.
- },
- ],
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ # In order to remove annual commitment, its plan needs to be changed
+ # to monthly or flex first.
+ #
+ # 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.
+ "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
+ # 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).
+ "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.
+ },
+ ],
+ "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.
+ },
+ "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>