Cloud Spanner V1 Client - Class DirectedReadOptions (1.76.0)

Version 1.76.0

• 1.80.0 (latest)
• 1.79.0
• 1.78.0
• 1.77.0
• 1.76.1
• 1.68.0
• 1.67.0
• 1.66.0
• 1.65.0
• 1.64.0
• 1.63.2
• 1.62.1
• 1.61.0
• 1.60.0
• 1.59.0
• 1.58.4
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.2

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 may only be specified for a read-only transaction, otherwise the API will return 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	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.
↳ exclude_replicas	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.

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

Returns
Type	Description
Google\Cloud\Spanner\V1\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 will wait for a replica in the list to become available, requests may fail due to DEADLINE_EXCEEDED errors.

Parameter
Name	Description
var	Google\Cloud\Spanner\V1\DirectedReadOptions\IncludeReplicas

Returns
Type	Description
$this

getExcludeReplicas

Exclude_replicas indicates that specified replicas should be excluded from serving requests. Spanner will not route requests to the replicas in this list.

Returns
Type	Description
Google\Cloud\Spanner\V1\DirectedReadOptions\ExcludeReplicas|null

hasExcludeReplicas

setExcludeReplicas

Exclude_replicas indicates that specified replicas should be excluded from serving requests. Spanner will not route requests to the replicas in this list.

Parameter
Name	Description
var	Google\Cloud\Spanner\V1\DirectedReadOptions\ExcludeReplicas

Returns
Type	Description
$this

getReplicas

Returns
Type	Description
string