Enum State 

#[non_exhaustive]
pub enum State {
    Unspecified,
    Creating,
    Active,
    ApplyingConfig,
    Error,
    Failed,
    Deleting,
    UnknownValue(UnknownValue),
}

State represents the state of the plugin instance.

Working with unknown values

This enum is defined as #[non_exhaustive] because Google Cloud may add additional enum variants at any time. Adding new variants is not considered a breaking change. Applications should write their code in anticipation of:

• New values appearing in future releases of the client library, and
• New values received dynamically, without application changes.

Please consult the Working with enums section in the user guide for some guidelines.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unspecified

Default unspecified state.

Creating

The plugin instance is being created.

Active

The plugin instance is active and ready for executions. This is the only state where executions can run on the plugin instance.

ApplyingConfig

The updated config that contains additional_config and auth_config is being applied.

Error

The ERROR state can come while applying config. Users can retrigger [ApplyPluginInstanceConfig][google.cloud.apihub.v1.ApiHubPlugin.ApplyPluginInstanceConfig] to restore the plugin instance back to active state. Note, In case the ERROR state happens while applying config (auth_config, additional_config), the plugin instance will reflect the config which was trying to be applied while error happened. In order to overwrite, trigger ApplyConfig with a new config.

Failed

The plugin instance is in a failed state. This indicates that an unrecoverable error occurred during a previous operation (Create, Delete).

Deleting

The plugin instance is being deleted. Delete is only possible if there is no other operation running on the plugin instance and plugin instance action.

UnknownValue(UnknownValue)

If set, the enum was initialized with an unknown value.

Applications can examine the value using State::value or State::name.

Implementations

impl State

pub fn value(&self) -> Option<i32>

Gets the enum value.

Returns None if the enum contains an unknown value deserialized from the string representation of enums.

pub fn name(&self) -> Option<&str>

Gets the enum value as a string.

Returns None if the enum contains an unknown value deserialized from the integer representation of enums.

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a duplicate 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 Display for State

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

Formats the value using the given formatter.

impl From<&str> for State

fn from(value: &str) -> Self

Converts to this type from the input type.

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