Some or all of the information on this page might not apply to Trusted Cloud by S3NS.
Method: projects.locations.capacityCommitments.patch
Updates an existing capacity commitment.
Only plan and renewalPlan 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.
HTTP request
PATCH https://bigqueryreservation.googleapis.com/v1/{capacityCommitment.name=projects/*/locations/*/capacityCommitments/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
capacityCommitment.name |
string
Output only. The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123 The commitment_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.
|
Query parameters
| Parameters |
updateMask |
string (FieldMask format)
Standard field mask for the set of fields to be updated. This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
|
Request body
The request body contains an instance of CapacityCommitment.
Response body
If successful, the response body contains an instance of CapacityCommitment.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/bigqueryhttps://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-02 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-02 UTC."],[[["This endpoint updates an existing capacity commitment, allowing changes to the `plan` and `renewalPlan` fields."],["The `plan` can only be updated to a plan with a longer commitment period, and attempts to switch to a shorter period will result in a `google.rpc.Code.FAILED_PRECONDITION` error."],["The HTTP request uses the `PATCH` method and requires a capacity commitment name in the URL, structured as `projects/*/locations/*/capacityCommitments/*`."],["The update operation uses the `updateMask` query parameter to specify the fields to be updated, as a comma-separated list."],["Successful updates return an instance of `CapacityCommitment` in the response body, and requires either the `https://www.googleapis.com/auth/bigquery` or `https://www.googleapis.com/auth/cloud-platform` OAuth scope."]]],[]]
