Struct google_api_proto::google::cloud::bigquery::reservation::v1::CapacityCommitment

pub struct CapacityCommitment {
    pub name: String,
    pub slot_count: i64,
    pub plan: i32,
    pub state: i32,
    pub commitment_start_time: Option<Timestamp>,
    pub commitment_end_time: Option<Timestamp>,
    pub failure_status: Option<Status>,
    pub renewal_plan: i32,
    pub multi_region_auxiliary: bool,
    pub edition: i32,
}

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.

Fields

name: 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.

slot_count: i64

Number of slots in this commitment.

plan: i32

Capacity commitment commitment plan.

state: i32

Output only. State of the commitment.

commitment_start_time: Option<Timestamp>

Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.

commitment_end_time: Option<Timestamp>

Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.

failure_status: Option<Status>

Output only. For FAILED commitment plan, provides the reason of failure.

renewal_plan: i32

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.

multi_region_auxiliary: bool

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.

edition: i32

Edition of the capacity commitment.

Implementations

impl CapacityCommitment

pub fn plan(&self) -> CommitmentPlan

Returns the enum value of plan, or the default if the field is set to an invalid enum value.

pub fn set_plan(&mut self, value: CommitmentPlan)

Sets plan to the provided enum value.

pub fn state(&self) -> State

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

pub fn renewal_plan(&self) -> CommitmentPlan

Returns the enum value of renewal_plan, or the default if the field is set to an invalid enum value.

pub fn set_renewal_plan(&mut self, value: CommitmentPlan)

Sets renewal_plan to the provided enum value.

pub fn edition(&self) -> Edition

Returns the enum value of edition, or the default if the field is set to an invalid enum value.

pub fn set_edition(&mut self, value: Edition)

Sets edition to the provided enum value.

Trait Implementations

impl Clone for CapacityCommitment

fn clone(&self) -> CapacityCommitment

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CapacityCommitment

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CapacityCommitment

fn default() -> Self

Returns the “default value” for a type.

impl Message for CapacityCommitment

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for CapacityCommitment

fn eq(&self, other: &CapacityCommitment) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CapacityCommitment