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
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
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>
|
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>
|
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;
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
|
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;
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
|
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;
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
|
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;
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;
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;
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;
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;
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
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public KeySet.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
buildPartial()
public KeySet buildPartial()
clear()
public KeySet.Builder clear()
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;
clearField(Descriptors.FieldDescriptor field)
public KeySet.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
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;
clearOneof(Descriptors.OneofDescriptor oneof)
public KeySet.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
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;
clone()
public KeySet.Builder clone()
Overrides
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()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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
|
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
|
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;
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;
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
|
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
|
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
|
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;
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;
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
|
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()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
public KeySet.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public KeySet.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeFrom(KeySet other)
public KeySet.Builder mergeFrom(KeySet other)
| Parameter |
|---|
| Name | Description |
other | KeySet
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final KeySet.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
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
|
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
|
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.
|
setField(Descriptors.FieldDescriptor field, Object value)
public KeySet.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
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;
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
|
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;
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;
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public KeySet.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final KeySet.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
