Struct BatchCreateInstanceStatus 

#[non_exhaustive]
pub struct BatchCreateInstanceStatus {
    pub state: State,
    pub error_msg: String,
    pub error: Option<Status>,
    pub type: InstanceType,
    /* private fields */
}

Message for current status of an instance in the BatchCreateInstances operation. For example, lets say a BatchCreateInstances workflow has 4 instances, Instance1 through Instance4. Lets also assume that 2 instances succeeded but the third failed to create and the 4th was never picked up for creation because of failure of the previous one. Then, resulting states would look something like:

1. Instance1 = ROLLED_BACK
2. Instance2 = ROLLED_BACK
3. Instance3 = FAILED
4. Instance4 = FAILED

However, while the operation is running, the instance might be in other states including PENDING_CREATE, ACTIVE, DELETING and CREATING. The states / do not get further updated once the operation is done.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

state: State

The current state of an instance involved in the batch create operation. Once the operation is complete, the final state of the instances in the LRO can be one of:

1. ACTIVE, indicating that instances were created successfully
2. FAILED, indicating that a particular instance failed creation
3. ROLLED_BACK indicating that although the instance was created successfully, it had to be rolled back and deleted due to failure in other steps of the workflow.

error_msg: String

DEPRECATED - Use the error field instead. Error, if any error occurred and is available, during instance creation.

error: Option<Status>

The RPC status of the instance creation operation. This field will be present if an error happened during the instance creation.

type: InstanceType

Implementations

impl BatchCreateInstanceStatus

pub fn new() -> Self

pub fn set_state<T: Into<State>>(self, v: T) -> Self

Sets the value of state.

Example

use google_cloud_alloydb_v1::model::batch_create_instance_status::State;
let x0 = BatchCreateInstanceStatus::new().set_state(State::PendingCreate);
let x1 = BatchCreateInstanceStatus::new().set_state(State::Ready);
let x2 = BatchCreateInstanceStatus::new().set_state(State::Creating);

pub fn set_error_msg<T: Into<String>>(self, v: T) -> Self

Sets the value of error_msg.

Example

let x = BatchCreateInstanceStatus::new().set_error_msg("example");

pub fn set_error<T>(self, v: T) -> Self

where T: Into<Status>,

Sets the value of error.

Example

use google_cloud_rpc::model::Status;
let x = BatchCreateInstanceStatus::new().set_error(Status::default()/* use setters */);

pub fn set_or_clear_error<T>(self, v: Option<T>) -> Self

where T: Into<Status>,

Sets or clears the value of error.

Example

use google_cloud_rpc::model::Status;
let x = BatchCreateInstanceStatus::new().set_or_clear_error(Some(Status::default()/* use setters */));
let x = BatchCreateInstanceStatus::new().set_or_clear_error(None::<Status>);

pub fn set_type<T: Into<InstanceType>>(self, v: T) -> Self

Sets the value of r#type.

Example

use google_cloud_alloydb_v1::model::instance::InstanceType;
let x0 = BatchCreateInstanceStatus::new().set_type(InstanceType::Primary);
let x1 = BatchCreateInstanceStatus::new().set_type(InstanceType::ReadPool);
let x2 = BatchCreateInstanceStatus::new().set_type(InstanceType::Secondary);

Trait Implementations

impl Clone for BatchCreateInstanceStatus

fn clone(&self) -> BatchCreateInstanceStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchCreateInstanceStatus

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

Formats the value using the given formatter.

impl Default for BatchCreateInstanceStatus

fn default() -> BatchCreateInstanceStatus

Returns the “default value” for a type.

impl Message for BatchCreateInstanceStatus

fn typename() -> &'static str

The typename of this message.

impl PartialEq for BatchCreateInstanceStatus

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