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

Inheritance

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

Implements

KeySetOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`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
Name	Description
`values`	`Iterable<? extends com.google.spanner.executor.v1.ValueList>`

Returns
Type	Description
`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
Name	Description
`values`	`Iterable<? extends com.google.spanner.executor.v1.KeyRange>`

Returns
Type	Description
`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
Name	Description
`value`	`ValueList`

Returns
Type	Description
`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
Name	Description
`builderForValue`	`ValueList.Builder`

Returns
Type	Description
`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
Name	Description
`index`	`int`
`value`	`ValueList`

Returns
Type	Description
`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
Name	Description
`index`	`int`
`builderForValue`	`ValueList.Builder`

Returns
Type	Description
`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
Type	Description
`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
Name	Description
`index`	`int`

Returns
Type	Description
`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
Name	Description
`value`	`KeyRange`

Returns
Type	Description
`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
Name	Description
`builderForValue`	`KeyRange.Builder`

Returns
Type	Description
`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
Name	Description
`index`	`int`
`value`	`KeyRange`

Returns
Type	Description
`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
Name	Description
`index`	`int`
`builderForValue`	`KeyRange.Builder`

Returns
Type	Description
`KeySet.Builder`

addRangeBuilder()

public KeyRange.Builder addRangeBuilder()

A list of key ranges.

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

Returns
Type	Description
`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
Name	Description
`index`	`int`

Returns
Type	Description
`KeyRange.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public KeySet.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`KeySet.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public KeySet build()

Returns
Type	Description
`KeySet`

buildPartial()

public KeySet buildPartial()

Returns
Type	Description
`KeySet`

clear()

public KeySet.Builder clear()

Returns
Type	Description
`KeySet.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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
Type	Description
`KeySet.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public KeySet.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`KeySet.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public KeySet.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`KeySet.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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
Type	Description
`KeySet.Builder`

clearRange()

public KeySet.Builder clearRange()

A list of key ranges.

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

Returns
Type	Description
`KeySet.Builder`

clone()

public KeySet.Builder clone()

Returns
Type	Description
`KeySet.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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`

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
Name	Description
`index`	`int`

Returns
Type	Description
`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
Type	Description
`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
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`

getRangeBuilder(int index)

public KeyRange.Builder getRangeBuilder(int index)

A list of key ranges.

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`KeyRange.Builder`

getRangeBuilderList()

public List<KeyRange.Builder> getRangeBuilderList()

A list of key ranges.

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

Returns
Type	Description
`List<Builder>`

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>`

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public KeySet.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`KeySet.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public KeySet.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`KeySet.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeFrom(KeySet other)

public KeySet.Builder mergeFrom(KeySet other)

Parameter
Name	Description
`other`	`KeySet`

Returns
Type	Description
`KeySet.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final KeySet.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`KeySet.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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
Name	Description
`index`	`int`

Returns
Type	Description
`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
Name	Description
`index`	`int`

Returns
Type	Description
`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
Name	Description
`value`	`boolean` The all to set.

Returns
Type	Description
`KeySet.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public KeySet.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`KeySet.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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
Name	Description
`index`	`int`
`value`	`ValueList`

Returns
Type	Description
`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
Name	Description
`index`	`int`
`builderForValue`	`ValueList.Builder`

Returns
Type	Description
`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
Name	Description
`index`	`int`
`value`	`KeyRange`

Returns
Type	Description
`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
Name	Description
`index`	`int`
`builderForValue`	`KeyRange.Builder`

Returns
Type	Description
`KeySet.Builder`

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`KeySet.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final KeySet.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`KeySet.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)