Reference documentation and code samples for the AlloyDB V1ALPHA API class Google::Cloud::AlloyDB::V1alpha::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:
Instance1 = ROLLED_BACK
Instance2 = ROLLED_BACK
Instance3 = FAILED
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
deferror()->::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=
deferror=(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
deferror_msg()->::String
Returns
(::String) — DEPRECATED - Use the error field instead.
Error, if any error occurred and is available, during instance creation.
#error_msg=
deferror_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.
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:
ACTIVE, indicating that instances were created successfully
FAILED, indicating that a particular instance failed creation
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.
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:
ACTIVE, indicating that instances were created successfully
FAILED, indicating that a particular instance failed creation
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.
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:
ACTIVE, indicating that instances were created successfully
FAILED, indicating that a particular instance failed creation
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# AlloyDB V1ALPHA API - Class Google::Cloud::AlloyDB::V1alpha::BatchCreateInstanceStatus (v0.14.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.14.1 (latest)](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/latest/Google-Cloud-AlloyDB-V1alpha-BatchCreateInstanceStatus)\n- [0.14.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.14.0/Google-Cloud-AlloyDB-V1alpha-BatchCreateInstanceStatus)\n- [0.13.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.13.0/Google-Cloud-AlloyDB-V1alpha-BatchCreateInstanceStatus)\n- [0.12.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.12.0/Google-Cloud-AlloyDB-V1alpha-BatchCreateInstanceStatus)\n- [0.11.1](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.11.1/Google-Cloud-AlloyDB-V1alpha-BatchCreateInstanceStatus)\n- [0.10.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.10.0/Google-Cloud-AlloyDB-V1alpha-BatchCreateInstanceStatus)\n- [0.9.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.9.0/Google-Cloud-AlloyDB-V1alpha-BatchCreateInstanceStatus)\n- [0.8.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.8.0/Google-Cloud-AlloyDB-V1alpha-BatchCreateInstanceStatus)\n- [0.7.2](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.7.2/Google-Cloud-AlloyDB-V1alpha-BatchCreateInstanceStatus)\n- [0.6.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.6.0/Google-Cloud-AlloyDB-V1alpha-BatchCreateInstanceStatus)\n- [0.5.2](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.5.2/Google-Cloud-AlloyDB-V1alpha-BatchCreateInstanceStatus)\n- [0.4.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.4.0/Google-Cloud-AlloyDB-V1alpha-BatchCreateInstanceStatus)\n- [0.3.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.3.0/Google-Cloud-AlloyDB-V1alpha-BatchCreateInstanceStatus)\n- [0.2.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.2.0/Google-Cloud-AlloyDB-V1alpha-BatchCreateInstanceStatus)\n- [0.1.0](/ruby/docs/reference/google-cloud-alloy_db-v1alpha/0.1.0/Google-Cloud-AlloyDB-V1alpha-BatchCreateInstanceStatus) \nReference documentation and code samples for the AlloyDB V1ALPHA API class Google::Cloud::AlloyDB::V1alpha::BatchCreateInstanceStatus.\n\nMessage for current status of an instance in the BatchCreateInstances\noperation.\nFor example, lets say a BatchCreateInstances workflow has 4 instances,\nInstance1 through Instance4. Lets also assume that 2 instances succeeded\nbut the third failed to create and the 4th was never picked up for creation\nbecause of failure of the previous one. Then, resulting states would look\nsomething like:\n\n\n1. Instance1 = ROLLED_BACK\n2. Instance2 = ROLLED_BACK\n3. Instance3 = FAILED\n4. Instance4 = FAILED\n\n\u003cbr /\u003e\n\nHowever, while the operation is running, the instance might be in other\nstates including PENDING_CREATE, ACTIVE, DELETING and CREATING. The states\n/ do not get further updated once the operation is done. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #error\n\n def error() -\u003e ::Google::Rpc::Status\n\n**Returns**\n\n- ([::Google::Rpc::Status](./Google-Rpc-Status)) --- The RPC status of the instance creation operation. This field will be present if an error happened during the instance creation.\n\n### #error=\n\n def error=(value) -\u003e ::Google::Rpc::Status\n\n**Parameter**\n\n- **value** ([::Google::Rpc::Status](./Google-Rpc-Status)) --- The RPC status of the instance creation operation. This field will be present if an error happened during the instance creation. \n**Returns**\n\n- ([::Google::Rpc::Status](./Google-Rpc-Status)) --- The RPC status of the instance creation operation. This field will be present if an error happened during the instance creation.\n\n### #error_msg\n\n def error_msg() -\u003e ::String\n\n**Returns**\n\n- (::String) --- DEPRECATED - Use the error field instead. Error, if any error occurred and is available, during instance creation.\n\n### #error_msg=\n\n def error_msg=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- DEPRECATED - Use the error field instead. Error, if any error occurred and is available, during instance creation. \n**Returns**\n\n- (::String) --- DEPRECATED - Use the error field instead. Error, if any error occurred and is available, during instance creation.\n\n### #state\n\n def state() -\u003e ::Google::Cloud::AlloyDB::V1alpha::BatchCreateInstanceStatus::State\n\n**Returns**\n\n- ([::Google::Cloud::AlloyDB::V1alpha::BatchCreateInstanceStatus::State](./Google-Cloud-AlloyDB-V1alpha-BatchCreateInstanceStatus-State)) ---\n\n The current state of an instance involved in the batch create operation.\n Once the operation is complete, the final state of the instances in the\n LRO can be one of:\n 1. ACTIVE, indicating that instances were created successfully\n 2. FAILED, indicating that a particular instance failed creation\n 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.\n\n### #state=\n\n def state=(value) -\u003e ::Google::Cloud::AlloyDB::V1alpha::BatchCreateInstanceStatus::State\n\n**Parameter**\n\n- **value** ([::Google::Cloud::AlloyDB::V1alpha::BatchCreateInstanceStatus::State](./Google-Cloud-AlloyDB-V1alpha-BatchCreateInstanceStatus-State)) ---\n\n The current state of an instance involved in the batch create operation.\n Once the operation is complete, the final state of the instances in the\n LRO can be one of:\n 1. ACTIVE, indicating that instances were created successfully\n 2. FAILED, indicating that a particular instance failed creation\n3. 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. \n**Returns**\n\n- ([::Google::Cloud::AlloyDB::V1alpha::BatchCreateInstanceStatus::State](./Google-Cloud-AlloyDB-V1alpha-BatchCreateInstanceStatus-State)) ---\n\n The current state of an instance involved in the batch create operation.\n Once the operation is complete, the final state of the instances in the\n LRO can be one of:\n 1. ACTIVE, indicating that instances were created successfully\n 2. FAILED, indicating that a particular instance failed creation\n 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.\n\n### #type\n\n def type() -\u003e ::Google::Cloud::AlloyDB::V1alpha::Instance::InstanceType\n\n**Returns**\n\n- ([::Google::Cloud::AlloyDB::V1alpha::Instance::InstanceType](./Google-Cloud-AlloyDB-V1alpha-Instance-InstanceType))\n\n### #type=\n\n def type=(value) -\u003e ::Google::Cloud::AlloyDB::V1alpha::Instance::InstanceType\n\n**Parameter**\n\n- **value** ([::Google::Cloud::AlloyDB::V1alpha::Instance::InstanceType](./Google-Cloud-AlloyDB-V1alpha-Instance-InstanceType)) \n**Returns**\n\n- ([::Google::Cloud::AlloyDB::V1alpha::Instance::InstanceType](./Google-Cloud-AlloyDB-V1alpha-Instance-InstanceType))"]]
