Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::DirectedReadOptions (v0.27.0)

Version 0.27.0

• 1.5.0 (latest)
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.2
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.2
• 0.21.0
• 0.20.1
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.1
• 0.14.1
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.1
• 0.7.4

Reference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::DirectedReadOptions.

The DirectedReadOptions can be used to indicate which replicas or regions should be used for non-transactional reads or queries.

DirectedReadOptions may only be specified for a read-only transaction, otherwise the API will return an INVALID_ARGUMENT error.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#exclude_replicas

def exclude_replicas() -> ::Google::Cloud::Spanner::V1::DirectedReadOptions::ExcludeReplicas

Returns

• (::Google::Cloud::Spanner::V1::DirectedReadOptions::ExcludeReplicas) — Exclude_replicas indicates that specified replicas should be excluded from serving requests. Spanner will not route requests to the replicas in this list.

#exclude_replicas=

def exclude_replicas=(value) -> ::Google::Cloud::Spanner::V1::DirectedReadOptions::ExcludeReplicas

Parameter

• value (::Google::Cloud::Spanner::V1::DirectedReadOptions::ExcludeReplicas) — Exclude_replicas indicates that specified replicas should be excluded from serving requests. Spanner will not route requests to the replicas in this list.

Returns

• (::Google::Cloud::Spanner::V1::DirectedReadOptions::ExcludeReplicas) — Exclude_replicas indicates that specified replicas should be excluded from serving requests. Spanner will not route requests to the replicas in this list.

#include_replicas

def include_replicas() -> ::Google::Cloud::Spanner::V1::DirectedReadOptions::IncludeReplicas

Returns

• (::Google::Cloud::Spanner::V1::DirectedReadOptions::IncludeReplicas) — Include_replicas indicates the order of replicas (as they appear in this list) to process the request. If auto_failover_disabled is set to true and all replicas are exhausted without finding a healthy replica, Spanner will wait for a replica in the list to become available, requests may fail due to DEADLINE_EXCEEDED errors.

#include_replicas=

def include_replicas=(value) -> ::Google::Cloud::Spanner::V1::DirectedReadOptions::IncludeReplicas

Parameter

• value (::Google::Cloud::Spanner::V1::DirectedReadOptions::IncludeReplicas) — Include_replicas indicates the order of replicas (as they appear in this list) to process the request. If auto_failover_disabled is set to true and all replicas are exhausted without finding a healthy replica, Spanner will wait for a replica in the list to become available, requests may fail due to DEADLINE_EXCEEDED errors.

Returns

• (::Google::Cloud::Spanner::V1::DirectedReadOptions::IncludeReplicas) — Include_replicas indicates the order of replicas (as they appear in this list) to process the request. If auto_failover_disabled is set to true and all replicas are exhausted without finding a healthy replica, Spanner will wait for a replica in the list to become available, requests may fail due to DEADLINE_EXCEEDED errors.