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

pub struct Reservation {
    pub name: String,
    pub slot_capacity: i64,
    pub ignore_idle_slots: bool,
    pub autoscale: Option<Autoscale>,
    pub concurrency: i64,
    pub creation_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub multi_region_auxiliary: bool,
    pub edition: i32,
}

A reservation is a mechanism used to guarantee slots to users.

Fields

name: String

The resource name of the reservation, e.g., projects/*/locations/*/reservations/team1-prod. The reservation_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_capacity: i64

Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism.

Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false.

If total slot_capacity of the reservation and its siblings exceeds the total slot_count of all capacity commitments, the request will fail with google.rpc.Code.RESOURCE_EXHAUSTED.

NOTE: for reservations in US or EU multi-regions, slot capacity constraints are checked separately for default and auxiliary regions. See multi_region_auxiliary flag for more details.

ignore_idle_slots: bool

If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.

autoscale: Option<Autoscale>

The configuration parameters for the auto scaling feature. Note this is an alpha feature.

concurrency: i64

Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as target_job_concurrency in the Information Schema, DDL and BQ CLI.

creation_time: Option<Timestamp>

Output only. Creation time of the reservation.

update_time: Option<Timestamp>

Output only. Last update time of the reservation.

multi_region_auxiliary: bool

Applicable only for reservations located within one of the BigQuery multi-regions (US or EU).

If set to true, this reservation is placed in the organization’s secondary region which is designated for disaster recovery purposes. If false, this reservation 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 reservation.

Implementations

impl Reservation

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 Reservation

fn clone(&self) -> Reservation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Reservation

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

Formats the value using the given formatter.

impl Default for Reservation

fn default() -> Self

Returns the “default value” for a type.

impl Message for Reservation

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 Reservation

fn eq(&self, other: &Reservation) -> 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 Reservation