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.
Attributes
- commitmentEndTime
Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
- commitmentStartTime
Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
- failureStatus
Output only. For FAILED commitment plan, provides the reason of failure.
- multiRegionAuxiliary
Applicable only for commitments located within one of the BigQuery multi-regions (US or EU). If set to true, this commitment is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this commitment is placed in the organization's default region.
- name
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.- plan
Capacity commitment commitment plan.
- renewalPlan
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 and TRIAL commitments.
- slotCount
Number of slots in this commitment.
- state
Output only. State of the commitment.
- Companion:
- object
- Source:
- CapacityCommitment.scala
- Graph
- Supertypes
- trait Updatable[CapacityCommitment]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any