public final class DirectedReadOptions extends GeneratedMessageV3 implements DirectedReadOptionsOrBuilderThe DirectedReadOptions can be used to indicate which replicas or regions should be used for non-transactional reads or queries.
DirectedReadOptions may only be specified for a read-only transaction,
otherwise the API will return an INVALID_ARGUMENT error.
Protobuf type google.spanner.v1.DirectedReadOptions
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DirectedReadOptionsImplements
DirectedReadOptionsOrBuilderStatic Fields
EXCLUDE_REPLICAS_FIELD_NUMBER
public static final int EXCLUDE_REPLICAS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
INCLUDE_REPLICAS_FIELD_NUMBER
public static final int INCLUDE_REPLICAS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static DirectedReadOptions getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static DirectedReadOptions.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions.Builder |
|
newBuilder(DirectedReadOptions prototype)
public static DirectedReadOptions.Builder newBuilder(DirectedReadOptions prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
DirectedReadOptions |
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions.Builder |
|
parseDelimitedFrom(InputStream input)
public static DirectedReadOptions parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static DirectedReadOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static DirectedReadOptions parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DirectedReadOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static DirectedReadOptions parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DirectedReadOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static DirectedReadOptions parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DirectedReadOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static DirectedReadOptions parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static DirectedReadOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static DirectedReadOptions parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DirectedReadOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<DirectedReadOptions> parser()| Returns | |
|---|---|
| Type | Description |
Parser<DirectedReadOptions> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public DirectedReadOptions getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions |
|
getExcludeReplicas()
public DirectedReadOptions.ExcludeReplicas getExcludeReplicas()Exclude_replicas indicates that specified replicas should be excluded from serving requests. Spanner will not route requests to the replicas in this list.
.google.spanner.v1.DirectedReadOptions.ExcludeReplicas exclude_replicas = 2;
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions.ExcludeReplicas |
The excludeReplicas. |
getExcludeReplicasOrBuilder()
public DirectedReadOptions.ExcludeReplicasOrBuilder getExcludeReplicasOrBuilder()Exclude_replicas indicates that specified replicas should be excluded from serving requests. Spanner will not route requests to the replicas in this list.
.google.spanner.v1.DirectedReadOptions.ExcludeReplicas exclude_replicas = 2;
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions.ExcludeReplicasOrBuilder |
|
getIncludeReplicas()
public DirectedReadOptions.IncludeReplicas getIncludeReplicas() Include_replicas indicates the order of replicas (as they appear in
this list) to process the request. If auto_failover_disabled is set to
true and all replicas are exhausted without finding a healthy replica,
Spanner will wait for a replica in the list to become available, requests
may fail due to DEADLINE_EXCEEDED errors.
.google.spanner.v1.DirectedReadOptions.IncludeReplicas include_replicas = 1;
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions.IncludeReplicas |
The includeReplicas. |
getIncludeReplicasOrBuilder()
public DirectedReadOptions.IncludeReplicasOrBuilder getIncludeReplicasOrBuilder() Include_replicas indicates the order of replicas (as they appear in
this list) to process the request. If auto_failover_disabled is set to
true and all replicas are exhausted without finding a healthy replica,
Spanner will wait for a replica in the list to become available, requests
may fail due to DEADLINE_EXCEEDED errors.
.google.spanner.v1.DirectedReadOptions.IncludeReplicas include_replicas = 1;
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions.IncludeReplicasOrBuilder |
|
getParserForType()
public Parser<DirectedReadOptions> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<DirectedReadOptions> |
|
getReplicasCase()
public DirectedReadOptions.ReplicasCase getReplicasCase()| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions.ReplicasCase |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
hasExcludeReplicas()
public boolean hasExcludeReplicas()Exclude_replicas indicates that specified replicas should be excluded from serving requests. Spanner will not route requests to the replicas in this list.
.google.spanner.v1.DirectedReadOptions.ExcludeReplicas exclude_replicas = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the excludeReplicas field is set. |
hasIncludeReplicas()
public boolean hasIncludeReplicas() Include_replicas indicates the order of replicas (as they appear in
this list) to process the request. If auto_failover_disabled is set to
true and all replicas are exhausted without finding a healthy replica,
Spanner will wait for a replica in the list to become available, requests
may fail due to DEADLINE_EXCEEDED errors.
.google.spanner.v1.DirectedReadOptions.IncludeReplicas include_replicas = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the includeReplicas field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public DirectedReadOptions.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DirectedReadOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public DirectedReadOptions.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
DirectedReadOptions.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|