public final class BatchCreateInstanceStatus extends GeneratedMessageV3 implements BatchCreateInstanceStatusOrBuilderMessage 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.v1alpha.BatchCreateInstanceStatus
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BatchCreateInstanceStatusImplements
BatchCreateInstanceStatusOrBuilderStatic Fields
ERROR_FIELD_NUMBER
public static final int ERROR_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ERROR_MSG_FIELD_NUMBER
public static final int ERROR_MSG_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static BatchCreateInstanceStatus getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
BatchCreateInstanceStatus |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static BatchCreateInstanceStatus.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
BatchCreateInstanceStatus.Builder |
|
newBuilder(BatchCreateInstanceStatus prototype)
public static BatchCreateInstanceStatus.Builder newBuilder(BatchCreateInstanceStatus prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
BatchCreateInstanceStatus |
| Returns | |
|---|---|
| Type | Description |
BatchCreateInstanceStatus.Builder |
|
parseDelimitedFrom(InputStream input)
public static BatchCreateInstanceStatus parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
BatchCreateInstanceStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static BatchCreateInstanceStatus parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BatchCreateInstanceStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static BatchCreateInstanceStatus parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
BatchCreateInstanceStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BatchCreateInstanceStatus parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BatchCreateInstanceStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static BatchCreateInstanceStatus parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
BatchCreateInstanceStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BatchCreateInstanceStatus parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BatchCreateInstanceStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static BatchCreateInstanceStatus parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
BatchCreateInstanceStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BatchCreateInstanceStatus parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BatchCreateInstanceStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static BatchCreateInstanceStatus parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
BatchCreateInstanceStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static BatchCreateInstanceStatus parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BatchCreateInstanceStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static BatchCreateInstanceStatus parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
BatchCreateInstanceStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BatchCreateInstanceStatus parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BatchCreateInstanceStatus |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<BatchCreateInstanceStatus> parser()| Returns | |
|---|---|
| Type | Description |
Parser<BatchCreateInstanceStatus> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public BatchCreateInstanceStatus getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
BatchCreateInstanceStatus |
|
getError()
public Status 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 | |
|---|---|
| Type | Description |
Parser<BatchCreateInstanceStatus> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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.v1alpha.BatchCreateInstanceStatus.State state = 1;
| Returns | |
|---|---|
| Type | Description |
BatchCreateInstanceStatus.State |
The state. |
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.v1alpha.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.v1alpha.Instance.InstanceType type = 3;
| Returns | |
|---|---|
| Type | Description |
Instance.InstanceType |
The type. |
getTypeValue()
public int getTypeValue().google.cloud.alloydb.v1alpha.Instance.InstanceType type = 3;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for type. |
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()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public BatchCreateInstanceStatus.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
BatchCreateInstanceStatus.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BatchCreateInstanceStatus.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
BatchCreateInstanceStatus.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public BatchCreateInstanceStatus.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
BatchCreateInstanceStatus.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|