Class DirectedReadOptions.IncludeReplicas (6.56.0)

public static final class DirectedReadOptions.IncludeReplicas extends GeneratedMessageV3 implements DirectedReadOptions.IncludeReplicasOrBuilder

An IncludeReplicas contains a repeated set of ReplicaSelection which indicates the order in which replicas should be considered.

Protobuf type google.spanner.v1.DirectedReadOptions.IncludeReplicas

Inheritance

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

Static Fields

AUTO_FAILOVER_DISABLED_FIELD_NUMBER

public static final int AUTO_FAILOVER_DISABLED_FIELD_NUMBER
Field Value
TypeDescription
int

REPLICA_SELECTIONS_FIELD_NUMBER

public static final int REPLICA_SELECTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(DirectedReadOptions.IncludeReplicas prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAutoFailoverDisabled()

public boolean getAutoFailoverDisabled()

If true, Spanner will not route requests to a replica outside the include_replicas list when all of the specified replicas are unavailable or unhealthy. Default value is false.

bool auto_failover_disabled = 2;

Returns
TypeDescription
boolean

The autoFailoverDisabled.

getDefaultInstanceForType()

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

getParserForType()

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

getReplicaSelections(int index)

public DirectedReadOptions.ReplicaSelection getReplicaSelections(int index)

The directed read replica selector.

repeated .google.spanner.v1.DirectedReadOptions.ReplicaSelection replica_selections = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
DirectedReadOptions.ReplicaSelection

getReplicaSelectionsCount()

public int getReplicaSelectionsCount()

The directed read replica selector.

repeated .google.spanner.v1.DirectedReadOptions.ReplicaSelection replica_selections = 1;

Returns
TypeDescription
int

getReplicaSelectionsList()

public List<DirectedReadOptions.ReplicaSelection> getReplicaSelectionsList()

The directed read replica selector.

repeated .google.spanner.v1.DirectedReadOptions.ReplicaSelection replica_selections = 1;

Returns
TypeDescription
List<ReplicaSelection>

getReplicaSelectionsOrBuilder(int index)

public DirectedReadOptions.ReplicaSelectionOrBuilder getReplicaSelectionsOrBuilder(int index)

The directed read replica selector.

repeated .google.spanner.v1.DirectedReadOptions.ReplicaSelection replica_selections = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
DirectedReadOptions.ReplicaSelectionOrBuilder

getReplicaSelectionsOrBuilderList()

public List<? extends DirectedReadOptions.ReplicaSelectionOrBuilder> getReplicaSelectionsOrBuilderList()

The directed read replica selector.

repeated .google.spanner.v1.DirectedReadOptions.ReplicaSelection replica_selections = 1;

Returns
TypeDescription
List<? extends com.google.spanner.v1.DirectedReadOptions.ReplicaSelectionOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.IncludeReplicas.Builder newBuilderForType()
Returns
TypeDescription
DirectedReadOptions.IncludeReplicas.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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