REST Resource: projects.locations.capacityCommitments

• Resource: CapacityCommitment
  • JSON representation
• CommitmentPlan
• State
• Methods

Resource: CapacityCommitment

Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some minimum committed period of usage. Capacity commitment is immutable and cannot be deleted until the end of the commitment period. After the end of the commitment period, slots are still available but can be freely removed any time.

A capacity commitment resource exists as a child resource of the admin project.

JSON representation
{ "name": string, "slotCount": string, "plan": enum (CommitmentPlan), "state": enum (State), "commitmentEndTime": string }

Fields
name	string Output only. The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123
slotCount	string (int64 format) Number of slots in this commitment.
plan	enum (CommitmentPlan) Capacity commitment commitment plan.
state	enum (State) Output only. State of the commitment.
commitmentEndTime	string (Timestamp format) Output only. The end of the commitment period. Capacity commitment cannot be removed before commitmentEndTime. It is applicable only for ACTIVE capacity commitments and is computed as a combination of the plan and the time when the capacity commitment became ACTIVE. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

CommitmentPlan

Commitment plan defines the end of the committed period.

Enums
COMMITMENT_PLAN_UNSPECIFIED	Invalid plan value. Requests with this value will be rejected with error code google.rpc.Code.INVALID_ARGUMENT.
MONTHLY	Capacity commitment cannot be removed for 30 days after becoming ACTIVE.
ANNUAL	Capacity commitment cannot be removed for 365 days after becoming ACTIVE.

State

Capacity commitment can either become ACTIVE right away or transition from PENDING to ACTIVE.

Enums
STATE_UNSPECIFIED	Invalid state value.
PENDING	Capacity commitment is pending provisioning. Pending capacity commitment does not contribute to the parent's slotCapacity.
ACTIVE	Once slots are provisioned, capacity commitment becomes active. slotCount is added to the parent's slotCapacity.

Methods
delete	Deletes a capacity commitment.
get	Returns information about the capacity commitment.
list	Lists all the capacity commitments for the admin project.