BigQuery Reservation V1 API - Class Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment (v1.8.0)

Reference documentation and code samples for the BigQuery Reservation V1 API class Google::Cloud::Bigquery::Reservation::V1::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.

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. Note after renewal, commitment_end_time is the time the renewed commitment expires. So it would be at a time after commitment_start_time + committed period, because we don't change commitment_start_time ,

#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. Note after the commitment is renewed, commitment_start_time won't be changed. It refers to the start time of the original commitment.

#edition

def edition() -> ::Google::Cloud::Bigquery::Reservation::V1::Edition
Returns

#edition=

def edition=(value) -> ::Google::Cloud::Bigquery::Reservation::V1::Edition
Parameter
Returns

#failure_status

def failure_status() -> ::Google::Rpc::Status
Returns

#is_flat_rate

def is_flat_rate() -> ::Boolean
Returns
  • (::Boolean) — Output only. If true, the commitment is a flat-rate commitment, otherwise, it's an edition commitment.

#multi_region_auxiliary

def multi_region_auxiliary() -> ::Boolean
Returns
  • (::Boolean) — 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.

    NOTE: this is a preview feature. Project must be allow-listed in order to set this field.

#multi_region_auxiliary=

def multi_region_auxiliary=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.

    NOTE: this is a preview feature. Project must be allow-listed in order to set this field.

Returns
  • (::Boolean) — 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.

    NOTE: this is a preview feature. Project must be allow-listed in order to set this field.

#name

def name() -> ::String
Returns
  • (::String) — 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

def plan() -> ::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment::CommitmentPlan
Returns

#plan=

def plan=(value) -> ::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment::CommitmentPlan
Parameter
Returns

#renewal_plan

def renewal_plan() -> ::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment::CommitmentPlan
Returns

#renewal_plan=

def renewal_plan=(value) -> ::Google::Cloud::Bigquery::Reservation::V1::CapacityCommitment::CommitmentPlan
Parameter
Returns

#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