public final class BatchCreateInstanceStatus extends GeneratedMessageV3 implements BatchCreateInstanceStatusOrBuilder
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.
Protobuf type google.cloud.alloydb.v1.BatchCreateInstanceStatus
Static Fields
ERROR_FIELD_NUMBER
public static final int ERROR_FIELD_NUMBER
Field Value
ERROR_MSG_FIELD_NUMBER
public static final int ERROR_MSG_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static BatchCreateInstanceStatus getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static BatchCreateInstanceStatus.Builder newBuilder()
Returns
newBuilder(BatchCreateInstanceStatus prototype)
public static BatchCreateInstanceStatus.Builder newBuilder(BatchCreateInstanceStatus prototype)
Parameter
Returns
public static BatchCreateInstanceStatus parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static BatchCreateInstanceStatus parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static BatchCreateInstanceStatus parseFrom(byte[] data)
Parameter
Name |
Description |
data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BatchCreateInstanceStatus parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static BatchCreateInstanceStatus parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchCreateInstanceStatus parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static BatchCreateInstanceStatus parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static BatchCreateInstanceStatus parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static BatchCreateInstanceStatus parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static BatchCreateInstanceStatus parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static BatchCreateInstanceStatus parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BatchCreateInstanceStatus parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<BatchCreateInstanceStatus> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public BatchCreateInstanceStatus getDefaultInstanceForType()
Returns
getError()
The RPC status of the instance creation operation. This field will be
present if an error happened during the instance creation.
.google.rpc.Status error = 4;
Returns
Type |
Description |
com.google.rpc.Status |
The error.
|
getErrorMsg()
public String getErrorMsg()
DEPRECATED - Use the error field instead.
Error, if any error occurred and is available, during instance creation.
string error_msg = 2;
Returns
Type |
Description |
String |
The errorMsg.
|
getErrorMsgBytes()
public ByteString getErrorMsgBytes()
DEPRECATED - Use the error field instead.
Error, if any error occurred and is available, during instance creation.
string error_msg = 2;
Returns
Type |
Description |
ByteString |
The bytes for errorMsg.
|
getErrorOrBuilder()
public StatusOrBuilder getErrorOrBuilder()
The RPC status of the instance creation operation. This field will be
present if an error happened during the instance creation.
.google.rpc.Status error = 4;
Returns
Type |
Description |
com.google.rpc.StatusOrBuilder |
|
getParserForType()
public Parser<BatchCreateInstanceStatus> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getState()
public BatchCreateInstanceStatus.State getState()
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.
.google.cloud.alloydb.v1.BatchCreateInstanceStatus.State state = 1;
Returns
getStateValue()
public int getStateValue()
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.
.google.cloud.alloydb.v1.BatchCreateInstanceStatus.State state = 1;
Returns
Type |
Description |
int |
The enum numeric value on the wire for state.
|
getType()
public Instance.InstanceType getType()
.google.cloud.alloydb.v1.Instance.InstanceType type = 3;
Returns
getTypeValue()
public int getTypeValue()
.google.cloud.alloydb.v1.Instance.InstanceType type = 3;
Returns
Type |
Description |
int |
The enum numeric value on the wire for type.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasError()
public boolean hasError()
The RPC status of the instance creation operation. This field will be
present if an error happened during the instance creation.
.google.rpc.Status error = 4;
Returns
Type |
Description |
boolean |
Whether the error field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public BatchCreateInstanceStatus.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BatchCreateInstanceStatus.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public BatchCreateInstanceStatus.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions