Cloud Spanner V1 Client - Class DirectedReadOptions (1.106.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class DirectedReadOptions.

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

DirectedReadOptions can only be specified for a read-only transaction, otherwise the API returns an INVALID_ARGUMENT error.

Generated from protobuf message google.spanner.v1.DirectedReadOptions

Namespace

Google \ Cloud \ Spanner \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ include_replicas 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 waits for a replica in the list to become available, requests might fail due to DEADLINE_EXCEEDED errors.
↳ exclude_replicas DirectedReadOptions\ExcludeReplicas

Exclude_replicas indicates that specified replicas should be excluded from serving requests. Spanner doesn't route requests to the replicas in this list.

getIncludeReplicas

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 waits for a replica in the list to become available, requests might fail due to DEADLINE_EXCEEDED errors.

Returns
Type Description
DirectedReadOptions\IncludeReplicas|null

hasIncludeReplicas

setIncludeReplicas

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 waits for a replica in the list to become available, requests might fail due to DEADLINE_EXCEEDED errors.

Parameter
Name Description
var DirectedReadOptions\IncludeReplicas
Returns
Type Description
$this

getExcludeReplicas

Exclude_replicas indicates that specified replicas should be excluded from serving requests. Spanner doesn't route requests to the replicas in this list.

Returns
Type Description
DirectedReadOptions\ExcludeReplicas|null

hasExcludeReplicas

setExcludeReplicas

Exclude_replicas indicates that specified replicas should be excluded from serving requests. Spanner doesn't route requests to the replicas in this list.

Parameter
Name Description
var DirectedReadOptions\ExcludeReplicas
Returns
Type Description
$this

getReplicas

Returns
Type Description
string