Class KeySet (6.57.0)

Version 6.57.0

• 6.80.1 (latest)
• 6.79.0
• 6.77.0
• 6.74.1
• 6.72.0
• 6.71.0
• 6.69.0
• 6.68.0
• 6.66.0
• 6.65.1
• 6.62.0
• 6.60.0
• 6.58.0
• 6.57.0
• 6.56.0
• 6.55.0
• 6.54.0
• 6.53.0
• 6.52.1
• 6.51.0
• 6.50.1
• 6.49.0
• 6.25.1
• 6.24.0
• 6.23.4
• 6.22.0
• 6.21.2
• 6.20.0
• 6.19.1
• 6.18.0
• 6.17.4
• 6.14.1

public final class KeySet extends GeneratedMessageV3 implements KeySetOrBuilder

KeySet defines a collection of Spanner keys and/or key ranges. All the keys are expected to be in the same table. The keys need not be sorted in any particular way.

Protobuf type google.spanner.executor.v1.KeySet

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > KeySet

Implements

KeySetOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ALL_FIELD_NUMBER

public static final int ALL_FIELD_NUMBER

Field Value
Type	Description
int

POINT_FIELD_NUMBER

public static final int POINT_FIELD_NUMBER

Field Value
Type	Description
int

RANGE_FIELD_NUMBER

public static final int RANGE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static KeySet getDefaultInstance()

Returns
Type	Description
KeySet

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static KeySet.Builder newBuilder()

Returns
Type	Description
KeySet.Builder

newBuilder(KeySet prototype)

public static KeySet.Builder newBuilder(KeySet prototype)

Parameter
Name	Description
prototype	KeySet

Returns
Type	Description
KeySet.Builder

parseDelimitedFrom(InputStream input)

public static KeySet parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
KeySet

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KeySet parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
KeySet

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static KeySet parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
KeySet

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
KeySet

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static KeySet parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
KeySet

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static KeySet parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
KeySet

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static KeySet parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
KeySet

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static KeySet parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
KeySet

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static KeySet parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
KeySet

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KeySet parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
KeySet

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static KeySet parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
KeySet

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static KeySet parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
KeySet

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<KeySet> parser()

Returns
Type	Description
Parser<KeySet>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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;

Returns
Type	Description
boolean	The all.

getDefaultInstanceForType()

public KeySet getDefaultInstanceForType()

Returns
Type	Description
KeySet

getParserForType()

public Parser<KeySet> getParserForType()

Returns
Type	Description
Parser<KeySet>

Overrides

GeneratedMessageV3.getParserForType()

getPoint(int index)

public ValueList getPoint(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.

repeated .google.spanner.executor.v1.ValueList point = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
ValueList

getPointCount()

public int getPointCount()

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.

repeated .google.spanner.executor.v1.ValueList point = 1;

Returns
Type	Description
int

getPointList()

public List<ValueList> getPointList()

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.

repeated .google.spanner.executor.v1.ValueList point = 1;

Returns
Type	Description
List<ValueList>

getPointOrBuilder(int index)

public ValueListOrBuilder getPointOrBuilder(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.

repeated .google.spanner.executor.v1.ValueList point = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
ValueListOrBuilder

getPointOrBuilderList()

public List<? extends ValueListOrBuilder> getPointOrBuilderList()

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.

repeated .google.spanner.executor.v1.ValueList point = 1;

Returns
Type	Description
List<? extends com.google.spanner.executor.v1.ValueListOrBuilder>

getRange(int index)

public KeyRange getRange(int index)

A list of key ranges.

repeated .google.spanner.executor.v1.KeyRange range = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
KeyRange

getRangeCount()

public int getRangeCount()

A list of key ranges.

repeated .google.spanner.executor.v1.KeyRange range = 2;

Returns
Type	Description
int

getRangeList()

public List<KeyRange> getRangeList()

A list of key ranges.

repeated .google.spanner.executor.v1.KeyRange range = 2;

Returns
Type	Description
List<KeyRange>

getRangeOrBuilder(int index)

public KeyRangeOrBuilder getRangeOrBuilder(int index)

A list of key ranges.

repeated .google.spanner.executor.v1.KeyRange range = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
KeyRangeOrBuilder

getRangeOrBuilderList()

public List<? extends KeyRangeOrBuilder> getRangeOrBuilderList()

A list of key ranges.

repeated .google.spanner.executor.v1.KeyRange range = 2;

Returns
Type	Description
List<? extends com.google.spanner.executor.v1.KeyRangeOrBuilder>

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public KeySet.Builder newBuilderForType()

Returns
Type	Description
KeySet.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected KeySet.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
KeySet.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public KeySet.Builder toBuilder()

Returns
Type	Description
KeySet.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException