Class BatchCreateInstanceStatus.Builder (0.44.0)

public static final class BatchCreateInstanceStatus.Builder extends GeneratedMessageV3.Builder<BatchCreateInstanceStatus.Builder> 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:

  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.

Protobuf type google.cloud.alloydb.v1.BatchCreateInstanceStatus

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BatchCreateInstanceStatus.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BatchCreateInstanceStatus.Builder
Overrides

build()

public BatchCreateInstanceStatus build()
Returns
Type Description
BatchCreateInstanceStatus

buildPartial()

public BatchCreateInstanceStatus buildPartial()
Returns
Type Description
BatchCreateInstanceStatus

clear()

public BatchCreateInstanceStatus.Builder clear()
Returns
Type Description
BatchCreateInstanceStatus.Builder
Overrides

clearError()

public BatchCreateInstanceStatus.Builder clearError()

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
BatchCreateInstanceStatus.Builder

clearErrorMsg()

public BatchCreateInstanceStatus.Builder clearErrorMsg()

DEPRECATED - Use the error field instead. Error, if any error occurred and is available, during instance creation.

string error_msg = 2;

Returns
Type Description
BatchCreateInstanceStatus.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BatchCreateInstanceStatus.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BatchCreateInstanceStatus.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public BatchCreateInstanceStatus.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BatchCreateInstanceStatus.Builder
Overrides

clearState()

public BatchCreateInstanceStatus.Builder clearState()

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.

.google.cloud.alloydb.v1.BatchCreateInstanceStatus.State state = 1;

Returns
Type Description
BatchCreateInstanceStatus.Builder

This builder for chaining.

clearType()

public BatchCreateInstanceStatus.Builder clearType()

.google.cloud.alloydb.v1.Instance.InstanceType type = 3;

Returns
Type Description
BatchCreateInstanceStatus.Builder

This builder for chaining.

clone()

public BatchCreateInstanceStatus.Builder clone()
Returns
Type Description
BatchCreateInstanceStatus.Builder
Overrides

getDefaultInstanceForType()

public BatchCreateInstanceStatus getDefaultInstanceForType()
Returns
Type Description
BatchCreateInstanceStatus

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getErrorBuilder()

public Status.Builder getErrorBuilder()

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

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

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:

  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.

.google.cloud.alloydb.v1.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:

  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.

.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
Type Description
Instance.InstanceType

The type.

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeError(Status value)

public BatchCreateInstanceStatus.Builder mergeError(Status value)

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;

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
BatchCreateInstanceStatus.Builder

mergeFrom(BatchCreateInstanceStatus other)

public BatchCreateInstanceStatus.Builder mergeFrom(BatchCreateInstanceStatus other)
Parameter
Name Description
other BatchCreateInstanceStatus
Returns
Type Description
BatchCreateInstanceStatus.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BatchCreateInstanceStatus.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BatchCreateInstanceStatus.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BatchCreateInstanceStatus.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BatchCreateInstanceStatus.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BatchCreateInstanceStatus.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BatchCreateInstanceStatus.Builder
Overrides

setError(Status value)

public BatchCreateInstanceStatus.Builder setError(Status value)

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;

Parameter
Name Description
value com.google.rpc.Status
Returns
Type Description
BatchCreateInstanceStatus.Builder

setError(Status.Builder builderForValue)

public BatchCreateInstanceStatus.Builder setError(Status.Builder builderForValue)

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;

Parameter
Name Description
builderForValue com.google.rpc.Status.Builder
Returns
Type Description
BatchCreateInstanceStatus.Builder

setErrorMsg(String value)

public BatchCreateInstanceStatus.Builder setErrorMsg(String value)

DEPRECATED - Use the error field instead. Error, if any error occurred and is available, during instance creation.

string error_msg = 2;

Parameter
Name Description
value String

The errorMsg to set.

Returns
Type Description
BatchCreateInstanceStatus.Builder

This builder for chaining.

setErrorMsgBytes(ByteString value)

public BatchCreateInstanceStatus.Builder setErrorMsgBytes(ByteString value)

DEPRECATED - Use the error field instead. Error, if any error occurred and is available, during instance creation.

string error_msg = 2;

Parameter
Name Description
value ByteString

The bytes for errorMsg to set.

Returns
Type Description
BatchCreateInstanceStatus.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BatchCreateInstanceStatus.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BatchCreateInstanceStatus.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BatchCreateInstanceStatus.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BatchCreateInstanceStatus.Builder
Overrides

setState(BatchCreateInstanceStatus.State value)

public BatchCreateInstanceStatus.Builder setState(BatchCreateInstanceStatus.State value)

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.

.google.cloud.alloydb.v1.BatchCreateInstanceStatus.State state = 1;

Parameter
Name Description
value BatchCreateInstanceStatus.State

The state to set.

Returns
Type Description
BatchCreateInstanceStatus.Builder

This builder for chaining.

setStateValue(int value)

public BatchCreateInstanceStatus.Builder setStateValue(int value)

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.

.google.cloud.alloydb.v1.BatchCreateInstanceStatus.State state = 1;

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
BatchCreateInstanceStatus.Builder

This builder for chaining.

setType(Instance.InstanceType value)

public BatchCreateInstanceStatus.Builder setType(Instance.InstanceType value)

.google.cloud.alloydb.v1.Instance.InstanceType type = 3;

Parameter
Name Description
value Instance.InstanceType

The type to set.

Returns
Type Description
BatchCreateInstanceStatus.Builder

This builder for chaining.

setTypeValue(int value)

public BatchCreateInstanceStatus.Builder setTypeValue(int value)

.google.cloud.alloydb.v1.Instance.InstanceType type = 3;

Parameter
Name Description
value int

The enum numeric value on the wire for type to set.

Returns
Type Description
BatchCreateInstanceStatus.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BatchCreateInstanceStatus.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BatchCreateInstanceStatus.Builder
Overrides