AlloyDB V1BETA API - Class Google::Cloud::AlloyDB::V1beta::FailoverInstanceRequest (v0.3.0)

Reference documentation and code samples for the AlloyDB V1BETA API class Google::Cloud::AlloyDB::V1beta::FailoverInstanceRequest.

Message for triggering failover on an Instance

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#name

def name() -> ::String
Returns
  • (::String) — Required. The name of the resource. For the required format, see the comment on the Instance.name field.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the resource. For the required format, see the comment on the Instance.name field.
Returns
  • (::String) — Required. The name of the resource. For the required format, see the comment on the Instance.name field.

#request_id

def request_id() -> ::String
Returns
  • (::String) — 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).

#request_id=

def request_id=(value) -> ::String
Parameter
  • value (::String) — 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).

Returns
  • (::String) — 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).

#validate_only

def validate_only() -> ::Boolean
Returns
  • (::Boolean) — Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the failover.

#validate_only=

def validate_only=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the failover.
Returns
  • (::Boolean) — Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the failover.