Struct google_api_proto::google::spanner::admin::instance::v1::InstancePartition

pub struct InstancePartition {
    pub name: String,
    pub config: String,
    pub display_name: String,
    pub state: i32,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub referencing_databases: Vec<String>,
    pub referencing_backups: Vec<String>,
    pub etag: String,
    pub compute_capacity: Option<ComputeCapacity>,
}

An isolated set of Cloud Spanner resources that databases can define placements on.

Fields

name: String

Required. A unique identifier for the instance partition. Values are of the form projects/<project>/instances/<instance>/instancePartitions/[a-z][-a-z0-9]*\[a-z0-9\]. The final segment of the name must be between 2 and 64 characters in length. An instance partition’s name cannot be changed after the instance partition is created.

config: String

Required. The name of the instance partition’s configuration. Values are of the form projects/<project>/instanceConfigs/<configuration>. See also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].

display_name: String

Required. The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

state: i32

Output only. The current instance partition state.

create_time: Option<Timestamp>

Output only. The time at which the instance partition was created.

update_time: Option<Timestamp>

Output only. The time at which the instance partition was most recently updated.

referencing_databases: Vec<String>

Output only. The names of the databases that reference this instance partition. Referencing databases should share the parent instance. The existence of any referencing database prevents the instance partition from being deleted.

referencing_backups: Vec<String>

Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted.

etag: String

Used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance partition from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance partition updates in order to avoid race conditions: An etag is returned in the response which contains instance partitions, and systems are expected to put that etag in the request to update instance partitions to ensure that their change will be applied to the same version of the instance partition. If no etag is provided in the call to update instance partition, then the existing instance partition is overwritten blindly.

compute_capacity: Option<ComputeCapacity>

Compute capacity defines amount of server and storage resources that are available to the databases in an instance partition. At most one of either node_count or processing_units should be present in the message. See the documentation for more information about nodes and processing units.

Implementations

impl InstancePartition

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.

Trait Implementations

impl Clone for InstancePartition

fn clone(&self) -> InstancePartition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstancePartition

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

Formats the value using the given formatter.

impl Default for InstancePartition

fn default() -> Self

Returns the “default value” for a type.

impl Message for InstancePartition

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, Self: Sized,

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

impl PartialEq for InstancePartition

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