Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::DirectedReadOptions (v1.9.1)

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.

    Note: The following fields are mutually exclusive: exclude_replicas, include_replicas. If a field in that set is populated, all other fields in the set will automatically be cleared.

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

    Note: The following fields are mutually exclusive: exclude_replicas, include_replicas. If a field in that set is populated, all other fields in the set will automatically be cleared.

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.

    Note: The following fields are mutually exclusive: exclude_replicas, include_replicas. If a field in that set is populated, all other fields in the set will automatically be cleared.

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

    Note: The following fields are mutually exclusive: include_replicas, exclude_replicas. If a field in that set is populated, all other fields in the set will automatically be cleared.

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

    Note: The following fields are mutually exclusive: include_replicas, exclude_replicas. If a field in that set is populated, all other fields in the set will automatically be cleared.

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.

    Note: The following fields are mutually exclusive: include_replicas, exclude_replicas. If a field in that set is populated, all other fields in the set will automatically be cleared.