Class: Google::Cloud::AlloyDB::V1beta::BatchCreateInstanceStatus

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/alloydb/v1beta/service.rb

Overview

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.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#error ⇒ ::Google::Rpc::Status

Returns 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.



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
 
# File 'proto_docs/google/cloud/alloydb/v1beta/service.rb', line 918

class BatchCreateInstanceStatus
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State contains all valid instance states for the BatchCreateInstances
  # operation. This is mainly used for status reporting through the LRO
  # metadata.
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # Instance is pending creation and has not yet been picked up for
    # processing in the backend.
    PENDING_CREATE = 1

    # The instance is active and running.
    READY = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance or a batch of instances.
    FAILED = 5

    # The instance was created successfully, but was rolled back and deleted
    # due to some other failure during BatchCreateInstances operation.
    ROLLED_BACK = 6
  end
end

#error_msg ⇒ ::String

Returns 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.



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
 
# File 'proto_docs/google/cloud/alloydb/v1beta/service.rb', line 918

class BatchCreateInstanceStatus
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State contains all valid instance states for the BatchCreateInstances
  # operation. This is mainly used for status reporting through the LRO
  # metadata.
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # Instance is pending creation and has not yet been picked up for
    # processing in the backend.
    PENDING_CREATE = 1

    # The instance is active and running.
    READY = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance or a batch of instances.
    FAILED = 5

    # The instance was created successfully, but was rolled back and deleted
    # due to some other failure during BatchCreateInstances operation.
    ROLLED_BACK = 6
  end
end

#state ⇒ ::Google::Cloud::AlloyDB::V1beta::BatchCreateInstanceStatus::State

Returns 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.


918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
 
# File 'proto_docs/google/cloud/alloydb/v1beta/service.rb', line 918

class BatchCreateInstanceStatus
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State contains all valid instance states for the BatchCreateInstances
  # operation. This is mainly used for status reporting through the LRO
  # metadata.
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # Instance is pending creation and has not yet been picked up for
    # processing in the backend.
    PENDING_CREATE = 1

    # The instance is active and running.
    READY = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance or a batch of instances.
    FAILED = 5

    # The instance was created successfully, but was rolled back and deleted
    # due to some other failure during BatchCreateInstances operation.
    ROLLED_BACK = 6
  end
end

#type ⇒ ::Google::Cloud::AlloyDB::V1beta::Instance::InstanceType

Returns:



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
 
# File 'proto_docs/google/cloud/alloydb/v1beta/service.rb', line 918

class BatchCreateInstanceStatus
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # State contains all valid instance states for the BatchCreateInstances
  # operation. This is mainly used for status reporting through the LRO
  # metadata.
  module State
    # The state of the instance is unknown.
    STATE_UNSPECIFIED = 0

    # Instance is pending creation and has not yet been picked up for
    # processing in the backend.
    PENDING_CREATE = 1

    # The instance is active and running.
    READY = 2

    # The instance is being created.
    CREATING = 3

    # The instance is being deleted.
    DELETING = 4

    # The creation of the instance failed or a fatal error occurred during
    # an operation on the instance or a batch of instances.
    FAILED = 5

    # The instance was created successfully, but was rolled back and deleted
    # due to some other failure during BatchCreateInstances operation.
    ROLLED_BACK = 6
  end
end