publicstaticfinalclassDirectedReadOptions.BuilderextendsGeneratedMessageV3.Builder<DirectedReadOptions.Builder>implementsDirectedReadOptionsOrBuilder
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.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
publicDirectedReadOptions.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
build()
publicDirectedReadOptionsbuild()
buildPartial()
publicDirectedReadOptionsbuildPartial()
clear()
publicDirectedReadOptions.Builderclear()
clearExcludeReplicas()
publicDirectedReadOptions.BuilderclearExcludeReplicas()
Exclude_replicas indicates that specified replicas 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;
clearField(Descriptors.FieldDescriptor field)
publicDirectedReadOptions.BuilderclearField(Descriptors.FieldDescriptorfield)
clearIncludeReplicas()
publicDirectedReadOptions.BuilderclearIncludeReplicas()
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;
clearOneof(Descriptors.OneofDescriptor oneof)
publicDirectedReadOptions.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
clearReplicas()
publicDirectedReadOptions.BuilderclearReplicas()
clone()
publicDirectedReadOptions.Builderclone()
getDefaultInstanceForType()
publicDirectedReadOptionsgetDefaultInstanceForType()
getDescriptorForType()
publicDescriptors.DescriptorgetDescriptorForType()
getExcludeReplicas()
publicDirectedReadOptions.ExcludeReplicasgetExcludeReplicas()
Exclude_replicas indicates that specified replicas 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;
getExcludeReplicasBuilder()
publicDirectedReadOptions.ExcludeReplicas.BuildergetExcludeReplicasBuilder()
Exclude_replicas indicates that specified replicas 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()
publicDirectedReadOptions.ExcludeReplicasOrBuildergetExcludeReplicasOrBuilder()
Exclude_replicas indicates that specified replicas 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()
publicDirectedReadOptions.IncludeReplicasgetIncludeReplicas()
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;
getIncludeReplicasBuilder()
publicDirectedReadOptions.IncludeReplicas.BuildergetIncludeReplicasBuilder()
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()
publicDirectedReadOptions.IncludeReplicasOrBuildergetIncludeReplicasOrBuilder()
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;
getReplicasCase()
publicDirectedReadOptions.ReplicasCasegetReplicasCase()
hasExcludeReplicas()
publicbooleanhasExcludeReplicas()
Exclude_replicas indicates that specified replicas 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()
publicbooleanhasIncludeReplicas()
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. |
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
isInitialized()
publicfinalbooleanisInitialized()
mergeExcludeReplicas(DirectedReadOptions.ExcludeReplicas value)
publicDirectedReadOptions.BuildermergeExcludeReplicas(DirectedReadOptions.ExcludeReplicasvalue)
Exclude_replicas indicates that specified replicas 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;
publicDirectedReadOptions.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
mergeFrom(Message other)
publicDirectedReadOptions.BuildermergeFrom(Messageother)
| Parameter |
|---|
| Name | Description |
other | Message
|
OverridesmergeFrom(DirectedReadOptions other)
publicDirectedReadOptions.BuildermergeFrom(DirectedReadOptionsother)
mergeIncludeReplicas(DirectedReadOptions.IncludeReplicas value)
publicDirectedReadOptions.BuildermergeIncludeReplicas(DirectedReadOptions.IncludeReplicasvalue)
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;
mergeUnknownFields(UnknownFieldSet unknownFields)
publicfinalDirectedReadOptions.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
setExcludeReplicas(DirectedReadOptions.ExcludeReplicas value)
publicDirectedReadOptions.BuildersetExcludeReplicas(DirectedReadOptions.ExcludeReplicasvalue)
Exclude_replicas indicates that specified replicas 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;
setExcludeReplicas(DirectedReadOptions.ExcludeReplicas.Builder builderForValue)
publicDirectedReadOptions.BuildersetExcludeReplicas(DirectedReadOptions.ExcludeReplicas.BuilderbuilderForValue)
Exclude_replicas indicates that specified replicas 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;
setField(Descriptors.FieldDescriptor field, Object value)
publicDirectedReadOptions.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
setIncludeReplicas(DirectedReadOptions.IncludeReplicas value)
publicDirectedReadOptions.BuildersetIncludeReplicas(DirectedReadOptions.IncludeReplicasvalue)
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;
setIncludeReplicas(DirectedReadOptions.IncludeReplicas.Builder builderForValue)
publicDirectedReadOptions.BuildersetIncludeReplicas(DirectedReadOptions.IncludeReplicas.BuilderbuilderForValue)
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;
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
publicDirectedReadOptions.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
setUnknownFields(UnknownFieldSet unknownFields)
publicfinalDirectedReadOptions.BuildersetUnknownFields(UnknownFieldSetunknownFields)
