com.google.api.services.spanner.v1.model

Class KeySet

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.spanner.v1.model.KeySet

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class KeySet
extends com.google.api.client.json.GenericJson

`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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Spanner API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
KeySet()

Method Summary

Modifier and Type	Method and Description
KeySet	clone()
Boolean	getAll() For convenience `all` can be set to `true` to indicate that this `KeySet` matches all keys in the table or index.
List<List<Object>>	getKeys() A list of specific keys.
List<KeyRange>	getRanges() A list of key ranges.
KeySet	set(String fieldName, Object value)
KeySet	setAll(Boolean all) For convenience `all` can be set to `true` to indicate that this `KeySet` matches all keys in the table or index.
KeySet	setKeys(List<List<Object>> keys) A list of specific keys.
KeySet	setRanges(List<KeyRange> ranges) A list of key ranges.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

KeySet

public KeySet()

Method Detail

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.

Returns:

value or null for none

setAll

public KeySet setAll(Boolean all)

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.

Parameters:

all - all or null for none

getKeys

public List<List<Object>> getKeys()

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.

Returns:

value or null for none

setKeys

public KeySet setKeys(List<List<Object>> keys)

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.

Parameters:

keys - keys or null for none

getRanges

public List<KeyRange> getRanges()

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

Returns:

value or null for none

setRanges

public KeySet setRanges(List<KeyRange> ranges)

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

Parameters:

ranges - ranges or null for none

set

public KeySet set(String fieldName,
                  Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public KeySet clone()

Overrides:

clone in class com.google.api.client.json.GenericJson