Package com.google.spanner.v1

Class RequestOptions

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.spanner.v1.RequestOptions
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RequestOptionsOrBuilder, Serializable
@Generated public final class RequestOptions extends com.google.protobuf.GeneratedMessage implements RequestOptionsOrBuilder
 Common request options for various APIs.
Protobuf type google.spanner.v1.RequestOptions
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    RequestOptions.Builder
    Common request options for various APIs.
    static final class 
    RequestOptions.ClientContext
    Container for various pieces of client-owned context attached to a request.
    static interface 
    RequestOptions.ClientContextOrBuilder
     
    static enum 
    RequestOptions.Priority
    The relative priority for requests.

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CLIENT_CONTEXT_FIELD_NUMBER
     
    static final int
    PRIORITY_FIELD_NUMBER
     
    static final int
    REQUEST_TAG_FIELD_NUMBER
     
    static final int
    TRANSACTION_TAG_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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
    Description
    boolean
    equals(Object obj)
     
    RequestOptions.ClientContext
    getClientContext()
    Optional.
    RequestOptions.ClientContextOrBuilder
    getClientContextOrBuilder()
    Optional.
    static RequestOptions
    getDefaultInstance()
     
    RequestOptions
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.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.
    com.google.protobuf.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.
    com.google.protobuf.ByteString
    getTransactionTagBytes()
    A tag used for statistics collection about this transaction.
    boolean
    hasClientContext()
    Optional.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static RequestOptions.Builder
    newBuilder()
     
    static RequestOptions.Builder
    newBuilder(RequestOptions prototype)
     
    RequestOptions.Builder
    newBuilderForType()
     
    protected RequestOptions.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static RequestOptions
    parseDelimitedFrom(InputStream input)
     
    static RequestOptions
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RequestOptions
    parseFrom(byte[] data)
     
    static RequestOptions
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RequestOptions
    parseFrom(com.google.protobuf.ByteString data)
     
    static RequestOptions
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RequestOptions
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static RequestOptions
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RequestOptions
    parseFrom(InputStream input)
     
    static RequestOptions
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RequestOptions
    parseFrom(ByteBuffer data)
     
    static RequestOptions
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<RequestOptions>
    parser()
     
    RequestOptions.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • PRIORITY_FIELD_NUMBER

      public static final int PRIORITY_FIELD_NUMBER
      See Also:

    • REQUEST_TAG_FIELD_NUMBER

      public static final int REQUEST_TAG_FIELD_NUMBER
      See Also:

    • TRANSACTION_TAG_FIELD_NUMBER

      public static final int TRANSACTION_TAG_FIELD_NUMBER
      See Also:

    • CLIENT_CONTEXT_FIELD_NUMBER

      public static final int CLIENT_CONTEXT_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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 (for example,
 `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 are removed from the string.
      string request_tag = 2;
      Specified by:
      getRequestTag in interface RequestOptionsOrBuilder
      Returns:
      The requestTag.

    • getRequestTagBytes

      public com.google.protobuf.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 (for example,
 `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 are 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.
 To enable tagging on a transaction, `transaction_tag` must be set to the
 same value for all requests belonging to the same transaction, including
 [BeginTransaction][google.spanner.v1.Spanner.BeginTransaction].
 If this request doesn't belong to any transaction, `transaction_tag` is
 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 are removed from the string.
      string transaction_tag = 3;
      Specified by:
      getTransactionTag in interface RequestOptionsOrBuilder
      Returns:
      The transactionTag.

    • getTransactionTagBytes

      public com.google.protobuf.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.
 To enable tagging on a transaction, `transaction_tag` must be set to the
 same value for all requests belonging to the same transaction, including
 [BeginTransaction][google.spanner.v1.Spanner.BeginTransaction].
 If this request doesn't belong to any transaction, `transaction_tag` is
 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 are removed from the string.
      string transaction_tag = 3;
      Specified by:
      getTransactionTagBytes in interface RequestOptionsOrBuilder
      Returns:
      The bytes for transactionTag.

    • hasClientContext

      public boolean hasClientContext()
       Optional. Optional context that may be needed for some requests.
      .google.spanner.v1.RequestOptions.ClientContext client_context = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasClientContext in interface RequestOptionsOrBuilder
      Returns:
      Whether the clientContext field is set.

    • getClientContext

      public RequestOptions.ClientContext getClientContext()
       Optional. Optional context that may be needed for some requests.
      .google.spanner.v1.RequestOptions.ClientContext client_context = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getClientContext in interface RequestOptionsOrBuilder
      Returns:
      The clientContext.

    • getClientContextOrBuilder

      public RequestOptions.ClientContextOrBuilder getClientContextOrBuilder()
       Optional. Optional context that may be needed for some requests.
      .google.spanner.v1.RequestOptions.ClientContext client_context = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getClientContextOrBuilder in interface RequestOptionsOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RequestOptions parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RequestOptions parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RequestOptions parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RequestOptions parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RequestOptions parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RequestOptions parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RequestOptions parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RequestOptions parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RequestOptions parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RequestOptions parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RequestOptions parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RequestOptions parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public RequestOptions.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.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 com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RequestOptions.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static RequestOptions getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RequestOptions> parser()

    • getParserForType

      public com.google.protobuf.Parser<RequestOptions> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public RequestOptions getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder