Method: projects.locations.capacityCommitments.merge

Merges capacity commitments of the same plan into a single commitment.

The resulting capacity commitment has the greater commitmentEndTime 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.

HTTP request

POST https://bigqueryreservation.googleapis.com/v1/{parent=projects/*/locations/*}/capacityCommitments:merge

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Parent resource that identifies admin project and location e.g., projects/myproject/locations/us

Authorization requires the following IAM permission on the specified resource parent:

  • bigquery.capacityCommitments.update

Request body

The request body contains data with the following structure:

JSON representation 
{
  "capacityCommitmentIds": [
    string
  ],
  "capacityCommitmentId": string
}
Fields
capacityCommitmentIds[]

string

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
capacityCommitmentId

string

Optional. The optional resulting capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters.

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/bigquery
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.