Class KeySet (6.72.0)

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

Implements

KeySetOrBuilder

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

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

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public KeySet.Builder toBuilder()
Returns
Type Description
KeySet.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException