Class DirectedReadOptions.ReplicaSelection.Builder (6.57.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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DirectedReadOptions.ReplicaSelection.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection.Builder
Overrides

build()

public DirectedReadOptions.ReplicaSelection build()
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection

buildPartial()

public DirectedReadOptions.ReplicaSelection buildPartial()
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection

clear()

public DirectedReadOptions.ReplicaSelection.Builder clear()
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public DirectedReadOptions.ReplicaSelection.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
DirectedReadOptions.ReplicaSelection.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DirectedReadOptions.ReplicaSelection.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection.Builder
Overrides

clearType()

public DirectedReadOptions.ReplicaSelection.Builder clearType()

The type of replica.

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

Returns
TypeDescription
DirectedReadOptions.ReplicaSelection.Builder

This builder for chaining.

clone()

public DirectedReadOptions.ReplicaSelection.Builder clone()
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection.Builder
Overrides

getDefaultInstanceForType()

public DirectedReadOptions.ReplicaSelection getDefaultInstanceForType()
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getLocation()

public String getLocation()

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

string location = 1;

Returns
TypeDescription
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

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

string location = 1;

Returns
TypeDescription
ByteString

The bytes for location.

getType()

public DirectedReadOptions.ReplicaSelection.Type getType()

The type of replica.

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

Returns
TypeDescription
DirectedReadOptions.ReplicaSelection.Type

The type.

getTypeValue()

public int getTypeValue()

The type of replica.

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

Returns
TypeDescription
int

The enum numeric value on the wire for type.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DirectedReadOptions.ReplicaSelection.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public DirectedReadOptions.ReplicaSelection.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection.Builder
Overrides

mergeFrom(DirectedReadOptions.ReplicaSelection other)

public DirectedReadOptions.ReplicaSelection.Builder mergeFrom(DirectedReadOptions.ReplicaSelection other)
Parameter
NameDescription
otherDirectedReadOptions.ReplicaSelection
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DirectedReadOptions.ReplicaSelection.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public DirectedReadOptions.ReplicaSelection.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The location to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for location to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valueDirectedReadOptions.ReplicaSelection.Type

The type to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for type to set.

Returns
TypeDescription
DirectedReadOptions.ReplicaSelection.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DirectedReadOptions.ReplicaSelection.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection.Builder
Overrides