Class DirectedReadOptions.Builder (6.55.0)

Version 6.55.0

• 6.80.1 (latest)
• 6.79.0
• 6.77.0
• 6.74.1
• 6.72.0
• 6.71.0
• 6.69.0
• 6.68.0
• 6.66.0
• 6.65.1
• 6.62.0
• 6.60.0
• 6.58.0
• 6.57.0
• 6.56.0
• 6.55.0
• 6.54.0
• 6.53.0
• 6.52.1
• 6.51.0
• 6.50.1
• 6.49.0
• 6.25.1
• 6.24.0
• 6.23.4
• 6.22.0
• 6.21.2
• 6.20.0
• 6.19.1
• 6.18.0
• 6.17.4
• 6.14.1

public static final class DirectedReadOptions.Builder extends GeneratedMessageV3.Builder<DirectedReadOptions.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DirectedReadOptions.Builder

Implements

DirectedReadOptionsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DirectedReadOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
DirectedReadOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public DirectedReadOptions build()

Returns
Type	Description
DirectedReadOptions

buildPartial()

public DirectedReadOptions buildPartial()

Returns
Type	Description
DirectedReadOptions

clear()

public DirectedReadOptions.Builder clear()

Returns
Type	Description
DirectedReadOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearExcludeReplicas()

public DirectedReadOptions.Builder clearExcludeReplicas()

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
DirectedReadOptions.Builder

clearField(Descriptors.FieldDescriptor field)

public DirectedReadOptions.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
DirectedReadOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearIncludeReplicas()

public DirectedReadOptions.Builder clearIncludeReplicas()

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
DirectedReadOptions.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public DirectedReadOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
DirectedReadOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearReplicas()

public DirectedReadOptions.Builder clearReplicas()

Returns
Type	Description
DirectedReadOptions.Builder

clone()

public DirectedReadOptions.Builder clone()

Returns
Type	Description
DirectedReadOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public DirectedReadOptions getDefaultInstanceForType()

Returns
Type	Description
DirectedReadOptions

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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;

Returns
Type	Description
DirectedReadOptions.ExcludeReplicas	The excludeReplicas.

getExcludeReplicasBuilder()

public DirectedReadOptions.ExcludeReplicas.Builder getExcludeReplicasBuilder()

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
DirectedReadOptions.ExcludeReplicas.Builder

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;

Returns
Type	Description
DirectedReadOptions.ExcludeReplicasOrBuilder

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;

Returns
Type	Description
DirectedReadOptions.IncludeReplicas	The includeReplicas.

getIncludeReplicasBuilder()

public DirectedReadOptions.IncludeReplicas.Builder getIncludeReplicasBuilder()

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
DirectedReadOptions.IncludeReplicas.Builder

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;

Returns
Type	Description
DirectedReadOptions.IncludeReplicasOrBuilder

getReplicasCase()

public DirectedReadOptions.ReplicasCase getReplicasCase()

Returns
Type	Description
DirectedReadOptions.ReplicasCase

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeExcludeReplicas(DirectedReadOptions.ExcludeReplicas value)

public DirectedReadOptions.Builder mergeExcludeReplicas(DirectedReadOptions.ExcludeReplicas value)

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;

Parameter
Name	Description
value	DirectedReadOptions.ExcludeReplicas

Returns
Type	Description
DirectedReadOptions.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DirectedReadOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DirectedReadOptions.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public DirectedReadOptions.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
DirectedReadOptions.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeFrom(DirectedReadOptions other)

public DirectedReadOptions.Builder mergeFrom(DirectedReadOptions other)

Parameter
Name	Description
other	DirectedReadOptions

Returns
Type	Description
DirectedReadOptions.Builder

mergeIncludeReplicas(DirectedReadOptions.IncludeReplicas value)

public DirectedReadOptions.Builder mergeIncludeReplicas(DirectedReadOptions.IncludeReplicas value)

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;

Parameter
Name	Description
value	DirectedReadOptions.IncludeReplicas

Returns
Type	Description
DirectedReadOptions.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DirectedReadOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
DirectedReadOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setExcludeReplicas(DirectedReadOptions.ExcludeReplicas value)

public DirectedReadOptions.Builder setExcludeReplicas(DirectedReadOptions.ExcludeReplicas value)

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;

Parameter
Name	Description
value	DirectedReadOptions.ExcludeReplicas

Returns
Type	Description
DirectedReadOptions.Builder

setExcludeReplicas(DirectedReadOptions.ExcludeReplicas.Builder builderForValue)

public DirectedReadOptions.Builder setExcludeReplicas(DirectedReadOptions.ExcludeReplicas.Builder builderForValue)

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;

Parameter
Name	Description
builderForValue	DirectedReadOptions.ExcludeReplicas.Builder

Returns
Type	Description
DirectedReadOptions.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public DirectedReadOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
DirectedReadOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setIncludeReplicas(DirectedReadOptions.IncludeReplicas value)

public DirectedReadOptions.Builder setIncludeReplicas(DirectedReadOptions.IncludeReplicas value)

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;

Parameter
Name	Description
value	DirectedReadOptions.IncludeReplicas

Returns
Type	Description
DirectedReadOptions.Builder

setIncludeReplicas(DirectedReadOptions.IncludeReplicas.Builder builderForValue)

public DirectedReadOptions.Builder setIncludeReplicas(DirectedReadOptions.IncludeReplicas.Builder builderForValue)

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;

Parameter
Name	Description
builderForValue	DirectedReadOptions.IncludeReplicas.Builder

Returns
Type	Description
DirectedReadOptions.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DirectedReadOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
DirectedReadOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final DirectedReadOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
DirectedReadOptions.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)