Class: Google::Cloud::Spanner::V1::DirectedReadOptions::ReplicaSelection

Inherits:

Object

Object
Google::Cloud::Spanner::V1::DirectedReadOptions::ReplicaSelection

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/spanner/v1/spanner.rb

Overview

The directed read replica selector. Callers must provide one or more of the following fields for replica selection:

location - The location must be one of the regions within the multi-region configuration of your database.
type - The type of the replica.

Some examples of using replica_selectors are:

location:us-east1 --> The "us-east1" replica(s) of any available type will be used to process the request.
type:READ_ONLY --> The "READ_ONLY" type replica(s) in nearest available location will be used to process the request.
location:us-east1 type:READ_ONLY --> The "READ_ONLY" type replica(s) in location "us-east1" will be used to process the request.

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

#location ⇒ ::String
The location or region of the serving requests, e.g.
#type ⇒ ::Google::Cloud::Spanner::V1::DirectedReadOptions::ReplicaSelection::Type
The type of replica.

Instance Attribute Details

#location ⇒ `::String`

Returns The location or region of the serving requests, e.g. "us-east1".

Returns:

(::String) —
The location or region of the serving requests, e.g. "us-east1".

# File 'proto_docs/google/spanner/v1/spanner.rb', line 287

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

  # Indicates the type of replica.
  module Type
    # Not specified.
    TYPE_UNSPECIFIED = 0

    # Read-write replicas support both reads and writes.
    READ_WRITE = 1

    # Read-only replicas only support reads (not writes).
    READ_ONLY = 2
  end
end

#type ⇒ `::Google::Cloud::Spanner::V1::DirectedReadOptions::ReplicaSelection::Type`

Returns The type of replica.