com.google.spanner.v1

Class KeySet.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<KeySet.Builder>

com.google.spanner.v1.KeySet.Builder

All Implemented Interfaces:

Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, KeySetOrBuilder, Cloneable

Enclosing class:

KeySet

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

Method Summary

Modifier and Type	Method and Description
KeySet.Builder	addAllKeys(Iterable<? extends ListValue> values) A list of specific keys.
KeySet.Builder	addAllRanges(Iterable<? extends KeyRange> values) A list of key ranges.
KeySet.Builder	addKeys(int index, ListValue.Builder builderForValue) A list of specific keys.
KeySet.Builder	addKeys(int index, ListValue value) A list of specific keys.
KeySet.Builder	addKeys(ListValue.Builder builderForValue) A list of specific keys.
KeySet.Builder	addKeys(ListValue value) A list of specific keys.
ListValue.Builder	addKeysBuilder() A list of specific keys.
ListValue.Builder	addKeysBuilder(int index) A list of specific keys.
KeySet.Builder	addRanges(int index, KeyRange.Builder builderForValue) A list of key ranges.
KeySet.Builder	addRanges(int index, KeyRange value) A list of key ranges.
KeySet.Builder	addRanges(KeyRange.Builder builderForValue) A list of key ranges.
KeySet.Builder	addRanges(KeyRange value) A list of key ranges.
KeyRange.Builder	addRangesBuilder() A list of key ranges.
KeyRange.Builder	addRangesBuilder(int index) A list of key ranges.
KeySet.Builder	addRepeatedField(Descriptors.FieldDescriptor field, Object value)
KeySet	build()
KeySet	buildPartial()
KeySet.Builder	clear()
KeySet.Builder	clearAll() For convenience `all` can be set to `true` to indicate that this `KeySet` matches all keys in the table or index.
KeySet.Builder	clearField(Descriptors.FieldDescriptor field)
KeySet.Builder	clearKeys() A list of specific keys.
KeySet.Builder	clearOneof(Descriptors.OneofDescriptor oneof)
KeySet.Builder	clearRanges() A list of key ranges.
KeySet.Builder	clone()
boolean	getAll() For convenience `all` can be set to `true` to indicate that this `KeySet` matches all keys in the table or index.
KeySet	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
ListValue	getKeys(int index) A list of specific keys.
ListValue.Builder	getKeysBuilder(int index) A list of specific keys.
List<ListValue.Builder>	getKeysBuilderList() A list of specific keys.
int	getKeysCount() A list of specific keys.
List<ListValue>	getKeysList() A list of specific keys.
ListValueOrBuilder	getKeysOrBuilder(int index) A list of specific keys.
List<? extends ListValueOrBuilder>	getKeysOrBuilderList() A list of specific keys.
KeyRange	getRanges(int index) A list of key ranges.
KeyRange.Builder	getRangesBuilder(int index) A list of key ranges.
List<KeyRange.Builder>	getRangesBuilderList() A list of key ranges.
int	getRangesCount() A list of key ranges.
List<KeyRange>	getRangesList() A list of key ranges.
KeyRangeOrBuilder	getRangesOrBuilder(int index) A list of key ranges.
List<? extends KeyRangeOrBuilder>	getRangesOrBuilderList() A list of key ranges.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
KeySet.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
KeySet.Builder	mergeFrom(KeySet other)
KeySet.Builder	mergeFrom(Message other)
KeySet.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)
KeySet.Builder	removeKeys(int index) A list of specific keys.
KeySet.Builder	removeRanges(int index) A list of key ranges.
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.
KeySet.Builder	setField(Descriptors.FieldDescriptor field, Object value)
KeySet.Builder	setKeys(int index, ListValue.Builder builderForValue) A list of specific keys.
KeySet.Builder	setKeys(int index, ListValue value) A list of specific keys.
KeySet.Builder	setRanges(int index, KeyRange.Builder builderForValue) A list of key ranges.
KeySet.Builder	setRanges(int index, KeyRange value) A list of key ranges.
KeySet.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
KeySet.Builder	setUnknownFields(UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<KeySet.Builder>

clear

public KeySet.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<KeySet.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<KeySet.Builder>

getDefaultInstanceForType

public KeySet getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public KeySet build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public KeySet buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public KeySet.Builder clone()

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<KeySet.Builder>

setField

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

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<KeySet.Builder>

clearField

public KeySet.Builder clearField(Descriptors.FieldDescriptor field)

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<KeySet.Builder>

clearOneof

public KeySet.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<KeySet.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<KeySet.Builder>

addRepeatedField

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

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<KeySet.Builder>

mergeFrom

public KeySet.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<KeySet.Builder>

mergeFrom

public KeySet.Builder mergeFrom(KeySet other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<KeySet.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<KeySet.Builder>

Throws:

IOException

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][google.spanner.v1.TypeCode].
 

repeated .google.protobuf.ListValue keys = 1;

Specified by:

getKeysList in interface KeySetOrBuilder

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][google.spanner.v1.TypeCode].
 

