Package com.google.spanner.v1

Class KeyRecipe

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.v1.KeyRecipe
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, KeyRecipeOrBuilder, Serializable
public final class KeyRecipe extends com.google.protobuf.GeneratedMessageV3 implements KeyRecipeOrBuilder
 A `KeyRecipe` provides the metadata required to translate reads, mutations,
 and queries into a byte array in "sortable string format" (ssformat)that can
 be used with `Range`s to route requests. Note that the client *must* tolerate
 `KeyRecipe`s that appear to be invalid, since the `KeyRecipe` format may
 change over time. Requests with invalid `KeyRecipe`s should be routed to a
 default server.
Protobuf type google.spanner.v1.KeyRecipe
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    KeyRecipe.Builder
    A `KeyRecipe` provides the metadata required to translate reads, mutations, and queries into a byte array in "sortable string format" (ssformat)that can be used with `Range`s to route requests.
    static final class 
    KeyRecipe.Part
    An ssformat key is composed of a sequence of tag numbers and key column values.
    static interface 
    KeyRecipe.PartOrBuilder
     
    static enum 
    KeyRecipe.TargetCase
     

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

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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 final int
    INDEX_NAME_FIELD_NUMBER
     
    static final int
    OPERATION_UID_FIELD_NUMBER
     
    static final int
    PART_FIELD_NUMBER
     
    static final int
    TABLE_NAME_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
    Description
    boolean
    equals(Object obj)
     
    static KeyRecipe
    getDefaultInstance()
     
    KeyRecipe
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getIndexName()
    An index name, matching the name from the database schema.
    com.google.protobuf.ByteString
    getIndexNameBytes()
    An index name, matching the name from the database schema.
    long
    getOperationUid()
    The UID of a query, matching the UID from `RoutingHint`.
    com.google.protobuf.Parser<KeyRecipe>
    getParserForType()
     
    KeyRecipe.Part
    getPart(int index)
    Parts are in the order they should appear in the encoded key.
    int
    getPartCount()
    Parts are in the order they should appear in the encoded key.
    List<KeyRecipe.Part>
    getPartList()
    Parts are in the order they should appear in the encoded key.
    KeyRecipe.PartOrBuilder
    getPartOrBuilder(int index)
    Parts are in the order they should appear in the encoded key.
    List<? extends KeyRecipe.PartOrBuilder>
    getPartOrBuilderList()
    Parts are in the order they should appear in the encoded key.
    int
    getSerializedSize()
     
    String
    getTableName()
    A table name, matching the name from the database schema.
    com.google.protobuf.ByteString
    getTableNameBytes()
    A table name, matching the name from the database schema.
    KeyRecipe.TargetCase
    getTargetCase()
     
    int
    hashCode()
     
    boolean
    hasIndexName()
    An index name, matching the name from the database schema.
    boolean
    hasOperationUid()
    The UID of a query, matching the UID from `RoutingHint`.
    boolean
    hasTableName()
    A table name, matching the name from the database schema.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static KeyRecipe.Builder
    newBuilder()
     
    static KeyRecipe.Builder
    newBuilder(KeyRecipe prototype)
     
    KeyRecipe.Builder
    newBuilderForType()
     
    protected KeyRecipe.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static KeyRecipe
    parseDelimitedFrom(InputStream input)
     
    static KeyRecipe
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeyRecipe
    parseFrom(byte[] data)
     
    static KeyRecipe
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeyRecipe
    parseFrom(com.google.protobuf.ByteString data)
     
    static KeyRecipe
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeyRecipe
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static KeyRecipe
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeyRecipe
    parseFrom(InputStream input)
     
    static KeyRecipe
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeyRecipe
    parseFrom(ByteBuffer data)
     
    static KeyRecipe
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<KeyRecipe>
    parser()
     
    KeyRecipe.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

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

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getTargetCase

      public KeyRecipe.TargetCase getTargetCase()
      Specified by:
      getTargetCase in interface KeyRecipeOrBuilder

    • hasTableName

      public boolean hasTableName()
       A table name, matching the name from the database schema.
      string table_name = 1;
      Specified by:
      hasTableName in interface KeyRecipeOrBuilder
      Returns:
      Whether the tableName field is set.

    • getTableName

      public String getTableName()
       A table name, matching the name from the database schema.
      string table_name = 1;
      Specified by:
      getTableName in interface KeyRecipeOrBuilder
      Returns:
      The tableName.

    • getTableNameBytes

      public com.google.protobuf.ByteString getTableNameBytes()
       A table name, matching the name from the database schema.
      string table_name = 1;
      Specified by:
      getTableNameBytes in interface KeyRecipeOrBuilder
      Returns:
      The bytes for tableName.

    • hasIndexName

      public boolean hasIndexName()
       An index name, matching the name from the database schema.
      string index_name = 2;
      Specified by:
      hasIndexName in interface KeyRecipeOrBuilder
      Returns:
      Whether the indexName field is set.

    • getIndexName

      public String getIndexName()
       An index name, matching the name from the database schema.
      string index_name = 2;
      Specified by:
      getIndexName in interface KeyRecipeOrBuilder
      Returns:
      The indexName.

    • getIndexNameBytes

      public com.google.protobuf.ByteString getIndexNameBytes()
       An index name, matching the name from the database schema.
      string index_name = 2;
      Specified by:
      getIndexNameBytes in interface KeyRecipeOrBuilder
      Returns:
      The bytes for indexName.

    • hasOperationUid

      public boolean hasOperationUid()
       The UID of a query, matching the UID from `RoutingHint`.
      uint64 operation_uid = 3;
      Specified by:
      hasOperationUid in interface KeyRecipeOrBuilder
      Returns:
      Whether the operationUid field is set.

    • getOperationUid

      public long getOperationUid()
       The UID of a query, matching the UID from `RoutingHint`.
      uint64 operation_uid = 3;
      Specified by:
      getOperationUid in interface KeyRecipeOrBuilder
      Returns:
      The operationUid.

    • getPartList

      public List<KeyRecipe.Part> getPartList()
       Parts are in the order they should appear in the encoded key.
      repeated .google.spanner.v1.KeyRecipe.Part part = 4;
      Specified by:
      getPartList in interface KeyRecipeOrBuilder

    • getPartOrBuilderList

      public List<? extends KeyRecipe.PartOrBuilder> getPartOrBuilderList()
       Parts are in the order they should appear in the encoded key.
      repeated .google.spanner.v1.KeyRecipe.Part part = 4;
      Specified by:
      getPartOrBuilderList in interface KeyRecipeOrBuilder

    • getPartCount

      public int getPartCount()
       Parts are in the order they should appear in the encoded key.
      repeated .google.spanner.v1.KeyRecipe.Part part = 4;
      Specified by:
      getPartCount in interface KeyRecipeOrBuilder

    • getPart

      public KeyRecipe.Part getPart(int index)
       Parts are in the order they should appear in the encoded key.
      repeated .google.spanner.v1.KeyRecipe.Part part = 4;
      Specified by:
      getPart in interface KeyRecipeOrBuilder

    • getPartOrBuilder

      public KeyRecipe.PartOrBuilder getPartOrBuilder(int index)
       Parts are in the order they should appear in the encoded key.
      repeated .google.spanner.v1.KeyRecipe.Part part = 4;
      Specified by:
      getPartOrBuilder in interface KeyRecipeOrBuilder

    • 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 KeyRecipe parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

      public KeyRecipe.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static KeyRecipe.Builder newBuilder()

    • newBuilder

      public static KeyRecipe.Builder newBuilder(KeyRecipe prototype)

    • toBuilder

      public KeyRecipe.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected KeyRecipe.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static KeyRecipe getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<KeyRecipe> 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 KeyRecipe getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder