Class KeySet.Builder (6.58.0)

public static final class KeySet.Builder extends GeneratedMessageV3.Builder<KeySet.Builder> 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 Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllPoint(Iterable<? extends ValueList> values)

public KeySet.Builder addAllPoint(Iterable<? extends ValueList> values)

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
NameDescription
valuesIterable<? extends com.google.spanner.executor.v1.ValueList>
Returns
TypeDescription
KeySet.Builder

addAllRange(Iterable<? extends KeyRange> values)

public KeySet.Builder addAllRange(Iterable<? extends KeyRange> values)

A list of key ranges.

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

Parameter
NameDescription
valuesIterable<? extends com.google.spanner.executor.v1.KeyRange>
Returns
TypeDescription
KeySet.Builder

addPoint(ValueList value)

public KeySet.Builder addPoint(ValueList value)

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
NameDescription
valueValueList
Returns
TypeDescription
KeySet.Builder

addPoint(ValueList.Builder builderForValue)

public KeySet.Builder addPoint(ValueList.Builder builderForValue)

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
NameDescription
builderForValueValueList.Builder
Returns
TypeDescription
KeySet.Builder

addPoint(int index, ValueList value)

public KeySet.Builder addPoint(int index, ValueList value)

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;

Parameters
NameDescription
indexint
valueValueList
Returns
TypeDescription
KeySet.Builder

addPoint(int index, ValueList.Builder builderForValue)

public KeySet.Builder addPoint(int index, ValueList.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueValueList.Builder
Returns
TypeDescription
KeySet.Builder

addPointBuilder()

public ValueList.Builder addPointBuilder()

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
TypeDescription
ValueList.Builder

addPointBuilder(int index)

public ValueList.Builder addPointBuilder(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
NameDescription
indexint
Returns
TypeDescription
ValueList.Builder

addRange(KeyRange value)

public KeySet.Builder addRange(KeyRange value)

A list of key ranges.

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

Parameter
NameDescription
valueKeyRange
Returns
TypeDescription
KeySet.Builder

addRange(KeyRange.Builder builderForValue)

public KeySet.Builder addRange(KeyRange.Builder builderForValue)

A list of key ranges.

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

Parameter
NameDescription
builderForValueKeyRange.Builder
Returns
TypeDescription
KeySet.Builder

addRange(int index, KeyRange value)

public KeySet.Builder addRange(int index, KeyRange value)

A list of key ranges.

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

Parameters
NameDescription
indexint
valueKeyRange
Returns
TypeDescription
KeySet.Builder

addRange(int index, KeyRange.Builder builderForValue)

public KeySet.Builder addRange(int index, KeyRange.Builder builderForValue)

A list of key ranges.

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

Parameters
NameDescription
indexint
builderForValueKeyRange.Builder
Returns
TypeDescription
KeySet.Builder

addRangeBuilder()

public KeyRange.Builder addRangeBuilder()

A list of key ranges.

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

Returns
TypeDescription
KeyRange.Builder

addRangeBuilder(int index)

public KeyRange.Builder addRangeBuilder(int index)

A list of key ranges.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
KeyRange.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public KeySet.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
KeySet.Builder
Overrides

build()

public KeySet build()
Returns
TypeDescription
KeySet

buildPartial()

public KeySet buildPartial()
Returns
TypeDescription
KeySet

clear()

public KeySet.Builder clear()
Returns
TypeDescription
KeySet.Builder
Overrides

clearAll()

public KeySet.Builder clearAll()

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
TypeDescription
KeySet.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public KeySet.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
KeySet.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public KeySet.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
KeySet.Builder
Overrides

clearPoint()

public KeySet.Builder clearPoint()

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
TypeDescription
KeySet.Builder

clearRange()

public KeySet.Builder clearRange()

A list of key ranges.

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

Returns
TypeDescription
KeySet.Builder

clone()

public KeySet.Builder clone()
Returns
TypeDescription
KeySet.Builder
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
TypeDescription
boolean

The all.

getDefaultInstanceForType()

public KeySet getDefaultInstanceForType()
Returns
TypeDescription
KeySet

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
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
NameDescription
indexint
Returns
TypeDescription
ValueList

getPointBuilder(int index)

public ValueList.Builder getPointBuilder(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
NameDescription
indexint
Returns
TypeDescription
ValueList.Builder

getPointBuilderList()

public List<ValueList.Builder> getPointBuilderList()

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
TypeDescription
List<Builder>

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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
KeyRange

getRangeBuilder(int index)

public KeyRange.Builder getRangeBuilder(int index)

A list of key ranges.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
KeyRange.Builder

getRangeBuilderList()

public List<KeyRange.Builder> getRangeBuilderList()

A list of key ranges.

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

Returns
TypeDescription
List<Builder>

getRangeCount()

public int getRangeCount()

A list of key ranges.

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

Returns
TypeDescription
int

getRangeList()

public List<KeyRange> getRangeList()

A list of key ranges.

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

Returns
TypeDescription
List<KeyRange>

getRangeOrBuilder(int index)

public KeyRangeOrBuilder getRangeOrBuilder(int index)

A list of key ranges.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
KeyRangeOrBuilder

getRangeOrBuilderList()

public List<? extends KeyRangeOrBuilder> getRangeOrBuilderList()

A list of key ranges.

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

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public KeySet.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KeySet.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public KeySet.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
KeySet.Builder
Overrides

mergeFrom(KeySet other)

public KeySet.Builder mergeFrom(KeySet other)
Parameter
NameDescription
otherKeySet
Returns
TypeDescription
KeySet.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final KeySet.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
KeySet.Builder
Overrides

removePoint(int index)

public KeySet.Builder removePoint(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
NameDescription
indexint
Returns
TypeDescription
KeySet.Builder

removeRange(int index)

public KeySet.Builder removeRange(int index)

A list of key ranges.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
KeySet.Builder

setAll(boolean value)

public KeySet.Builder setAll(boolean value)

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;

Parameter
NameDescription
valueboolean

The all to set.

Returns
TypeDescription
KeySet.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public KeySet.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
KeySet.Builder
Overrides

setPoint(int index, ValueList value)

public KeySet.Builder setPoint(int index, ValueList value)

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;

Parameters
NameDescription
indexint
valueValueList
Returns
TypeDescription
KeySet.Builder

setPoint(int index, ValueList.Builder builderForValue)

public KeySet.Builder setPoint(int index, ValueList.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueValueList.Builder
Returns
TypeDescription
KeySet.Builder

setRange(int index, KeyRange value)

public KeySet.Builder setRange(int index, KeyRange value)

A list of key ranges.

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

Parameters
NameDescription
indexint
valueKeyRange
Returns
TypeDescription
KeySet.Builder

setRange(int index, KeyRange.Builder builderForValue)

public KeySet.Builder setRange(int index, KeyRange.Builder builderForValue)

A list of key ranges.

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

Parameters
NameDescription
indexint
builderForValueKeyRange.Builder
Returns
TypeDescription
KeySet.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public KeySet.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
KeySet.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final KeySet.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
KeySet.Builder
Overrides