Class DirectedReadOptions.ReplicaSelection (6.55.0)

public static final class DirectedReadOptions.ReplicaSelection extends GeneratedMessageV3 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DirectedReadOptions.ReplicaSelection

Static Fields

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DirectedReadOptions.ReplicaSelection getDefaultInstance()
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection

getDescriptor()

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

newBuilder()

public static DirectedReadOptions.ReplicaSelection.Builder newBuilder()
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection.Builder

newBuilder(DirectedReadOptions.ReplicaSelection prototype)

public static DirectedReadOptions.ReplicaSelection.Builder newBuilder(DirectedReadOptions.ReplicaSelection prototype)
Parameter
NameDescription
prototypeDirectedReadOptions.ReplicaSelection
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection.Builder

parseDelimitedFrom(InputStream input)

public static DirectedReadOptions.ReplicaSelection parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DirectedReadOptions.ReplicaSelection parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DirectedReadOptions.ReplicaSelection parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DirectedReadOptions.ReplicaSelection parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DirectedReadOptions.ReplicaSelection parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DirectedReadOptions.ReplicaSelection parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DirectedReadOptions.ReplicaSelection parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DirectedReadOptions.ReplicaSelection parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DirectedReadOptions.ReplicaSelection parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DirectedReadOptions.ReplicaSelection parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DirectedReadOptions.ReplicaSelection parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DirectedReadOptions.ReplicaSelection parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DirectedReadOptions.ReplicaSelection> parser()
Returns
TypeDescription
Parser<ReplicaSelection>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

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

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.

getParserForType()

public Parser<DirectedReadOptions.ReplicaSelection> getParserForType()
Returns
TypeDescription
Parser<ReplicaSelection>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DirectedReadOptions.ReplicaSelection.Builder newBuilderForType()
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DirectedReadOptions.ReplicaSelection.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DirectedReadOptions.ReplicaSelection.Builder toBuilder()
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException