com.google.spanner.v1

Class KeyRange

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.spanner.v1.KeyRange

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, KeyRangeOrBuilder, java.io.Serializable

public final class KeyRange
extends GeneratedMessageV3
implements KeyRangeOrBuilder

 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][google.spanner.v1.TypeCode].
 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"]
     ["Alfred", "2015-06-12"]
 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.
 

Protobuf type google.spanner.v1.KeyRange

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyRange.Builder KeyRange represents a range of rows in a table or index.
static class	KeyRange.EndKeyTypeCase
static class	KeyRange.StartKeyTypeCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	END_CLOSED_FIELD_NUMBER
static int	END_OPEN_FIELD_NUMBER
static int	START_CLOSED_FIELD_NUMBER
static int	START_OPEN_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static KeyRange	getDefaultInstance()
KeyRange	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
ListValue	getEndClosed() If the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`.
ListValueOrBuilder	getEndClosedOrBuilder() If the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`.
KeyRange.EndKeyTypeCase	getEndKeyTypeCase()
ListValue	getEndOpen() If the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`.
ListValueOrBuilder	getEndOpenOrBuilder() If the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`.
Parser<KeyRange>	getParserForType()
int	getSerializedSize()
ListValue	getStartClosed() If the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`.
ListValueOrBuilder	getStartClosedOrBuilder() If the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`.
KeyRange.StartKeyTypeCase	getStartKeyTypeCase()
ListValue	getStartOpen() If the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`.
ListValueOrBuilder	getStartOpenOrBuilder() If the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`.
UnknownFieldSet	getUnknownFields()
boolean	hasEndClosed() If the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`.
boolean	hasEndOpen() If the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`.
int	hashCode()
boolean	hasStartClosed() If the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`.
boolean	hasStartOpen() If the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static KeyRange.Builder	newBuilder()
static KeyRange.Builder	newBuilder(KeyRange prototype)
KeyRange.Builder	newBuilderForType()
protected KeyRange.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
static KeyRange	parseDelimitedFrom(java.io.InputStream input)
static KeyRange	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static KeyRange	parseFrom(byte[] data)
static KeyRange	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static KeyRange	parseFrom(java.nio.ByteBuffer data)
static KeyRange	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static KeyRange	parseFrom(ByteString data)
static KeyRange	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static KeyRange	parseFrom(CodedInputStream input)
static KeyRange	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static KeyRange	parseFrom(java.io.InputStream input)
static KeyRange	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<KeyRange>	parser()
KeyRange.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

START_CLOSED_FIELD_NUMBER

public static final int START_CLOSED_FIELD_NUMBER

See Also:

Constant Field Values

START_OPEN_FIELD_NUMBER

public static final int START_OPEN_FIELD_NUMBER

See Also:

Constant Field Values

END_CLOSED_FIELD_NUMBER

public static final int END_CLOSED_FIELD_NUMBER

See Also:

Constant Field Values

END_OPEN_FIELD_NUMBER

public static final int END_OPEN_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getStartKeyTypeCase

public KeyRange.StartKeyTypeCase getStartKeyTypeCase()

Specified by:

getStartKeyTypeCase in interface KeyRangeOrBuilder

getEndKeyTypeCase

public KeyRange.EndKeyTypeCase getEndKeyTypeCase()

Specified by:

getEndKeyTypeCase in interface KeyRangeOrBuilder

hasStartClosed

public boolean hasStartClosed()

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

.google.protobuf.ListValue start_closed = 1;

Specified by:

hasStartClosed in interface KeyRangeOrBuilder

getStartClosed

public ListValue getStartClosed()

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

.google.protobuf.ListValue start_closed = 1;

Specified by:

getStartClosed in interface KeyRangeOrBuilder

getStartClosedOrBuilder

public ListValueOrBuilder getStartClosedOrBuilder()

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

.google.protobuf.ListValue start_closed = 1;

Specified by:

getStartClosedOrBuilder in interface KeyRangeOrBuilder

hasStartOpen

public boolean hasStartOpen()

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

.google.protobuf.ListValue start_open = 2;

Specified by:

hasStartOpen in interface KeyRangeOrBuilder

getStartOpen

public ListValue getStartOpen()

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

.google.protobuf.ListValue start_open = 2;

Specified by:

getStartOpen in interface KeyRangeOrBuilder

getStartOpenOrBuilder

public ListValueOrBuilder getStartOpenOrBuilder()

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

.google.protobuf.ListValue start_open = 2;

Specified by:

getStartOpenOrBuilder in interface KeyRangeOrBuilder

hasEndClosed

public boolean hasEndClosed()

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

.google.protobuf.ListValue end_closed = 3;

Specified by:

hasEndClosed in interface KeyRangeOrBuilder

getEndClosed

public ListValue getEndClosed()

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

.google.protobuf.ListValue end_closed = 3;

Specified by:

getEndClosed in interface KeyRangeOrBuilder

getEndClosedOrBuilder

public ListValueOrBuilder getEndClosedOrBuilder()

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

.google.protobuf.ListValue end_closed = 3;

Specified by:

getEndClosedOrBuilder in interface KeyRangeOrBuilder

hasEndOpen

public boolean hasEndOpen()

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

.google.protobuf.ListValue end_open = 4;

Specified by:

hasEndOpen in interface KeyRangeOrBuilder

getEndOpen

public ListValue getEndOpen()

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

.google.protobuf.ListValue end_open = 4;

Specified by:

getEndOpen in interface KeyRangeOrBuilder

getEndOpenOrBuilder

public ListValueOrBuilder getEndOpenOrBuilder()

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

.google.protobuf.ListValue end_open = 4;

Specified by:

getEndOpenOrBuilder in interface KeyRangeOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static KeyRange parseFrom(java.nio.ByteBuffer data)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static KeyRange parseFrom(java.nio.ByteBuffer data,
                                 ExtensionRegistryLite extensionRegistry)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static KeyRange parseFrom(ByteString data)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static KeyRange parseFrom(ByteString data,
                                 ExtensionRegistryLite extensionRegistry)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static KeyRange parseFrom(byte[] data)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static KeyRange parseFrom(byte[] data,
                                 ExtensionRegistryLite extensionRegistry)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static KeyRange parseFrom(java.io.InputStream input)
                          throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static KeyRange parseFrom(java.io.InputStream input,
                                 ExtensionRegistryLite extensionRegistry)
                          throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static KeyRange parseDelimitedFrom(java.io.InputStream input)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static KeyRange parseDelimitedFrom(java.io.InputStream input,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static KeyRange parseFrom(CodedInputStream input)
                          throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static KeyRange parseFrom(CodedInputStream input,
                                 ExtensionRegistryLite extensionRegistry)
                          throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public KeyRange.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static KeyRange.Builder newBuilder()

newBuilder

public static KeyRange.Builder newBuilder(KeyRange prototype)

toBuilder

public KeyRange.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected KeyRange.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static KeyRange getDefaultInstance()

parser

public static Parser<KeyRange> parser()

getParserForType

public Parser<KeyRange> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public KeyRange getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder