Class: Google::Cloud::Redis::V1::FailoverInstanceRequest

Inherits:

Object

Object
Google::Cloud::Redis::V1::FailoverInstanceRequest

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/redis/v1/cloud_redis.rb

Overview

Request for Failover.

Defined Under Namespace

Modules: DataProtectionMode

Instance Attribute Summary collapse

#data_protection_mode ⇒ ::Google::Cloud::Redis::V1::FailoverInstanceRequest::DataProtectionMode
Optional.
#name ⇒ ::String
Required.

Instance Attribute Details

#data_protection_mode ⇒ `::Google::Cloud::Redis::V1::FailoverInstanceRequest::DataProtectionMode`

Returns Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default.

Returns:

(::Google::Cloud::Redis::V1::FailoverInstanceRequest::DataProtectionMode) —
Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default.

# File 'proto_docs/google/cloud/redis/v1/cloud_redis.rb', line 730

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

  # Specifies different modes of operation in relation to the data retention.
  module DataProtectionMode
    # Defaults to LIMITED_DATA_LOSS if a data protection mode is not
    # specified.
    DATA_PROTECTION_MODE_UNSPECIFIED = 0

    # Instance failover will be protected with data loss control. More
    # specifically, the failover will only be performed if the current
    # replication offset diff between primary and replica is under a certain
    # threshold.
    LIMITED_DATA_LOSS = 1

    # Instance failover will be performed without data loss control.
    FORCE_DATA_LOSS = 2
  end
end

#name ⇒ `::String`

Returns Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.