public final class KeySet extends GeneratedMessageV3 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ALL_FIELD_NUMBER
public static final int ALL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
KEYS_FIELD_NUMBER
public static final int KEYS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RANGES_FIELD_NUMBER
public static final int RANGES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static KeySet getDefaultInstance()
| Returns |
| Type |
Description |
KeySet |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static KeySet.Builder newBuilder()
newBuilder(KeySet prototype)
public static KeySet.Builder newBuilder(KeySet prototype)
| Parameter |
| Name |
Description |
prototype |
KeySet
|
public static KeySet parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
KeySet |
|
public static KeySet parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
KeySet |
|
parseFrom(byte[] data)
public static KeySet parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
KeySet |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static KeySet parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
KeySet |
|
parseFrom(ByteString data)
public static KeySet parseFrom(ByteString data)
| Returns |
| Type |
Description |
KeySet |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static KeySet parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
KeySet |
|
public static KeySet parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
KeySet |
|
public static KeySet parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
KeySet |
|
public static KeySet parseFrom(InputStream input)
| Returns |
| Type |
Description |
KeySet |
|
public static KeySet parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
KeySet |
|
parseFrom(ByteBuffer data)
public static KeySet parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
KeySet |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static KeySet parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
KeySet |
|
parser()
public static Parser<KeySet> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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()
| Returns |
| Type |
Description |
KeySet |
|
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
|
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> |
|
getParserForType()
public Parser<KeySet> getParserForType()
Overrides
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
|
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> |
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public KeySet.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected KeySet.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public KeySet.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
