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

pub struct CapacityCommitment {
    pub name: String,
    pub slot_count: i64,
    pub plan: i32,
    pub state: i32,
    pub commitment_end_time: Option<Timestamp>,
    pub failure_status: Option<Status>,
    pub renewal_plan: 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

slot_count: i64

Number of slots in this commitment.

plan: i32

Capacity commitment commitment plan.

state: i32

Output only. State of the commitment.

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.

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.

Trait Implementations

impl Clone for CapacityCommitment

fn clone(&self) -> CapacityCommitment

Returns a copy of the value.

pub 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() -> CapacityCommitment

Returns the “default value” for a type.

impl Message for CapacityCommitment

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

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

Encodes the message to a buffer.

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

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<CapacityCommitment> 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: &CapacityCommitment) -> bool

This method tests for !=.

impl StructuralPartialEq for CapacityCommitment