Class: Google::Apis::AlloydbV1::FailoverInstanceRequest

Inherits:

Object

• Object
• Google::Apis::AlloydbV1::FailoverInstanceRequest

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/alloydb_v1/classes.rb,
lib/google/apis/alloydb_v1/representations.rb,
lib/google/apis/alloydb_v1/representations.rb

Overview

Message for triggering failover on an Instance

Instance Attribute Summary

• #request_id ⇒ String

  Optional.

• #validate_only ⇒ Boolean (also: #validate_only?)

  Optional.

Instance Method Summary

• #initialize(**args) ⇒ FailoverInstanceRequest constructor

  A new instance of FailoverInstanceRequest.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ FailoverInstanceRequest

Returns a new instance of FailoverInstanceRequest.

# File 'lib/google/apis/alloydb_v1/classes.rb', line 914

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#request_id ⇒ 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). Corresponds to the JSON property requestId

Returns:

• (String)

# File 'lib/google/apis/alloydb_v1/classes.rb', line 904

def request_id
  @request_id
end

#validate_only ⇒ Boolean Also known as: validate_only?

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

Returns:

• (Boolean)

# File 'lib/google/apis/alloydb_v1/classes.rb', line 911

def validate_only
  @validate_only
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/alloydb_v1/classes.rb', line 919

def update!(**args)
  @request_id = args[:request_id] if args.key?(:request_id)
  @validate_only = args[:validate_only] if args.key?(:validate_only)
end