repeated .google.protobuf.ListValue keys = 1;

Specified by:

getKeysCount in interface KeySetOrBuilder

getKeys

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][google.spanner.v1.TypeCode].
 

repeated .google.protobuf.ListValue keys = 1;

Specified by:

getKeys in interface KeySetOrBuilder

setKeys

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][google.spanner.v1.TypeCode].
 

repeated .google.protobuf.ListValue keys = 1;

setKeys

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][google.spanner.v1.TypeCode].
 

repeated .google.protobuf.ListValue keys = 1;

addKeys

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][google.spanner.v1.TypeCode].
 

repeated .google.protobuf.ListValue keys = 1;

addKeys

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][google.spanner.v1.TypeCode].
 

repeated .google.protobuf.ListValue keys = 1;

addKeys

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][google.spanner.v1.TypeCode].
 

repeated .google.protobuf.ListValue keys = 1;

addKeys

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][google.spanner.v1.TypeCode].
 

repeated .google.protobuf.ListValue keys = 1;

addAllKeys

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][google.spanner.v1.TypeCode].
 

repeated .google.protobuf.ListValue keys = 1;

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][google.spanner.v1.TypeCode].
 

repeated .google.protobuf.ListValue keys = 1;

removeKeys

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][google.spanner.v1.TypeCode].
 

repeated .google.protobuf.ListValue keys = 1;

getKeysBuilder

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][google.spanner.v1.TypeCode].
 

repeated .google.protobuf.ListValue keys = 1;

getKeysOrBuilder

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][google.spanner.v1.TypeCode].
 

repeated .google.protobuf.ListValue keys = 1;

Specified by:

getKeysOrBuilder in interface KeySetOrBuilder

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][google.spanner.v1.TypeCode].
 

repeated .google.protobuf.ListValue keys = 1;

Specified by:

getKeysOrBuilderList in interface KeySetOrBuilder

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][google.spanner.v1.TypeCode].
 

repeated .google.protobuf.ListValue keys = 1;

addKeysBuilder

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][google.spanner.v1.TypeCode].
 

repeated .google.protobuf.ListValue keys = 1;

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][google.spanner.v1.TypeCode].
 

repeated .google.protobuf.ListValue keys = 1;

getRangesList

public List<KeyRange> getRangesList()

 A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
 

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

Specified by:

getRangesList in interface KeySetOrBuilder

getRangesCount

public int getRangesCount()

 A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
 

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

Specified by:

getRangesCount in interface KeySetOrBuilder

getRanges

public KeyRange getRanges(int index)

 A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
 

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

Specified by:

getRanges in interface KeySetOrBuilder

setRanges

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

 A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
 

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

setRanges

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

 A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
 

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

addRanges

public KeySet.Builder addRanges(KeyRange value)

 A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
 

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

addRanges

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

 A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
 

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

addRanges

public KeySet.Builder addRanges(KeyRange.Builder builderForValue)

 A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
 

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

addRanges

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

 A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
 

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

addAllRanges

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

 A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
 

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

clearRanges

public KeySet.Builder clearRanges()

 A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
 

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

removeRanges

public KeySet.Builder removeRanges(int index)

 A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
 

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

getRangesBuilder

public KeyRange.Builder getRangesBuilder(int index)

 A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
 

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

getRangesOrBuilder

public KeyRangeOrBuilder getRangesOrBuilder(int index)

 A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
 

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

Specified by:

getRangesOrBuilder in interface KeySetOrBuilder

getRangesOrBuilderList

public List<? extends KeyRangeOrBuilder> getRangesOrBuilderList()

 A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
 

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

Specified by:

getRangesOrBuilderList in interface KeySetOrBuilder

addRangesBuilder

public KeyRange.Builder addRangesBuilder()

 A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
 

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

addRangesBuilder

public KeyRange.Builder addRangesBuilder(int index)

 A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
 

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

getRangesBuilderList

public List<KeyRange.Builder> getRangesBuilderList()

 A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about
 key range specifications.
 

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

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;

Specified by:

getAll in interface KeySetOrBuilder

Returns:

The all.

setAll

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;

Parameters:

value - The all to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setUnknownFields

public final KeySet.Builder setUnknownFields(UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<KeySet.Builder>

mergeUnknownFields

public final KeySet.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<KeySet.Builder>