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:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, KeySetOrBuilder, Serializable

public final class KeySet
extends 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static 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

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

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

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL_FIELD_NUMBER
static int	KEYS_FIELD_NUMBER
static 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 and 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 Descriptors.Descriptor	getDescriptor()
ListValue	getKeys(int index) A list of specific keys.
int	getKeysCount() A list of specific keys.
List<ListValue>	getKeysList() A list of specific keys.
ListValueOrBuilder	getKeysOrBuilder(int index) A list of specific keys.
List<? extends ListValueOrBuilder>	getKeysOrBuilderList() A list of specific keys.
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()
UnknownFieldSet	getUnknownFields()
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static KeySet.Builder	newBuilder()
static KeySet.Builder	newBuilder(KeySet prototype)
KeySet.Builder	newBuilderForType()
protected KeySet.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static KeySet	parseDelimitedFrom(InputStream input)
static KeySet	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static KeySet	parseFrom(byte[] data)
static KeySet	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static KeySet	parseFrom(ByteBuffer data)
static KeySet	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static KeySet	parseFrom(ByteString data)
static KeySet	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static KeySet	parseFrom(CodedInputStream input)
static KeySet	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static KeySet	parseFrom(InputStream input)
static KeySet	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<KeySet>	parser()
KeySet.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

KEYS_FIELD_NUMBER

public static final int KEYS_FIELD_NUMBER

See Also:

Constant Field Values

RANGES_FIELD_NUMBER

public static final int RANGES_FIELD_NUMBER

See Also:

Constant Field Values

ALL_FIELD_NUMBER

public static final int ALL_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getKeysList

public List<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 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 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 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 MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static KeySet parseFrom(ByteBuffer data)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static KeySet parseFrom(ByteBuffer data,
                               ExtensionRegistryLite extensionRegistry)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static KeySet parseFrom(ByteString data)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static KeySet parseFrom(ByteString data,
                               ExtensionRegistryLite extensionRegistry)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static KeySet parseFrom(byte[] data)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static KeySet parseFrom(byte[] data,
                               ExtensionRegistryLite extensionRegistry)
                        throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static KeySet parseFrom(InputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static KeySet parseFrom(InputStream input,
                               ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static KeySet parseDelimitedFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static KeySet parseDelimitedFrom(InputStream input,
                                        ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseFrom

public static KeySet parseFrom(CodedInputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static KeySet parseFrom(CodedInputStream input,
                               ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

newBuilderForType

public KeySet.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface 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 Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected KeySet.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static KeySet getDefaultInstance()

parser

public static Parser<KeySet> parser()

getParserForType

public Parser<KeySet> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public KeySet getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder