Package com.google.spanner.v1

Class KeyRecipe.Part

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.v1.KeyRecipe.Part
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, KeyRecipe.PartOrBuilder, Serializable
Enclosing class:
KeyRecipe
public static final class KeyRecipe.Part extends com.google.protobuf.GeneratedMessageV3 implements KeyRecipe.PartOrBuilder
 An ssformat key is composed of a sequence of tag numbers and key column
 values. `Part` represents a single tag or key column value.
Protobuf type google.spanner.v1.KeyRecipe.Part
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    KeyRecipe.Part.Builder
    An ssformat key is composed of a sequence of tag numbers and key column values.
    static enum 
    KeyRecipe.Part.NullOrder
    The null order of the key column.
    static enum 
    KeyRecipe.Part.Order
    The remaining fields encode column values.
    static enum 
    KeyRecipe.Part.ValueTypeCase
     

    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
    IDENTIFIER_FIELD_NUMBER
     
    static final int
    NULL_ORDER_FIELD_NUMBER
     
    static final int
    ORDER_FIELD_NUMBER
     
    static final int
    RANDOM_FIELD_NUMBER
     
    static final int
    STRUCT_IDENTIFIERS_FIELD_NUMBER
     
    static final int
    TAG_FIELD_NUMBER
     
    static final int
    TYPE_FIELD_NUMBER
     
    static final int
    VALUE_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.Part
    getDefaultInstance()
     
    KeyRecipe.Part
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getIdentifier()
    `identifier` is the name of the column or query parameter.
    com.google.protobuf.ByteString
    getIdentifierBytes()
    `identifier` is the name of the column or query parameter.
    KeyRecipe.Part.NullOrder
    getNullOrder()
    How NULLs are represented in the encoded key part.
    int
    getNullOrderValue()
    How NULLs are represented in the encoded key part.
    KeyRecipe.Part.Order
    getOrder()
    Whether the key column is sorted ascending or descending.
    int
    getOrderValue()
    Whether the key column is sorted ascending or descending.
    com.google.protobuf.Parser<KeyRecipe.Part>
    getParserForType()
     
    boolean
    getRandom()
    If true, the client is responsible to fill in the value randomly.
    int
    getSerializedSize()
     
    int
    getStructIdentifiers(int index)
    It is a repeated field to support fetching key columns from nested structs, such as `STRUCT` query parameters.
    int
    getStructIdentifiersCount()
    It is a repeated field to support fetching key columns from nested structs, such as `STRUCT` query parameters.
    List<Integer>
    getStructIdentifiersList()
    It is a repeated field to support fetching key columns from nested structs, such as `STRUCT` query parameters.
    int
    getTag()
    If non-zero, `tag` is the only field present in this `Part`.
    Type
    getType()
    The type of the key part.
    TypeOrBuilder
    getTypeOrBuilder()
    The type of the key part.
    com.google.protobuf.Value
    getValue()
    The constant value of the key part.
    com.google.protobuf.ValueOrBuilder
    getValueOrBuilder()
    The constant value of the key part.
    KeyRecipe.Part.ValueTypeCase
    getValueTypeCase()
     
    int
    hashCode()
     
    boolean
    hasIdentifier()
    `identifier` is the name of the column or query parameter.
    boolean
    hasRandom()
    If true, the client is responsible to fill in the value randomly.
    boolean
    hasType()
    The type of the key part.
    boolean
    hasValue()
    The constant value of the key part.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static KeyRecipe.Part.Builder
    newBuilder()
     
    static KeyRecipe.Part.Builder
    newBuilder(KeyRecipe.Part prototype)
     
    KeyRecipe.Part.Builder
    newBuilderForType()
     
    protected KeyRecipe.Part.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static KeyRecipe.Part
    parseDelimitedFrom(InputStream input)
     
    static KeyRecipe.Part
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeyRecipe.Part
    parseFrom(byte[] data)
     
    static KeyRecipe.Part
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeyRecipe.Part
    parseFrom(com.google.protobuf.ByteString data)
     
    static KeyRecipe.Part
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeyRecipe.Part
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static KeyRecipe.Part
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeyRecipe.Part
    parseFrom(InputStream input)
     
    static KeyRecipe.Part
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeyRecipe.Part
    parseFrom(ByteBuffer data)
     
    static KeyRecipe.Part
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<KeyRecipe.Part>
    parser()
     
    KeyRecipe.Part.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

    • getValueTypeCase

      public KeyRecipe.Part.ValueTypeCase getValueTypeCase()
      Specified by:
      getValueTypeCase in interface KeyRecipe.PartOrBuilder

    • getTag

      public int getTag()
       If non-zero, `tag` is the only field present in this `Part`. The part
 is encoded by appending `tag` to the ssformat key.
      uint32 tag = 1;
      Specified by:
      getTag in interface KeyRecipe.PartOrBuilder
      Returns:
      The tag.

    • getOrderValue

      public int getOrderValue()
       Whether the key column is sorted ascending or descending. Only present
 if `tag` is zero.
      .google.spanner.v1.KeyRecipe.Part.Order order = 2;
      Specified by:
      getOrderValue in interface KeyRecipe.PartOrBuilder
      Returns:
      The enum numeric value on the wire for order.

    • getOrder

      public KeyRecipe.Part.Order getOrder()
       Whether the key column is sorted ascending or descending. Only present
 if `tag` is zero.
      .google.spanner.v1.KeyRecipe.Part.Order order = 2;
      Specified by:
      getOrder in interface KeyRecipe.PartOrBuilder
      Returns:
      The order.

    • getNullOrderValue

      public int getNullOrderValue()
       How NULLs are represented in the encoded key part. Only present if `tag`
 is zero.
      .google.spanner.v1.KeyRecipe.Part.NullOrder null_order = 3;
      Specified by:
      getNullOrderValue in interface KeyRecipe.PartOrBuilder
      Returns:
      The enum numeric value on the wire for nullOrder.

    • getNullOrder

      public KeyRecipe.Part.NullOrder getNullOrder()
       How NULLs are represented in the encoded key part. Only present if `tag`
 is zero.
      .google.spanner.v1.KeyRecipe.Part.NullOrder null_order = 3;
      Specified by:
      getNullOrder in interface KeyRecipe.PartOrBuilder
      Returns:
      The nullOrder.

    • hasType

      public boolean hasType()
       The type of the key part. Only present if `tag` is zero.
      .google.spanner.v1.Type type = 4;
      Specified by:
      hasType in interface KeyRecipe.PartOrBuilder
      Returns:
      Whether the type field is set.

    • getType

      public Type getType()
       The type of the key part. Only present if `tag` is zero.
      .google.spanner.v1.Type type = 4;
      Specified by:
      getType in interface KeyRecipe.PartOrBuilder
      Returns:
      The type.

    • getTypeOrBuilder

      public TypeOrBuilder getTypeOrBuilder()
       The type of the key part. Only present if `tag` is zero.
      .google.spanner.v1.Type type = 4;
      Specified by:
      getTypeOrBuilder in interface KeyRecipe.PartOrBuilder

    • hasIdentifier

      public boolean hasIdentifier()
       `identifier` is the name of the column or query parameter.
      string identifier = 5;
      Specified by:
      hasIdentifier in interface KeyRecipe.PartOrBuilder
      Returns:
      Whether the identifier field is set.

    • getIdentifier

      public String getIdentifier()
       `identifier` is the name of the column or query parameter.
      string identifier = 5;
      Specified by:
      getIdentifier in interface KeyRecipe.PartOrBuilder
      Returns:
      The identifier.

    • getIdentifierBytes

      public com.google.protobuf.ByteString getIdentifierBytes()
       `identifier` is the name of the column or query parameter.
      string identifier = 5;
      Specified by:
      getIdentifierBytes in interface KeyRecipe.PartOrBuilder
      Returns:
      The bytes for identifier.

    • hasValue

      public boolean hasValue()
       The constant value of the key part.
 It is present when query uses a constant as a part of the key.
      .google.protobuf.Value value = 6;
      Specified by:
      hasValue in interface KeyRecipe.PartOrBuilder
      Returns:
      Whether the value field is set.

    • getValue

      public com.google.protobuf.Value getValue()
       The constant value of the key part.
 It is present when query uses a constant as a part of the key.
      .google.protobuf.Value value = 6;
      Specified by:
      getValue in interface KeyRecipe.PartOrBuilder
      Returns:
      The value.

    • getValueOrBuilder

      public com.google.protobuf.ValueOrBuilder getValueOrBuilder()
       The constant value of the key part.
 It is present when query uses a constant as a part of the key.
      .google.protobuf.Value value = 6;
      Specified by:
      getValueOrBuilder in interface KeyRecipe.PartOrBuilder

    • hasRandom

      public boolean hasRandom()
       If true, the client is responsible to fill in the value randomly.
 It's relevant only for the INT64 type.
      bool random = 8;
      Specified by:
      hasRandom in interface KeyRecipe.PartOrBuilder
      Returns:
      Whether the random field is set.

    • getRandom

      public boolean getRandom()
       If true, the client is responsible to fill in the value randomly.
 It's relevant only for the INT64 type.
      bool random = 8;
      Specified by:
      getRandom in interface KeyRecipe.PartOrBuilder
      Returns:
      The random.

    • getStructIdentifiersList

      public List<Integer> getStructIdentifiersList()
       It is a repeated field to support fetching key columns from nested
 structs, such as `STRUCT` query parameters.
      repeated int32 struct_identifiers = 7;
      Specified by:
      getStructIdentifiersList in interface KeyRecipe.PartOrBuilder
      Returns:
      A list containing the structIdentifiers.

    • getStructIdentifiersCount

      public int getStructIdentifiersCount()
       It is a repeated field to support fetching key columns from nested
 structs, such as `STRUCT` query parameters.
      repeated int32 struct_identifiers = 7;
      Specified by:
      getStructIdentifiersCount in interface KeyRecipe.PartOrBuilder
      Returns:
      The count of structIdentifiers.

    • getStructIdentifiers

      public int getStructIdentifiers(int index)
       It is a repeated field to support fetching key columns from nested
 structs, such as `STRUCT` query parameters.
      repeated int32 struct_identifiers = 7;
      Specified by:
      getStructIdentifiers in interface KeyRecipe.PartOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The structIdentifiers at the given index.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static KeyRecipe.Part 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.Part parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static KeyRecipe.Part.Builder newBuilder()

    • newBuilder

      public static KeyRecipe.Part.Builder newBuilder(KeyRecipe.Part prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static KeyRecipe.Part getDefaultInstance()

    • parser

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

    • getParserForType

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