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
REQUEST_TAG_FIELD_NUMBER
public static final int REQUEST_TAG_FIELD_NUMBER
Field Value
TRANSACTION_TAG_FIELD_NUMBER
public static final int TRANSACTION_TAG_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static RequestOptions getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static RequestOptions.Builder newBuilder()
Returns
newBuilder(RequestOptions prototype)
public static RequestOptions.Builder newBuilder(RequestOptions prototype)
Parameter
Returns
public static RequestOptions parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static RequestOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static RequestOptions parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RequestOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static RequestOptions parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RequestOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RequestOptions parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static RequestOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RequestOptions parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static RequestOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static RequestOptions parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RequestOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<RequestOptions> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public RequestOptions getDefaultInstanceForType()
Returns
getParserForType()
public Parser<RequestOptions> getParserForType()
Returns
Overrides
getPriority()
public RequestOptions.Priority getPriority()
Priority for the request.
.google.spanner.v1.RequestOptions.Priority priority = 1;
getPriorityValue()
public int getPriorityValue()
Priority for the request.
.google.spanner.v1.RequestOptions.Priority priority = 1;
| 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;
| 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;
| Type | Description |
| ByteString | The bytes for requestTag.
|
getSerializedSize()
public int getSerializedSize()
Returns
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;
| 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;
| Type | Description |
| ByteString | The bytes for transactionTag.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public RequestOptions.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RequestOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public RequestOptions.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
