Google Cloud Spanner v1 API - Class DirectedReadOptions (5.0.0-beta03) 

public sealed class DirectedReadOptions : IMessage<DirectedReadOptions>, IEquatable<DirectedReadOptions>, IDeepCloneable<DirectedReadOptions>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Spanner v1 API 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.

Inheritance

object > DirectedReadOptions

Namespace

Google.Cloud.Spanner.V1

Assembly

Google.Cloud.Spanner.V1.dll

Constructors

DirectedReadOptions()

public DirectedReadOptions()

DirectedReadOptions(DirectedReadOptions)

public DirectedReadOptions(DirectedReadOptions other)
Parameter
Name Description
other DirectedReadOptions

Properties

ExcludeReplicas

public DirectedReadOptions.Types.ExcludeReplicas ExcludeReplicas { get; set; }

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

Property Value
Type Description
DirectedReadOptionsTypesExcludeReplicas

IncludeReplicas

public DirectedReadOptions.Types.IncludeReplicas IncludeReplicas { get; set; }

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.

Property Value
Type Description
DirectedReadOptionsTypesIncludeReplicas

ReplicasCase

public DirectedReadOptions.ReplicasOneofCase ReplicasCase { get; }
Property Value
Type Description
DirectedReadOptionsReplicasOneofCase