Class RequestOptions (6.74.0)

public final class RequestOptions extends GeneratedMessageV3 implements RequestOptionsOrBuilder

Common request options for various APIs.

Protobuf type google.spanner.v1.RequestOptions

Static Fields

PRIORITY_FIELD_NUMBER

public static final int PRIORITY_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_TAG_FIELD_NUMBER

public static final int REQUEST_TAG_FIELD_NUMBER
Field Value
Type Description
int

TRANSACTION_TAG_FIELD_NUMBER

public static final int TRANSACTION_TAG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RequestOptions getDefaultInstance()
Returns
Type Description
RequestOptions

getDescriptor()

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

newBuilder()

public static RequestOptions.Builder newBuilder()
Returns
Type Description
RequestOptions.Builder

newBuilder(RequestOptions prototype)

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

parseDelimitedFrom(InputStream input)

public static RequestOptions parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RequestOptions
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static RequestOptions parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RequestOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static RequestOptions parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RequestOptions
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static RequestOptions parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RequestOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static RequestOptions parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RequestOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<RequestOptions> parser()
Returns
Type Description
Parser<RequestOptions>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public RequestOptions getDefaultInstanceForType()
Returns
Type Description
RequestOptions

getParserForType()

public Parser<RequestOptions> getParserForType()
Returns
Type Description
Parser<RequestOptions>
Overrides

getPriority()

public RequestOptions.Priority getPriority()

Priority for the request.

.google.spanner.v1.RequestOptions.Priority priority = 1;

Returns
Type Description
RequestOptions.Priority

The priority.

getPriorityValue()

public int getPriorityValue()

Priority for the request.

.google.spanner.v1.RequestOptions.Priority priority = 1;

Returns
Type Description
int

The enum numeric value on the wire for priority.

getRequestTag()

public String getRequestTag()

A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). Legal characters for request_tag values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters will be removed from the string.

string request_tag = 2;

Returns
Type Description
String

The requestTag.

getRequestTagBytes()

public ByteString getRequestTagBytes()

A per-request tag which can be applied to queries or reads, used for statistics collection. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest). Legal characters for request_tag values are all printable characters (ASCII 32 - 126) and the length of a request_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters will be removed from the string.

string request_tag = 2;

Returns
Type Description
ByteString

The bytes for requestTag.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTransactionTag()

public String getTransactionTag()

A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, transaction_tag will be ignored. Legal characters for transaction_tag values are all printable characters (ASCII 32 - 126) and the length of a transaction_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters will be removed from the string.

string transaction_tag = 3;

Returns
Type Description
String

The transactionTag.

getTransactionTagBytes()

public ByteString getTransactionTagBytes()

A tag used for statistics collection about this transaction. Both request_tag and transaction_tag can be specified for a read or query that belongs to a transaction. The value of transaction_tag should be the same for all requests belonging to the same transaction. If this request doesn't belong to any transaction, transaction_tag will be ignored. Legal characters for transaction_tag values are all printable characters (ASCII 32 - 126) and the length of a transaction_tag is limited to 50 characters. Values that exceed this limit are truncated. Any leading underscore (_) characters will be removed from the string.

string transaction_tag = 3;

Returns
Type Description
ByteString

The bytes for transactionTag.

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 RequestOptions.Builder newBuilderForType()
Returns
Type Description
RequestOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public RequestOptions.Builder toBuilder()
Returns
Type Description
RequestOptions.Builder

writeTo(CodedOutputStream output)

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