Send feedback
Class DirectedReadOptions (6.56.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 6.56.0keyboard_arrow_down
public final class DirectedReadOptions extends GeneratedMessageV3 implements DirectedReadOptionsOrBuilder
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.
Protobuf type google.spanner.v1.DirectedReadOptions
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
EXCLUDE_REPLICAS_FIELD_NUMBER
public static final int EXCLUDE_REPLICAS_FIELD_NUMBER
Field Value
Type Description
int
INCLUDE_REPLICAS_FIELD_NUMBER
public static final int INCLUDE_REPLICAS_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static DirectedReadOptions getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static DirectedReadOptions . Builder newBuilder ()
newBuilder(DirectedReadOptions prototype)
public static DirectedReadOptions . Builder newBuilder ( DirectedReadOptions prototype )
public static DirectedReadOptions parseDelimitedFrom ( InputStream input )
public static DirectedReadOptions parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static DirectedReadOptions parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DirectedReadOptions parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static DirectedReadOptions parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DirectedReadOptions parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static DirectedReadOptions parseFrom ( CodedInputStream input )
public static DirectedReadOptions parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static DirectedReadOptions parseFrom ( InputStream input )
public static DirectedReadOptions parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static DirectedReadOptions parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DirectedReadOptions parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<DirectedReadOptions> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public DirectedReadOptions getDefaultInstanceForType ()
getExcludeReplicas()
public DirectedReadOptions . ExcludeReplicas getExcludeReplicas ()
Exclude_replicas indicates that should be excluded from serving
requests. Spanner will not route requests to the replicas in this list.
.google.spanner.v1.DirectedReadOptions.ExcludeReplicas exclude_replicas = 2;
getExcludeReplicasOrBuilder()
public DirectedReadOptions . ExcludeReplicasOrBuilder getExcludeReplicasOrBuilder ()
Exclude_replicas indicates that should be excluded from serving
requests. Spanner will not route requests to the replicas in this list.
.google.spanner.v1.DirectedReadOptions.ExcludeReplicas exclude_replicas = 2;
getIncludeReplicas()
public DirectedReadOptions . IncludeReplicas 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.
.google.spanner.v1.DirectedReadOptions.IncludeReplicas include_replicas = 1;
getIncludeReplicasOrBuilder()
public DirectedReadOptions . IncludeReplicasOrBuilder getIncludeReplicasOrBuilder ()
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.
.google.spanner.v1.DirectedReadOptions.IncludeReplicas include_replicas = 1;
getParserForType()
public Parser<DirectedReadOptions> getParserForType ()
Overrides
getReplicasCase()
public DirectedReadOptions . ReplicasCase getReplicasCase ()
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hasExcludeReplicas()
public boolean hasExcludeReplicas ()
Exclude_replicas indicates that should be excluded from serving
requests. Spanner will not route requests to the replicas in this list.
.google.spanner.v1.DirectedReadOptions.ExcludeReplicas exclude_replicas = 2;
Returns
Type Description
boolean Whether the excludeReplicas field is set.
hasIncludeReplicas()
public boolean hasIncludeReplicas ()
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.
.google.spanner.v1.DirectedReadOptions.IncludeReplicas include_replicas = 1;
Returns
Type Description
boolean Whether the includeReplicas field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public DirectedReadOptions . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DirectedReadOptions . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public DirectedReadOptions . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]
