Enum State

#[repr(i32)]
pub enum State {
    Unspecified = 0,
    Ready = 1,
    Stopped = 2,
    Empty = 3,
    Creating = 4,
    Deleting = 5,
    Failed = 6,
    Bootstrapping = 7,
    Maintenance = 8,
    Promoting = 9,
}

Cluster State

Variants

Unspecified = 0

The state of the cluster is unknown.

Ready = 1

The cluster is active and running.

Stopped = 2

The cluster is stopped. All instances in the cluster are stopped. Customers can start a stopped cluster at any point and all their instances will come back to life with same names and IP resources. In this state, customer pays for storage. Associated backups could also be present in a stopped cluster.

Empty = 3

The cluster is empty and has no associated resources. All instances, associated storage and backups have been deleted.

Creating = 4

The cluster is being created.

Deleting = 5

The cluster is being deleted.

Failed = 6

The creation of the cluster failed.

Bootstrapping = 7

The cluster is bootstrapping with data from some other source. Direct mutations to the cluster (e.g. adding read pool) are not allowed.

Maintenance = 8

The cluster is under maintenance. AlloyDB regularly performs maintenance and upgrades on customer clusters. Updates on the cluster are not allowed while the cluster is in this state.

Promoting = 9

The cluster is being promoted.

Implementations

impl State

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of State.

pub fn from_i32(value: i32) -> Option<State>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a State, or None if value is not a valid variant.

impl State

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl Default for State

fn default() -> State

Returns the “default value” for a type.

impl From<State> for i32

fn from(value: State) -> i32

Converts to this type from the input type.

impl Hash for State

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for State

fn cmp(&self, other: &State) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for State

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for State

fn partial_cmp(&self, other: &State) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for State

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<State, UnknownEnumValue>

Performs the conversion.

impl Copy for State

impl Eq for State

impl StructuralPartialEq for State