Struct State

pub struct State(/* private fields */);

Possible states an environment might transition between during startup. These states are not normally actionable by clients, but may be used to show a progress message to the user. An environment won’t necessarily go through all of these states when starting. More states are likely to be added in the future.

Implementations

impl State

pub const STATE_UNSPECIFIED: State

The environment’s start state is unknown.

pub const STARTING: State

The environment is in the process of being started, but no additional details are available.

pub const UNARCHIVING_DISK: State

Startup is waiting for the user’s disk to be unarchived. This can happen when the user returns to Cloud Shell after not having used it for a while, and suggests that startup will take longer than normal.

pub const AWAITING_COMPUTE_RESOURCES: State

Startup is waiting for compute resources to be assigned to the environment. This should normally happen very quickly, but an environment might stay in this state for an extended period of time if the system is experiencing heavy load.

pub const FINISHED: State

Startup has completed. If the start operation was successful, the user should be able to establish an SSH connection to their environment. Otherwise, the operation will contain details of the failure.

pub fn value(&self) -> i32

Gets the enum value.

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

Gets the enum value as a string.

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

Creates an enum value from the value name.

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() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for State

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<i32> for State

fn from(value: i32) -> Self

Converts to this type from the input type.

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 Serialize for State

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for State