Class: Google::Cloud::AlloyDB::V1::FailoverInstanceRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/alloydb/v1/service.rb

Overview

Message for triggering failover on an Instance

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ ::String

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



708
709
710
711
 
# File 'proto_docs/google/cloud/alloydb/v1/service.rb', line 708

class FailoverInstanceRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#request_id ⇒ ::String

Returns Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since 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 the original operation with the same request ID was received, and if so, ignores 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since 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 the original operation with the same request ID was received, and if so, ignores 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).



708
709
710
711
 
# File 'proto_docs/google/cloud/alloydb/v1/service.rb', line 708

class FailoverInstanceRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#validate_only ⇒ ::Boolean

Returns Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.

Returns:

  • (::Boolean) —

    Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.



708
709
710
711
 
# File 'proto_docs/google/cloud/alloydb/v1/service.rb', line 708

class FailoverInstanceRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end