Class DirectedReadOptions.ReplicaSelection (6.72.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
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DirectedReadOptions.ReplicaSelection getDefaultInstance()
Returns
Type Description
DirectedReadOptions.ReplicaSelection

getDescriptor()

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

newBuilder()

public static DirectedReadOptions.ReplicaSelection.Builder newBuilder()
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder

newBuilder(DirectedReadOptions.ReplicaSelection prototype)

public static DirectedReadOptions.ReplicaSelection.Builder newBuilder(DirectedReadOptions.ReplicaSelection prototype)
Parameter
Name Description
prototype DirectedReadOptions.ReplicaSelection
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder

parseDelimitedFrom(InputStream input)

public static DirectedReadOptions.ReplicaSelection parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DirectedReadOptions.ReplicaSelection
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DirectedReadOptions.ReplicaSelection parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DirectedReadOptions.ReplicaSelection
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DirectedReadOptions.ReplicaSelection parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DirectedReadOptions.ReplicaSelection
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DirectedReadOptions.ReplicaSelection parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DirectedReadOptions.ReplicaSelection
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DirectedReadOptions.ReplicaSelection parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DirectedReadOptions.ReplicaSelection
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DirectedReadOptions.ReplicaSelection parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DirectedReadOptions.ReplicaSelection
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DirectedReadOptions.ReplicaSelection parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DirectedReadOptions.ReplicaSelection
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DirectedReadOptions.ReplicaSelection parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DirectedReadOptions.ReplicaSelection
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DirectedReadOptions.ReplicaSelection parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DirectedReadOptions.ReplicaSelection
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DirectedReadOptions.ReplicaSelection parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DirectedReadOptions.ReplicaSelection
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DirectedReadOptions.ReplicaSelection parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DirectedReadOptions.ReplicaSelection
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DirectedReadOptions.ReplicaSelection parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DirectedReadOptions.ReplicaSelection
Exceptions
Type Description
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

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

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.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DirectedReadOptions.ReplicaSelection.Builder newBuilderForType()
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DirectedReadOptions.ReplicaSelection.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DirectedReadOptions.ReplicaSelection.Builder toBuilder()
Returns
Type Description
DirectedReadOptions.ReplicaSelection.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException