Class KeySet.Builder (6.89.0)

publicstaticfinalclassKeySet.BuilderextendsGeneratedMessageV3.Builder<KeySet.Builder>implementsKeySetOrBuilder

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()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllPoint(Iterable<? extends ValueList> values)

publicKeySet.BuilderaddAllPoint(Iterable<?extendsValueList>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)

publicKeySet.BuilderaddAllRange(Iterable<?extendsKeyRange>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)

publicKeySet.BuilderaddPoint(ValueListvalue)

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)

publicKeySet.BuilderaddPoint(ValueList.BuilderbuilderForValue)

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)

publicKeySet.BuilderaddPoint(intindex,ValueListvalue)

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)

publicKeySet.BuilderaddPoint(intindex,ValueList.BuilderbuilderForValue)

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()

publicValueList.BuilderaddPointBuilder()

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)

publicValueList.BuilderaddPointBuilder(intindex)

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)

publicKeySet.BuilderaddRange(KeyRangevalue)

A list of key ranges.

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

Parameter
NameDescription
valueKeyRange
Returns
TypeDescription
KeySet.Builder

addRange(KeyRange.Builder builderForValue)

publicKeySet.BuilderaddRange(KeyRange.BuilderbuilderForValue)

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)

publicKeySet.BuilderaddRange(intindex,KeyRangevalue)

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)

publicKeySet.BuilderaddRange(intindex,KeyRange.BuilderbuilderForValue)

A list of key ranges.

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

Parameters
NameDescription
indexint
builderForValueKeyRange.Builder
Returns
TypeDescription
KeySet.Builder

addRangeBuilder()

publicKeyRange.BuilderaddRangeBuilder()

A list of key ranges.

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

Returns
TypeDescription
KeyRange.Builder

addRangeBuilder(int index)

publicKeyRange.BuilderaddRangeBuilder(intindex)

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)

publicKeySet.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
KeySet.Builder
Overrides

build()

publicKeySetbuild()
Returns
TypeDescription
KeySet

buildPartial()

publicKeySetbuildPartial()
Returns
TypeDescription
KeySet

clear()

publicKeySet.Builderclear()
Returns
TypeDescription
KeySet.Builder
Overrides

clearAll()

publicKeySet.BuilderclearAll()

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)

publicKeySet.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
KeySet.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

publicKeySet.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
KeySet.Builder
Overrides

clearPoint()

publicKeySet.BuilderclearPoint()

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()

publicKeySet.BuilderclearRange()

A list of key ranges.

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

Returns
TypeDescription
KeySet.Builder

clone()

publicKeySet.Builderclone()
Returns
TypeDescription
KeySet.Builder
Overrides

getAll()

publicbooleangetAll()

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()

publicKeySetgetDefaultInstanceForType()
Returns
TypeDescription
KeySet

getDescriptorForType()

publicDescriptors.DescriptorgetDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getPoint(int index)

publicValueListgetPoint(intindex)

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)

publicValueList.BuildergetPointBuilder(intindex)

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()

publicList<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()

publicintgetPointCount()

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()

publicList<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)

publicValueListOrBuildergetPointOrBuilder(intindex)

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()

publicList<?extendsValueListOrBuilder>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)

publicKeyRangegetRange(intindex)

A list of key ranges.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
KeyRange

getRangeBuilder(int index)

publicKeyRange.BuildergetRangeBuilder(intindex)

A list of key ranges.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
KeyRange.Builder

getRangeBuilderList()

publicList<KeyRange.Builder>getRangeBuilderList()

A list of key ranges.

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

Returns
TypeDescription
List<Builder>

getRangeCount()

publicintgetRangeCount()

A list of key ranges.

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

Returns
TypeDescription
int

getRangeList()

publicList<KeyRange>getRangeList()

A list of key ranges.

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

Returns
TypeDescription
List<KeyRange>

getRangeOrBuilder(int index)

publicKeyRangeOrBuildergetRangeOrBuilder(intindex)

A list of key ranges.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
KeyRangeOrBuilder

getRangeOrBuilderList()

publicList<?extendsKeyRangeOrBuilder>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()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicKeySet.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KeySet.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

publicKeySet.BuildermergeFrom(Messageother)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
KeySet.Builder
Overrides

mergeFrom(KeySet other)

publicKeySet.BuildermergeFrom(KeySetother)
Parameter
NameDescription
otherKeySet
Returns
TypeDescription
KeySet.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

publicfinalKeySet.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
KeySet.Builder
Overrides

removePoint(int index)

publicKeySet.BuilderremovePoint(intindex)

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)

publicKeySet.BuilderremoveRange(intindex)

A list of key ranges.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
KeySet.Builder

setAll(boolean value)

publicKeySet.BuildersetAll(booleanvalue)

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)

publicKeySet.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
KeySet.Builder
Overrides

setPoint(int index, ValueList value)

publicKeySet.BuildersetPoint(intindex,ValueListvalue)

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)

publicKeySet.BuildersetPoint(intindex,ValueList.BuilderbuilderForValue)

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)

publicKeySet.BuildersetRange(intindex,KeyRangevalue)

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)

publicKeySet.BuildersetRange(intindex,KeyRange.BuilderbuilderForValue)

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)

publicKeySet.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
KeySet.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

publicfinalKeySet.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
KeySet.Builder
Overrides