Class RequestOptions.Builder (6.74.0)

public static final class RequestOptions.Builder extends GeneratedMessageV3.Builder<RequestOptions.Builder> implements RequestOptionsOrBuilder

Common request options for various APIs.

Protobuf type google.spanner.v1.RequestOptions

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RequestOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RequestOptions.Builder
Overrides

build()

public RequestOptions build()
Returns
Type Description
RequestOptions

buildPartial()

public RequestOptions buildPartial()
Returns
Type Description
RequestOptions

clear()

public RequestOptions.Builder clear()
Returns
Type Description
RequestOptions.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public RequestOptions.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RequestOptions.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public RequestOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RequestOptions.Builder
Overrides

clearPriority()

public RequestOptions.Builder clearPriority()

Priority for the request.

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

Returns
Type Description
RequestOptions.Builder

This builder for chaining.

clearRequestTag()

public RequestOptions.Builder clearRequestTag()

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
RequestOptions.Builder

This builder for chaining.

clearTransactionTag()

public RequestOptions.Builder clearTransactionTag()

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
RequestOptions.Builder

This builder for chaining.

clone()

public RequestOptions.Builder clone()
Returns
Type Description
RequestOptions.Builder
Overrides

getDefaultInstanceForType()

public RequestOptions getDefaultInstanceForType()
Returns
Type Description
RequestOptions

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RequestOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RequestOptions.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RequestOptions.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RequestOptions.Builder
Overrides

mergeFrom(RequestOptions other)

public RequestOptions.Builder mergeFrom(RequestOptions other)
Parameter
Name Description
other RequestOptions
Returns
Type Description
RequestOptions.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RequestOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RequestOptions.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public RequestOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RequestOptions.Builder
Overrides

setPriority(RequestOptions.Priority value)

public RequestOptions.Builder setPriority(RequestOptions.Priority value)

Priority for the request.

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

Parameter
Name Description
value RequestOptions.Priority

The priority to set.

Returns
Type Description
RequestOptions.Builder

This builder for chaining.

setPriorityValue(int value)

public RequestOptions.Builder setPriorityValue(int value)

Priority for the request.

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

Parameter
Name Description
value int

The enum numeric value on the wire for priority to set.

Returns
Type Description
RequestOptions.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RequestOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RequestOptions.Builder
Overrides

setRequestTag(String value)

public RequestOptions.Builder setRequestTag(String value)

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;

Parameter
Name Description
value String

The requestTag to set.

Returns
Type Description
RequestOptions.Builder

This builder for chaining.

setRequestTagBytes(ByteString value)

public RequestOptions.Builder setRequestTagBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for requestTag to set.

Returns
Type Description
RequestOptions.Builder

This builder for chaining.

setTransactionTag(String value)

public RequestOptions.Builder setTransactionTag(String value)

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;

Parameter
Name Description
value String

The transactionTag to set.

Returns
Type Description
RequestOptions.Builder

This builder for chaining.

setTransactionTagBytes(ByteString value)

public RequestOptions.Builder setTransactionTagBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for transactionTag to set.

Returns
Type Description
RequestOptions.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RequestOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RequestOptions.Builder
Overrides