com.google.spanner.v1

Class RequestOptions.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<RequestOptions.Builder>

com.google.spanner.v1.RequestOptions.Builder

All Implemented Interfaces:

Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, RequestOptionsOrBuilder, Cloneable

Enclosing class:

RequestOptions

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

Method Summary

Modifier and Type	Method and Description
RequestOptions.Builder	addRepeatedField(Descriptors.FieldDescriptor field, Object value)
RequestOptions	build()
RequestOptions	buildPartial()
RequestOptions.Builder	clear()
RequestOptions.Builder	clearField(Descriptors.FieldDescriptor field)
RequestOptions.Builder	clearOneof(Descriptors.OneofDescriptor oneof)
RequestOptions.Builder	clearPriority() Priority for the request.
RequestOptions.Builder	clearRequestTag() A per-request tag which can be applied to queries or reads, used for statistics collection.
RequestOptions.Builder	clearTransactionTag() A tag used for statistics collection about this transaction.
RequestOptions.Builder	clone()
RequestOptions	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
RequestOptions.Priority	getPriority() Priority for the request.
int	getPriorityValue() Priority for the request.
String	getRequestTag() A per-request tag which can be applied to queries or reads, used for statistics collection.
ByteString	getRequestTagBytes() A per-request tag which can be applied to queries or reads, used for statistics collection.
String	getTransactionTag() A tag used for statistics collection about this transaction.
ByteString	getTransactionTagBytes() A tag used for statistics collection about this transaction.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
RequestOptions.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
RequestOptions.Builder	mergeFrom(Message other)
RequestOptions.Builder	mergeFrom(RequestOptions other)
RequestOptions.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)
RequestOptions.Builder	setField(Descriptors.FieldDescriptor field, Object value)
RequestOptions.Builder	setPriority(RequestOptions.Priority value) Priority for the request.
RequestOptions.Builder	setPriorityValue(int value) Priority for the request.
RequestOptions.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
RequestOptions.Builder	setRequestTag(String value) A per-request tag which can be applied to queries or reads, used for statistics collection.
RequestOptions.Builder	setRequestTagBytes(ByteString value) A per-request tag which can be applied to queries or reads, used for statistics collection.
RequestOptions.Builder	setTransactionTag(String value) A tag used for statistics collection about this transaction.
RequestOptions.Builder	setTransactionTagBytes(ByteString value) A tag used for statistics collection about this transaction.
RequestOptions.Builder	setUnknownFields(UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<RequestOptions.Builder>

clear

public RequestOptions.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<RequestOptions.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<RequestOptions.Builder>

getDefaultInstanceForType

public RequestOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public RequestOptions build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public RequestOptions buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public RequestOptions.Builder clone()

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<RequestOptions.Builder>

setField

public RequestOptions.Builder setField(Descriptors.FieldDescriptor field,
                                       Object value)

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<RequestOptions.Builder>

clearField

public RequestOptions.Builder clearField(Descriptors.FieldDescriptor field)

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<RequestOptions.Builder>

clearOneof

public RequestOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<RequestOptions.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<RequestOptions.Builder>

addRepeatedField

public RequestOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                               Object value)

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<RequestOptions.Builder>

mergeFrom

public RequestOptions.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<RequestOptions.Builder>

mergeFrom

public RequestOptions.Builder mergeFrom(RequestOptions other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<RequestOptions.Builder>

mergeFrom

public RequestOptions.Builder mergeFrom(CodedInputStream input,
                                        ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<RequestOptions.Builder>

Throws:

IOException

getPriorityValue

public int getPriorityValue()

 Priority for the request.
 

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

Specified by:

getPriorityValue in interface RequestOptionsOrBuilder

Returns:

The enum numeric value on the wire for priority.

setPriorityValue

public RequestOptions.Builder setPriorityValue(int value)

 Priority for the request.
 

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

Parameters:

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

Returns:

This builder for chaining.

getPriority

public RequestOptions.Priority getPriority()

 Priority for the request.
 

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

Specified by:

getPriority in interface RequestOptionsOrBuilder

Returns:

The priority.

setPriority

public RequestOptions.Builder setPriority(RequestOptions.Priority value)

 Priority for the request.
 

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

Parameters:

value - The priority to set.

Returns:

This builder for chaining.

clearPriority

public RequestOptions.Builder clearPriority()

 Priority for the request.
 

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

Returns:

This builder for chaining.

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;

Specified by:

getRequestTag in interface RequestOptionsOrBuilder

Returns:

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;

Specified by:

getRequestTagBytes in interface RequestOptionsOrBuilder

Returns:

The bytes for requestTag.

setRequestTag

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;

Parameters:

value - The requestTag to set.

Returns:

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:

This builder for chaining.

setRequestTagBytes

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;

Parameters:

value - The bytes for requestTag to set.

Returns:

This builder for chaining.

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;

Specified by:

getTransactionTag in interface RequestOptionsOrBuilder

Returns:

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;

Specified by:

getTransactionTagBytes in interface RequestOptionsOrBuilder

Returns:

The bytes for transactionTag.

setTransactionTag

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;

Parameters:

value - The transactionTag to set.

Returns:

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:

This builder for chaining.

setTransactionTagBytes

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;

Parameters:

value - The bytes for transactionTag to set.

Returns:

This builder for chaining.

setUnknownFields

public final RequestOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<RequestOptions.Builder>

mergeUnknownFields

public final RequestOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<RequestOptions.Builder>