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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#commitment_end_time
def commitment_end_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
#commitment_start_time
def commitment_start_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
#failure_status
def failure_status() -> ::Google::Rpc::Status
Returns
- (::Google::Rpc::Status) — Output only. For FAILED commitment plan, provides the reason of failure.
#name
def name() -> ::String
Returns
-
(::String) — Output only. The resource name of the capacity commitment, e.g.,
projects/myproject/locations/US/capacityCommitments/123
#plan
def plan() -> ::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment::CommitmentPlan
Returns
- (::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment::CommitmentPlan) — Capacity commitment commitment plan.
#plan=
def plan=(value) -> ::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment::CommitmentPlan
Parameter
- value (::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment::CommitmentPlan) — Capacity commitment commitment plan.
Returns
- (::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment::CommitmentPlan) — Capacity commitment commitment plan.
#renewal_plan
def renewal_plan() -> ::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment::CommitmentPlan
Returns
- (::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment::CommitmentPlan) — 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.
#renewal_plan=
def renewal_plan=(value) -> ::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment::CommitmentPlan
Parameter
- value (::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment::CommitmentPlan) — 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.
Returns
- (::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment::CommitmentPlan) — 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.
#slot_count
def slot_count() -> ::Integer
Returns
- (::Integer) — Number of slots in this commitment.
#slot_count=
def slot_count=(value) -> ::Integer
Parameter
- value (::Integer) — Number of slots in this commitment.
Returns
- (::Integer) — Number of slots in this commitment.
#state
def state() -> ::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment::State
Returns
- (::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment::State) — Output only. State of the commitment.