Resource: CapacityCommitment
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.
JSON representation | |
---|---|
{ "name": string, "slotCount": string, "plan": enum ( |
Fields | |
---|---|
name |
Output only. The resource name of the capacity commitment, e.g., |
slotCount |
Number of slots in this commitment. |
plan |
Capacity commitment commitment plan. |
state |
Output only. State of the commitment. |
commitmentStartTime |
Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
commitmentEndTime |
Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
failureStatus |
Output only. For FAILED commitment plan, provides the reason of failure. |
renewalPlan |
The plan this capacity commitment is converted to after commitmentEndTime passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL commitments. |
CommitmentPlan
Commitment plan defines the current committed period. Capacity commitment cannot be deleted during it's committed period.
Enums | |
---|---|
COMMITMENT_PLAN_UNSPECIFIED |
Invalid plan value. Requests with this value will be rejected with error code google.rpc.Code.INVALID_ARGUMENT . |
FLEX |
Flex commitments have committed period of 1 minute after becoming ACTIVE. After that, they are not in a committed period anymore and can be removed any time. |
TRIAL |
Trial commitments have a committed period of 182 days after becoming ACTIVE. After that, they are converted to a new commitment based on the renewalPlan . Default renewalPlan for Trial commitment is Flex so that it can be deleted right after committed period ends. |
MONTHLY |
Monthly commitments have a committed period of 30 days after becoming ACTIVE. After that, they are not in a committed period anymore and can be removed any time. |
ANNUAL |
Annual commitments have a committed period of 365 days after becoming ACTIVE. After that they are converted to a new commitment based on the renewalPlan. |
State
Capacity commitment can either become ACTIVE right away or transition from PENDING to ACTIVE or FAILED.
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. |
FAILED |
Capacity commitment is failed to be activated by the backend. |
Methods |
|
---|---|
|
Creates a new capacity commitment resource. |
|
Deletes a capacity commitment. |
|
Returns information about the capacity commitment. |
|
Lists all the capacity commitments for the admin project. |
|
Merges capacity commitments of the same plan into a single commitment. |
|
Updates an existing capacity commitment. |
|
Splits capacity commitment to two commitments of the same plan and commitment_end_time . |