AlloyDB v1alpha API - Class FailoverInstanceRequest (1.0.0-alpha06)

Version 1.0.0-alpha06

• 1.0.0-alpha10 (latest)
• 1.0.0-alpha09

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

Reference documentation and code samples for the AlloyDB v1alpha API class FailoverInstanceRequest.

Message for triggering failover on an Instance

Inheritance

object > FailoverInstanceRequest

Implements

IMessageFailoverInstanceRequest, IEquatableFailoverInstanceRequest, IDeepCloneableFailoverInstanceRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AlloyDb.V1Alpha

Assembly

Google.Cloud.AlloyDb.V1Alpha.dll

Constructors

FailoverInstanceRequest()

public FailoverInstanceRequest()

FailoverInstanceRequest(FailoverInstanceRequest)

public FailoverInstanceRequest(FailoverInstanceRequest other)

Parameter
Name	Description
other	FailoverInstanceRequest

Properties

InstanceName

public InstanceName InstanceName { get; set; }

InstanceName-typed view over the Name resource name property.

Property Value
Type	Description
InstanceName

Name

public string Name { get; set; }

Required. The name of the resource. For the required format, see the comment on the Instance.name field.

Property Value
Type	Description
string

RequestId

public string RequestId { get; set; }

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Property Value
Type	Description
string

ValidateOnly

public bool ValidateOnly { get; set; }

Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the failover.

Property Value
Type	Description
bool