com.google.spanner.v1

Class RequestOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.spanner.v1.RequestOptions

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, RequestOptionsOrBuilder, Serializable

public final class RequestOptions
extends GeneratedMessageV3
implements RequestOptionsOrBuilder

 Common request options for various APIs.
 

Protobuf type google.spanner.v1.RequestOptions

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RequestOptions.Builder Common request options for various APIs.
static class	RequestOptions.Priority The relative priority for requests.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	PRIORITY_FIELD_NUMBER
static int	REQUEST_TAG_FIELD_NUMBER
static int	TRANSACTION_TAG_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static RequestOptions	getDefaultInstance()
RequestOptions	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Parser<RequestOptions>	getParserForType()
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.
int	getSerializedSize()
String	getTransactionTag() A tag used for statistics collection about this transaction.
ByteString	getTransactionTagBytes() A tag used for statistics collection about this transaction.
UnknownFieldSet	getUnknownFields()
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RequestOptions.Builder	newBuilder()
static RequestOptions.Builder	newBuilder(RequestOptions prototype)
RequestOptions.Builder	newBuilderForType()
protected RequestOptions.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static RequestOptions	parseDelimitedFrom(InputStream input)
static RequestOptions	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static RequestOptions	parseFrom(byte[] data)
static RequestOptions	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static RequestOptions	parseFrom(ByteBuffer data)
static RequestOptions	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static RequestOptions	parseFrom(ByteString data)
static RequestOptions	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static RequestOptions	parseFrom(CodedInputStream input)
static RequestOptions	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static RequestOptions	parseFrom(InputStream input)
static RequestOptions	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<RequestOptions>	parser()
RequestOptions.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PRIORITY_FIELD_NUMBER

public static final int PRIORITY_FIELD_NUMBER

See Also:

Constant Field Values

REQUEST_TAG_FIELD_NUMBER

public static final int REQUEST_TAG_FIELD_NUMBER

See Also:

Constant Field Values

TRANSACTION_TAG_FIELD_NUMBER

public static final int TRANSACTION_TAG_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

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.

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.

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.

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static RequestOptions parseFrom(ByteBuffer data)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RequestOptions parseFrom(ByteBuffer data,
                                       ExtensionRegistryLite extensionRegistry)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RequestOptions parseFrom(ByteString data)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RequestOptions parseFrom(ByteString data,
                                       ExtensionRegistryLite extensionRegistry)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RequestOptions parseFrom(byte[] data)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RequestOptions parseFrom(byte[] data,
                                       ExtensionRegistryLite extensionRegistry)
                                throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static RequestOptions parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static RequestOptions parseFrom(InputStream input,
                                       ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static RequestOptions parseDelimitedFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static RequestOptions parseDelimitedFrom(InputStream input,
                                                ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseFrom

public static RequestOptions parseFrom(CodedInputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static RequestOptions parseFrom(CodedInputStream input,
                                       ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

newBuilderForType

public RequestOptions.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static RequestOptions.Builder newBuilder()

newBuilder

public static RequestOptions.Builder newBuilder(RequestOptions prototype)

toBuilder

public RequestOptions.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected RequestOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static RequestOptions getDefaultInstance()

parser

public static Parser<RequestOptions> parser()

getParserForType

public Parser<RequestOptions> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public RequestOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder