publicstaticfinalclassKeySet.BuilderextendsGeneratedMessageV3.Builder<KeySet.Builder>implementsKeySetOrBuilder
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
Methods
addAllKeys(Iterable<? extends ListValue> values)
publicKeySet.BuilderaddAllKeys(Iterable<?extendsListValue>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)
publicKeySet.BuilderaddAllRanges(Iterable<?extendsKeyRange>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)
publicKeySet.BuilderaddKeys(ListValuevalue)
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)
publicKeySet.BuilderaddKeys(ListValue.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. Individual key values are encoded as described here.
repeated .google.protobuf.ListValue keys = 1;
| Parameter |
|---|
| Name | Description |
builderForValue | Builder
|
addKeys(int index, ListValue value)
publicKeySet.BuilderaddKeys(intindex,ListValuevalue)
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)
publicKeySet.BuilderaddKeys(intindex,ListValue.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. Individual key values are encoded as described here.
repeated .google.protobuf.ListValue keys = 1;
| Parameters |
|---|
| Name | Description |
index | int
|
builderForValue | Builder
|
addKeysBuilder()
publicListValue.BuilderaddKeysBuilder()
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)
publicListValue.BuilderaddKeysBuilder(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. Individual key values are encoded as described here.
repeated .google.protobuf.ListValue keys = 1;
| Parameter |
|---|
| Name | Description |
index | int
|
addRanges(KeyRange value)
publicKeySet.BuilderaddRanges(KeyRangevalue)
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)
publicKeySet.BuilderaddRanges(KeyRange.BuilderbuilderForValue)
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)
publicKeySet.BuilderaddRanges(intindex,KeyRangevalue)
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)
publicKeySet.BuilderaddRanges(intindex,KeyRange.BuilderbuilderForValue)
A list of key ranges. See KeyRange for more information about key range specifications.
repeated .google.spanner.v1.KeyRange ranges = 2;
addRangesBuilder()
publicKeyRange.BuilderaddRangesBuilder()
A list of key ranges. See KeyRange for more information about key range specifications.
repeated .google.spanner.v1.KeyRange ranges = 2;
addRangesBuilder(int index)
publicKeyRange.BuilderaddRangesBuilder(intindex)
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)
publicKeySet.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
build()
buildPartial()
publicKeySetbuildPartial()
clear()
publicKeySet.Builderclear()
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;
clearField(Descriptors.FieldDescriptor field)
publicKeySet.BuilderclearField(Descriptors.FieldDescriptorfield)
clearKeys()
publicKeySet.BuilderclearKeys()
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)
publicKeySet.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
clearRanges()
publicKeySet.BuilderclearRanges()
A list of key ranges. See KeyRange for more information about key range specifications.
repeated .google.spanner.v1.KeyRange ranges = 2;
clone()
publicKeySet.Builderclone()
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()
publicKeySetgetDefaultInstanceForType()
getDescriptorForType()
publicDescriptors.DescriptorgetDescriptorForType()
getKeys(int index)
publicListValuegetKeys(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. Individual key values are encoded as described here.
repeated .google.protobuf.ListValue keys = 1;
| Parameter |
|---|
| Name | Description |
index | int
|
getKeysBuilder(int index)
publicListValue.BuildergetKeysBuilder(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. Individual key values are encoded as described here.
repeated .google.protobuf.ListValue keys = 1;
| Parameter |
|---|
| Name | Description |
index | int
|
getKeysBuilderList()
publicList<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()
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()
publicList<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)
publicListValueOrBuildergetKeysOrBuilder(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. Individual key values are encoded as described here.
repeated .google.protobuf.ListValue keys = 1;
| Parameter |
|---|
| Name | Description |
index | int
|
getKeysOrBuilderList()
publicList<?extendsListValueOrBuilder>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)
publicKeyRangegetRanges(intindex)
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)
publicKeyRange.BuildergetRangesBuilder(intindex)
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()
publicList<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()
publicintgetRangesCount()
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()
publicList<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)
publicKeyRangeOrBuildergetRangesOrBuilder(intindex)
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()
publicList<?extendsKeyRangeOrBuilder>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()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
isInitialized()
publicfinalbooleanisInitialized()
publicKeySet.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
mergeFrom(Message other)
publicKeySet.BuildermergeFrom(Messageother)
| Parameter |
|---|
| Name | Description |
other | Message
|
OverridesmergeFrom(KeySet other)
publicKeySet.BuildermergeFrom(KeySetother)
| Parameter |
|---|
| Name | Description |
other | KeySet
|
mergeUnknownFields(UnknownFieldSet unknownFields)
publicfinalKeySet.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
removeKeys(int index)
publicKeySet.BuilderremoveKeys(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. Individual key values are encoded as described here.
repeated .google.protobuf.ListValue keys = 1;
| Parameter |
|---|
| Name | Description |
index | int
|
removeRanges(int index)
publicKeySet.BuilderremoveRanges(intindex)
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)
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 |
|---|
| Name | Description |
value | boolean
The all to set. |
setField(Descriptors.FieldDescriptor field, Object value)
publicKeySet.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
setKeys(int index, ListValue value)
publicKeySet.BuildersetKeys(intindex,ListValuevalue)
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)
publicKeySet.BuildersetKeys(intindex,ListValue.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. 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)
publicKeySet.BuildersetRanges(intindex,KeyRangevalue)
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)
publicKeySet.BuildersetRanges(intindex,KeyRange.BuilderbuilderForValue)
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)
publicKeySet.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
setUnknownFields(UnknownFieldSet unknownFields)
publicfinalKeySet.BuildersetUnknownFields(UnknownFieldSetunknownFields)
