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

Class KeyRange

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

KeyRange represents a range of rows in a table or index. A range has a start key and an end key. These keys can be open or closed, indicating if the range includes rows with that key. Keys are represented by lists, where the ith value in the list corresponds to the ith component of the table or index primary key. Individual values are encoded as described here. For example, consider the following table definition: CREATE TABLE UserEvents ( UserName STRING(MAX), EventDate STRING(10) ) PRIMARY KEY(UserName, EventDate); The following keys name rows in this table: "Bob", "2014-09-23" Since the `UserEvents` table's `PRIMARY KEY` clause names two columns, each `UserEvents` key has two elements; the first is the `UserName`, and the second is the `EventDate`. Key ranges with multiple components are interpreted lexicographically by component using the table or index key's declared sort order. For example, the following range returns all events for user `"Bob"` that occurred in the year 2015: "start_closed": ["Bob", "2015-01-01"] "end_closed": ["Bob", "2015-12-31"] Start and end keys can omit trailing key components. This affects the inclusion and exclusion of rows that exactly match the provided key components: if the key is closed, then rows that exactly match the provided components are included; if the key is open, then rows that exactly match are not included. For example, the following range includes all events for `"Bob"` that occurred during and after the year 2000: "start_closed": ["Bob", "2000-01-01"] "end_closed": ["Bob"] The next example retrieves all events for `"Bob"`: "start_closed": ["Bob"] "end_closed": ["Bob"] To retrieve events before the year 2000: "start_closed": ["Bob"] "end_open": ["Bob", "2000-01-01"] The following range includes all rows in the table: "start_closed": [] "end_closed": [] This range returns all users whose `UserName` begins with any character from A to C: "start_closed": ["A"] "end_open": ["D"] This range returns all users whose `UserName` begins with B: "start_closed": ["B"] "end_open": ["C"] Key ranges honor column sort order. For example, suppose a table is defined as follows: CREATE TABLE DescendingSortedTable { Key INT64, ... ) PRIMARY KEY(Key DESC); The following range retrieves all rows with key values between 1 and 100 inclusive: "start_closed": ["100"] "end_closed": ["1"] Note that 100 is passed as the start, and 1 is passed as the end, because `Key` is a descending column in the schema.

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
KeyRange()

Method Summary

Modifier and Type	Method and Description
KeyRange	clone()
List<Object>	getEndClosed() If the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`.
List<Object>	getEndOpen() If the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`.
List<Object>	getStartClosed() If the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`.
List<Object>	getStartOpen() If the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`.
KeyRange	set(String fieldName, Object value)
KeyRange	setEndClosed(List<Object> endClosed) If the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`.
KeyRange	setEndOpen(List<Object> endOpen) If the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`.
KeyRange	setStartClosed(List<Object> startClosed) If the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`.
KeyRange	setStartOpen(List<Object> startOpen) If the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`.

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

KeyRange

public KeyRange()

Method Detail

getEndClosed

public List<Object> getEndClosed()

If the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`.

Returns:

value or null for none

setEndClosed

public KeyRange setEndClosed(List<Object> endClosed)

If the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`.

Parameters:

endClosed - endClosed or null for none

getEndOpen

public List<Object> getEndOpen()

If the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`.

Returns:

value or null for none

setEndOpen

public KeyRange setEndOpen(List<Object> endOpen)

If the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`.

Parameters:

endOpen - endOpen or null for none

getStartClosed

public List<Object> getStartClosed()

If the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`.

Returns:

value or null for none

setStartClosed

public KeyRange setStartClosed(List<Object> startClosed)

If the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`.

Parameters:

startClosed - startClosed or null for none

getStartOpen

public List<Object> getStartOpen()

If the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`.

Returns:

value or null for none

setStartOpen

public KeyRange setStartOpen(List<Object> startOpen)

If the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`.

Parameters:

startOpen - startOpen or null for none

set

public KeyRange set(String fieldName,
                    Object value)

Overrides:

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

clone

public KeyRange clone()

Overrides:

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