Package com.google.spanner.v1

Class KeySet

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.spanner.v1.KeySet
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, KeySetOrBuilder, Serializable
public final class KeySet extends com.google.protobuf.GeneratedMessageV3 implements KeySetOrBuilder
 `KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All
 the keys are expected to be in the same table or index. The keys need
 not be sorted in any particular way.

 If the same key is specified multiple times in the set (for example
 if two ranges, two keys, or a key and a range overlap), Cloud Spanner
 behaves as if the key were only specified once.
Protobuf type google.spanner.v1.KeySet
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    KeySet.Builder
    `KeySet` defines a collection of Cloud Spanner keys and/or key ranges.

    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
    ALL_FIELD_NUMBER
     
    static final int
    KEYS_FIELD_NUMBER
     
    static final int
    RANGES_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)
     
    boolean
    getAll()
    For convenience `all` can be set to `true` to indicate that this `KeySet` matches all keys in the table or index.
    static KeySet
    getDefaultInstance()
     
    KeySet
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.ListValue
    getKeys(int index)
    A list of specific keys.
    int
    getKeysCount()
    A list of specific keys.
    List<com.google.protobuf.ListValue>
    getKeysList()
    A list of specific keys.
    com.google.protobuf.ListValueOrBuilder
    getKeysOrBuilder(int index)
    A list of specific keys.
    List<? extends com.google.protobuf.ListValueOrBuilder>
    getKeysOrBuilderList()
    A list of specific keys.
    com.google.protobuf.Parser<KeySet>
    getParserForType()
     
    KeyRange
    getRanges(int index)
    A list of key ranges.
    int
    getRangesCount()
    A list of key ranges.
    List<KeyRange>
    getRangesList()
    A list of key ranges.
    KeyRangeOrBuilder
    getRangesOrBuilder(int index)
    A list of key ranges.
    List<? extends KeyRangeOrBuilder>
    getRangesOrBuilderList()
    A list of key ranges.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static KeySet.Builder
    newBuilder()
     
    static KeySet.Builder
    newBuilder(KeySet prototype)
     
    KeySet.Builder
    newBuilderForType()
     
    protected KeySet.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static KeySet
    parseDelimitedFrom(InputStream input)
     
    static KeySet
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeySet
    parseFrom(byte[] data)
     
    static KeySet
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeySet
    parseFrom(com.google.protobuf.ByteString data)
     
    static KeySet
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeySet
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static KeySet
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeySet
    parseFrom(InputStream input)
     
    static KeySet
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeySet
    parseFrom(ByteBuffer data)
     
    static KeySet
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<KeySet>
    parser()
     
    KeySet.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

    • getKeysList

      public List<com.google.protobuf.ListValue> getKeysList()
       A list of specific keys. Entries in `keys` should have exactly as
 many elements as there are columns in the primary or index key
 with which this `KeySet` is used.  Individual key values are
 encoded as described [here][google.spanner.v1.TypeCode].
      repeated .google.protobuf.ListValue keys = 1;
      Specified by:
      getKeysList in interface KeySetOrBuilder

    • getKeysOrBuilderList

      public List<? extends com.google.protobuf.ListValueOrBuilder> getKeysOrBuilderList()
       A list of specific keys. Entries in `keys` should have exactly as
 many elements as there are columns in the primary or index key
 with which this `KeySet` is used.  Individual key values are
 encoded as described [here][google.spanner.v1.TypeCode].
      repeated .google.protobuf.ListValue keys = 1;
      Specified by:
      getKeysOrBuilderList in interface KeySetOrBuilder

    • getKeysCount

      public int getKeysCount()
       A list of specific keys. Entries in `keys` should have exactly as
 many elements as there are columns in the primary or index key
 with which this `KeySet` is used.  Individual key values are
 encoded as described [here][google.spanner.v1.TypeCode].
      repeated .google.protobuf.ListValue keys = 1;
      Specified by:
      getKeysCount in interface KeySetOrBuilder

    • getKeys

      public com.google.protobuf.ListValue getKeys(int index)
       A list of specific keys. Entries in `keys` should have exactly as
 many elements as there are columns in the primary or index key
 with which this `KeySet` is used.  Individual key values are
 encoded as described [here][google.spanner.v1.TypeCode].
      repeated .google.protobuf.ListValue keys = 1;
      Specified by:
      getKeys in interface KeySetOrBuilder

    • getKeysOrBuilder

      public com.google.protobuf.ListValueOrBuilder getKeysOrBuilder(int index)
       A list of specific keys. Entries in `keys` should have exactly as
 many elements as there are columns in the primary or index key
 with which this `KeySet` is used.  Individual key values are
 encoded as described [here][google.spanner.v1.TypeCode].
      repeated .google.protobuf.ListValue keys = 1;
      Specified by:
      getKeysOrBuilder in interface KeySetOrBuilder

    • getRangesList

      public List<KeyRange> getRangesList()
       A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
      repeated .google.spanner.v1.KeyRange ranges = 2;
      Specified by:
      getRangesList in interface KeySetOrBuilder

    • getRangesOrBuilderList

      public List<? extends KeyRangeOrBuilder> getRangesOrBuilderList()
       A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
      repeated .google.spanner.v1.KeyRange ranges = 2;
      Specified by:
      getRangesOrBuilderList in interface KeySetOrBuilder

    • getRangesCount

      public int getRangesCount()
       A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
      repeated .google.spanner.v1.KeyRange ranges = 2;
      Specified by:
      getRangesCount in interface KeySetOrBuilder

    • getRanges

      public KeyRange getRanges(int index)
       A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
      repeated .google.spanner.v1.KeyRange ranges = 2;
      Specified by:
      getRanges in interface KeySetOrBuilder

    • getRangesOrBuilder

      public KeyRangeOrBuilder getRangesOrBuilder(int index)
       A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
      repeated .google.spanner.v1.KeyRange ranges = 2;
      Specified by:
      getRangesOrBuilder in interface KeySetOrBuilder

    • getAll

      public boolean getAll()
       For convenience `all` can be set to `true` to indicate that this
 `KeySet` matches all keys in the table or index. Note that any keys
 specified in `keys` or `ranges` are only yielded once.
      bool all = 3;
      Specified by:
      getAll in interface KeySetOrBuilder
      Returns:
      The all.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static KeySet.Builder newBuilder()

    • newBuilder

      public static KeySet.Builder newBuilder(KeySet prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static KeySet getDefaultInstance()

    • parser

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

    • getParserForType

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