Cloud Spanner V1 Client - Class IncludeReplicas (1.82.0)

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

An IncludeReplicas contains a repeated set of ReplicaSelection which indicates the order in which replicas should be considered.

Generated from protobuf message google.spanner.v1.DirectedReadOptions.IncludeReplicas

Namespace

Google \ Cloud \ Spanner \ V1 \ DirectedReadOptions

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ replica_selections array<Google\Cloud\Spanner\V1\DirectedReadOptions\ReplicaSelection>

The directed read replica selector.

↳ auto_failover_disabled bool

If true, Spanner will not route requests to a replica outside the include_replicas list when all of the specified replicas are unavailable or unhealthy. Default value is false.

getReplicaSelections

The directed read replica selector.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setReplicaSelections

The directed read replica selector.

Parameter
Name Description
var array<Google\Cloud\Spanner\V1\DirectedReadOptions\ReplicaSelection>
Returns
Type Description
$this

getAutoFailoverDisabled

If true, Spanner will not route requests to a replica outside the include_replicas list when all of the specified replicas are unavailable or unhealthy. Default value is false.

Returns
Type Description
bool

setAutoFailoverDisabled

If true, Spanner will not route requests to a replica outside the include_replicas list when all of the specified replicas are unavailable or unhealthy. Default value is false.

Parameter
Name Description
var bool
Returns
Type Description
$this