AlloyDB V1BETA API - Class Google::Cloud::AlloyDB::V1beta::BatchCreateInstanceStatus (v0.6.2)

Reference documentation and code samples for the AlloyDB V1BETA API class Google::Cloud::AlloyDB::V1beta::BatchCreateInstanceStatus.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#error

def error() -> ::Google::Rpc::Status
Returns
  • (::Google::Rpc::Status) — The RPC status of the instance creation operation. This field will be present if an error happened during the instance creation.

#error=

def error=(value) -> ::Google::Rpc::Status
Parameter
  • value (::Google::Rpc::Status) — The RPC status of the instance creation operation. This field will be present if an error happened during the instance creation.
Returns
  • (::Google::Rpc::Status) — The RPC status of the instance creation operation. This field will be present if an error happened during the instance creation.

#error_msg

def error_msg() -> ::String
Returns
  • (::String) — DEPRECATED - Use the error field instead. Error, if any error occurred and is available, during instance creation.

#error_msg=

def error_msg=(value) -> ::String
Parameter
  • value (::String) — DEPRECATED - Use the error field instead. Error, if any error occurred and is available, during instance creation.
Returns
  • (::String) — DEPRECATED - Use the error field instead. Error, if any error occurred and is available, during instance creation.

#state

def state() -> ::Google::Cloud::AlloyDB::V1beta::BatchCreateInstanceStatus::State
Returns
  • (::Google::Cloud::AlloyDB::V1beta::BatchCreateInstanceStatus::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.

#state=

def state=(value) -> ::Google::Cloud::AlloyDB::V1beta::BatchCreateInstanceStatus::State
Parameter
  • value (::Google::Cloud::AlloyDB::V1beta::BatchCreateInstanceStatus::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.
Returns
  • (::Google::Cloud::AlloyDB::V1beta::BatchCreateInstanceStatus::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.

#type

def type() -> ::Google::Cloud::AlloyDB::V1beta::Instance::InstanceType
Returns

#type=

def type=(value) -> ::Google::Cloud::AlloyDB::V1beta::Instance::InstanceType
Parameter
Returns