AlloyDB v1 API - Class BatchCreateInstanceStatus (1.6.0)

public sealed class BatchCreateInstanceStatus : IMessage<BatchCreateInstanceStatus>, IEquatable<BatchCreateInstanceStatus>, IDeepCloneable<BatchCreateInstanceStatus>, IBufferMessage, IMessage

Reference documentation and code samples for the AlloyDB v1 API class 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:

  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.

Inheritance

object > BatchCreateInstanceStatus

Namespace

Google.Cloud.AlloyDb.V1

Assembly

Google.Cloud.AlloyDb.V1.dll

Constructors

BatchCreateInstanceStatus()

public BatchCreateInstanceStatus()

BatchCreateInstanceStatus(BatchCreateInstanceStatus)

public BatchCreateInstanceStatus(BatchCreateInstanceStatus other)
Parameter
NameDescription
otherBatchCreateInstanceStatus

Properties

Error

public Status Error { get; set; }

The RPC status of the instance creation operation. This field will be present if an error happened during the instance creation.

Property Value
TypeDescription
Status

ErrorMsg

public string ErrorMsg { get; set; }

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

Property Value
TypeDescription
string

State

public BatchCreateInstanceStatus.Types.State State { get; set; }

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.
Property Value
TypeDescription
BatchCreateInstanceStatusTypesState

Type

public Instance.Types.InstanceType Type { get; set; }
Property Value
TypeDescription
InstanceTypesInstanceType