Class DirectedReadOptions.ReplicaSelection.Builder (6.72.0) 

public static final class DirectedReadOptions.ReplicaSelection.Builder extends GeneratedMessageV3.Builder<DirectedReadOptions.ReplicaSelection.Builder> implements DirectedReadOptions.ReplicaSelectionOrBuilder

The directed read replica selector. Callers must provide one or more of the following fields for replica selection:

  • location - The location must be one of the regions within the multi-region configuration of your database.

  • type - The type of the replica.

    Some examples of using replica_selectors are:

  • location:us-east1 --> The "us-east1" replica(s) of any available type will be used to process the request.

  • type:READ_ONLY --> The "READ_ONLY" type replica(s) in nearest available location will be used to process the request.
  • location:us-east1 type:READ_ONLY --> The "READ_ONLY" type replica(s) in location "us-east1" will be used to process the request.

Protobuf type google.spanner.v1.DirectedReadOptions.ReplicaSelection

Inheritance

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DirectedReadOptions.ReplicaSelection.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder
Overrides

build()

public DirectedReadOptions.ReplicaSelection build()
Returns
Type Description
DirectedReadOptions.ReplicaSelection

buildPartial()

public DirectedReadOptions.ReplicaSelection buildPartial()
Returns
Type Description
DirectedReadOptions.ReplicaSelection

clear()

public DirectedReadOptions.ReplicaSelection.Builder clear()
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public DirectedReadOptions.ReplicaSelection.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder
Overrides

clearLocation()

public DirectedReadOptions.ReplicaSelection.Builder clearLocation()

The location or region of the serving requests, e.g. "us-east1".

string location = 1;

Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DirectedReadOptions.ReplicaSelection.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder
Overrides

clearType()

public DirectedReadOptions.ReplicaSelection.Builder clearType()

The type of replica.

.google.spanner.v1.DirectedReadOptions.ReplicaSelection.Type type = 2;

Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder

This builder for chaining.

clone()

public DirectedReadOptions.ReplicaSelection.Builder clone()
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder
Overrides

getDefaultInstanceForType()

public DirectedReadOptions.ReplicaSelection getDefaultInstanceForType()
Returns
Type Description
DirectedReadOptions.ReplicaSelection

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getLocation()

public String getLocation()

The location or region of the serving requests, e.g. "us-east1".

string location = 1;

Returns
Type Description
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

The location or region of the serving requests, e.g. "us-east1".

string location = 1;

Returns
Type Description
ByteString

The bytes for location.

getType()

public DirectedReadOptions.ReplicaSelection.Type getType()

The type of replica.

.google.spanner.v1.DirectedReadOptions.ReplicaSelection.Type type = 2;

Returns
Type Description
DirectedReadOptions.ReplicaSelection.Type

The type.

getTypeValue()

public int getTypeValue()

The type of replica.

.google.spanner.v1.DirectedReadOptions.ReplicaSelection.Type type = 2;

Returns
Type Description
int

The enum numeric value on the wire for type.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DirectedReadOptions.ReplicaSelection.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DirectedReadOptions.ReplicaSelection.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder
Overrides

mergeFrom(DirectedReadOptions.ReplicaSelection other)

public DirectedReadOptions.ReplicaSelection.Builder mergeFrom(DirectedReadOptions.ReplicaSelection other)
Parameter
Name Description
other DirectedReadOptions.ReplicaSelection
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DirectedReadOptions.ReplicaSelection.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public DirectedReadOptions.ReplicaSelection.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder
Overrides

setLocation(String value)

public DirectedReadOptions.ReplicaSelection.Builder setLocation(String value)

The location or region of the serving requests, e.g. "us-east1".

string location = 1;

Parameter
Name Description
value String

The location to set.
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder

This builder for chaining.

setLocationBytes(ByteString value)

public DirectedReadOptions.ReplicaSelection.Builder setLocationBytes(ByteString value)

The location or region of the serving requests, e.g. "us-east1".

string location = 1;

Parameter
Name Description
value ByteString

The bytes for location to set.
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder

This builder for chaining.

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

public DirectedReadOptions.ReplicaSelection.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder
Overrides

setType(DirectedReadOptions.ReplicaSelection.Type value)

public DirectedReadOptions.ReplicaSelection.Builder setType(DirectedReadOptions.ReplicaSelection.Type value)

The type of replica.

.google.spanner.v1.DirectedReadOptions.ReplicaSelection.Type type = 2;

Parameter
Name Description
value DirectedReadOptions.ReplicaSelection.Type

The type to set.
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder

This builder for chaining.

setTypeValue(int value)

public DirectedReadOptions.ReplicaSelection.Builder setTypeValue(int value)

The type of replica.

.google.spanner.v1.DirectedReadOptions.ReplicaSelection.Type type = 2;

Parameter
Name Description
value int

The enum numeric value on the wire for type to set.
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DirectedReadOptions.ReplicaSelection.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder
Overrides