Method: projects.locations.capacityCommitments.split

Splits capacity commitment to two commitments of the same plan and commitmentEndTime.

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 delete the first one after the commitment end time passes.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name e.g.,: projects/myproject/locations/US/capacityCommitments/123

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

  • bigquery.capacityCommitments.update

Request body

The request body contains data with the following structure:

JSON representation 
{
  "slotCount": string
}
Fields
slotCount

string (int64 format)

Number of slots in the capacity commitment after the split.

Response body

If successful, the response body contains data with the following structure:

The response for ReservationService.SplitCapacityCommitment.

JSON representation 
{
  "first": {
    object (CapacityCommitment)
  },
  "second": {
    object (CapacityCommitment)
  }
}
Fields
first

object (CapacityCommitment)

First capacity commitment, result of a split.
second

object (CapacityCommitment)

Second capacity commitment, result of a split.

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.