Package com.google.spanner.v1

Class RequestOptions

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RequestOptionsOrBuilder, Serializable
    public final class RequestOptions
extends com.google.protobuf.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 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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field 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

    • Field Detail

      • 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​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.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.

      • 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 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 (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 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.
 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 com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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​(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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

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