Class KeySet.Builder (6.56.0)

Version 6.56.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 static final class KeySet.Builder extends GeneratedMessageV3.Builder<KeySet.Builder> implements KeySetOrBuilder

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

If the same key is specified multiple times in the set (for example if two ranges, two keys, or a key and a range overlap), Cloud Spanner behaves as if the key were only specified once.

Protobuf type google.spanner.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

addAllKeys(Iterable<? extends ListValue> values)

public KeySet.Builder addAllKeys(Iterable<? extends ListValue> 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. Individual key values are encoded as described here.

repeated .google.protobuf.ListValue keys = 1;

Parameter
Name	Description
values	Iterable<? extends com.google.protobuf.ListValue>

Returns
Type	Description
KeySet.Builder

addAllRanges(Iterable<? extends KeyRange> values)

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

A list of key ranges. See KeyRange for more information about key range specifications.

repeated .google.spanner.v1.KeyRange ranges = 2;

Parameter
Name	Description
values	Iterable<? extends com.google.spanner.v1.KeyRange>

Returns
Type	Description
KeySet.Builder

addKeys(ListValue value)

public KeySet.Builder addKeys(ListValue 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. Individual key values are encoded as described here.

repeated .google.protobuf.ListValue keys = 1;

Parameter
Name	Description
value	ListValue

Returns
Type	Description
KeySet.Builder

addKeys(ListValue.Builder builderForValue)

public KeySet.Builder addKeys(ListValue.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. Individual key values are encoded as described here.

repeated .google.protobuf.ListValue keys = 1;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
KeySet.Builder

addKeys(int index, ListValue value)

public KeySet.Builder addKeys(int index, ListValue 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. Individual key values are encoded as described here.

repeated .google.protobuf.ListValue keys = 1;

Parameters
Name	Description
index	int
value	ListValue

Returns
Type	Description
KeySet.Builder

addKeys(int index, ListValue.Builder builderForValue)

public KeySet.Builder addKeys(int index, ListValue.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. Individual key values are encoded as described here.

repeated .google.protobuf.ListValue keys = 1;

Parameters
Name	Description
index	int
builderForValue	Builder

Returns
Type	Description
KeySet.Builder

addKeysBuilder()

public ListValue.Builder addKeysBuilder()

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. Individual key values are encoded as described here.

repeated .google.protobuf.ListValue keys = 1;

Returns
Type	Description
Builder

addKeysBuilder(int index)

public ListValue.Builder addKeysBuilder(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. Individual key values are encoded as described here.

repeated .google.protobuf.ListValue keys = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Builder

addRanges(KeyRange value)

public KeySet.Builder addRanges(KeyRange value)

A list of key ranges. See KeyRange for more information about key range specifications.

repeated .google.spanner.v1.KeyRange ranges = 2;

Parameter
Name	Description
value	KeyRange

Returns
Type	Description
KeySet.Builder

addRanges(KeyRange.Builder builderForValue)

public KeySet.Builder addRanges(KeyRange.Builder builderForValue)

A list of key ranges. See KeyRange for more information about key range specifications.

repeated .google.spanner.v1.KeyRange ranges = 2;

Parameter
Name	Description
builderForValue	KeyRange.Builder

Returns
Type	Description
KeySet.Builder

addRanges(int index, KeyRange value)

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

A list of key ranges. See KeyRange for more information about key range specifications.

repeated .google.spanner.v1.KeyRange ranges = 2;

Parameters
Name	Description
index	int
value	KeyRange

Returns
Type	Description
KeySet.Builder

addRanges(int index, KeyRange.Builder builderForValue)

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

A list of key ranges. See KeyRange for more information about key range specifications.

repeated .google.spanner.v1.KeyRange ranges = 2;

Parameters
Name	Description
index	int
builderForValue	KeyRange.Builder

Returns
Type	Description
KeySet.Builder

addRangesBuilder()

public KeyRange.Builder addRangesBuilder()

A list of key ranges. See KeyRange for more information about key range specifications.

repeated .google.spanner.v1.KeyRange ranges = 2;

Returns
Type	Description
KeyRange.Builder

addRangesBuilder(int index)

public KeyRange.Builder addRangesBuilder(int index)

A list of key ranges. See KeyRange for more information about key range specifications.

repeated .google.spanner.v1.KeyRange ranges = 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)

clearKeys()

public KeySet.Builder clearKeys()

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. Individual key values are encoded as described here.

repeated .google.protobuf.ListValue keys = 1;

Returns
Type	Description
KeySet.Builder

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)

clearRanges()

public KeySet.Builder clearRanges()

A list of key ranges. See KeyRange for more information about key range specifications.

repeated .google.spanner.v1.KeyRange ranges = 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()

getKeys(int index)

public ListValue getKeys(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. Individual key values are encoded as described here.

repeated .google.protobuf.ListValue keys = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
ListValue

getKeysBuilder(int index)

public ListValue.Builder getKeysBuilder(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. Individual key values are encoded as described here.

repeated .google.protobuf.ListValue keys = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Builder

getKeysBuilderList()

public List<ListValue.Builder> getKeysBuilderList()

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. Individual key values are encoded as described here.

repeated .google.protobuf.ListValue keys = 1;

Returns
Type	Description
List<Builder>

getKeysCount()

public int getKeysCount()

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. Individual key values are encoded as described here.

repeated .google.protobuf.ListValue keys = 1;

Returns
Type	Description
int

getKeysList()

public List<ListValue> getKeysList()

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. Individual key values are encoded as described here.

repeated .google.protobuf.ListValue keys = 1;

Returns
Type	Description
List<ListValue>

getKeysOrBuilder(int index)

public ListValueOrBuilder getKeysOrBuilder(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. Individual key values are encoded as described here.

repeated .google.protobuf.ListValue keys = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
ListValueOrBuilder

getKeysOrBuilderList()

public List<? extends ListValueOrBuilder> getKeysOrBuilderList()

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. Individual key values are encoded as described here.

repeated .google.protobuf.ListValue keys = 1;

Returns
Type	Description
List<? extends com.google.protobuf.ListValueOrBuilder>

getRanges(int index)

public KeyRange getRanges(int index)

A list of key ranges. See KeyRange for more information about key range specifications.

repeated .google.spanner.v1.KeyRange ranges = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
KeyRange

getRangesBuilder(int index)

public KeyRange.Builder getRangesBuilder(int index)

A list of key ranges. See KeyRange for more information about key range specifications.

repeated .google.spanner.v1.KeyRange ranges = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
KeyRange.Builder

getRangesBuilderList()

public List<KeyRange.Builder> getRangesBuilderList()

A list of key ranges. See KeyRange for more information about key range specifications.

repeated .google.spanner.v1.KeyRange ranges = 2;

Returns
Type	Description
List<Builder>

getRangesCount()

public int getRangesCount()

A list of key ranges. See KeyRange for more information about key range specifications.

repeated .google.spanner.v1.KeyRange ranges = 2;

Returns
Type	Description
int

getRangesList()

public List<KeyRange> getRangesList()

A list of key ranges. See KeyRange for more information about key range specifications.

repeated .google.spanner.v1.KeyRange ranges = 2;

Returns
Type	Description
List<KeyRange>

getRangesOrBuilder(int index)

public KeyRangeOrBuilder getRangesOrBuilder(int index)

A list of key ranges. See KeyRange for more information about key range specifications.

repeated .google.spanner.v1.KeyRange ranges = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
KeyRangeOrBuilder

getRangesOrBuilderList()

public List<? extends KeyRangeOrBuilder> getRangesOrBuilderList()

A list of key ranges. See KeyRange for more information about key range specifications.

repeated .google.spanner.v1.KeyRange ranges = 2;

Returns
Type	Description
List<? extends com.google.spanner.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)

removeKeys(int index)

public KeySet.Builder removeKeys(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. Individual key values are encoded as described here.

repeated .google.protobuf.ListValue keys = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
KeySet.Builder

removeRanges(int index)

public KeySet.Builder removeRanges(int index)

A list of key ranges. See KeyRange for more information about key range specifications.

repeated .google.spanner.v1.KeyRange ranges = 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)

setKeys(int index, ListValue value)

public KeySet.Builder setKeys(int index, ListValue 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. Individual key values are encoded as described here.

repeated .google.protobuf.ListValue keys = 1;

Parameters
Name	Description
index	int
value	ListValue

Returns
Type	Description
KeySet.Builder

setKeys(int index, ListValue.Builder builderForValue)

public KeySet.Builder setKeys(int index, ListValue.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. Individual key values are encoded as described here.

repeated .google.protobuf.ListValue keys = 1;

Parameters
Name	Description
index	int
builderForValue	Builder

Returns
Type	Description
KeySet.Builder

setRanges(int index, KeyRange value)

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

A list of key ranges. See KeyRange for more information about key range specifications.

repeated .google.spanner.v1.KeyRange ranges = 2;

Parameters
Name	Description
index	int
value	KeyRange

Returns
Type	Description
KeySet.Builder

setRanges(int index, KeyRange.Builder builderForValue)

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

A list of key ranges. See KeyRange for more information about key range specifications.

repeated .google.spanner.v1.KeyRange ranges = 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)