Package com.google.spanner.v1
Class KeyRange.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<KeyRange.Builder>
com.google.spanner.v1.KeyRange.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,KeyRangeOrBuilder,Cloneable
- Enclosing class:
- KeyRange
public static final class KeyRange.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<KeyRange.Builder>
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-
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()clear()If the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`.If the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) If the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`.If the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`.clone()static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.Descriptorcom.google.protobuf.ListValueIf the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`.com.google.protobuf.ListValue.BuilderIf the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`.com.google.protobuf.ListValueOrBuilderIf the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`.com.google.protobuf.ListValueIf the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`.com.google.protobuf.ListValue.BuilderIf the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`.com.google.protobuf.ListValueOrBuilderIf the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`.com.google.protobuf.ListValueIf the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`.com.google.protobuf.ListValue.BuilderIf the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`.com.google.protobuf.ListValueOrBuilderIf the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`.com.google.protobuf.ListValueIf the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`.com.google.protobuf.ListValue.BuilderIf the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`.com.google.protobuf.ListValueOrBuilderIf the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`.booleanIf the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`.booleanIf the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`.booleanIf the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`.booleanIf the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanmergeEndClosed(com.google.protobuf.ListValue value) If the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`.mergeEndOpen(com.google.protobuf.ListValue value) If the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`.mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeStartClosed(com.google.protobuf.ListValue value) If the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`.mergeStartOpen(com.google.protobuf.ListValue value) If the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`.final KeyRange.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) setEndClosed(com.google.protobuf.ListValue value) If the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`.setEndClosed(com.google.protobuf.ListValue.Builder builderForValue) If the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`.setEndOpen(com.google.protobuf.ListValue value) If the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`.setEndOpen(com.google.protobuf.ListValue.Builder builderForValue) If the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setStartClosed(com.google.protobuf.ListValue value) If the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`.setStartClosed(com.google.protobuf.ListValue.Builder builderForValue) If the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`.setStartOpen(com.google.protobuf.ListValue value) If the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`.setStartOpen(com.google.protobuf.ListValue.Builder builderForValue) If the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`.final KeyRange.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRange.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRange.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRange.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRange.Builder>
-
setField
public KeyRange.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRange.Builder>
-
clearField
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRange.Builder>
-
clearOneof
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRange.Builder>
-
setRepeatedField
public KeyRange.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRange.Builder>
-
addRepeatedField
public KeyRange.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRange.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<KeyRange.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRange.Builder>
-
mergeFrom
public KeyRange.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<KeyRange.Builder>- Throws:
IOException
-
getStartKeyTypeCase
- Specified by:
getStartKeyTypeCasein interfaceKeyRangeOrBuilder
-
clearStartKeyType
-
getEndKeyTypeCase
- Specified by:
getEndKeyTypeCasein interfaceKeyRangeOrBuilder
-
clearEndKeyType
-
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:
hasStartClosedin interfaceKeyRangeOrBuilder- Returns:
- Whether the startClosed field is set.
-
getStartClosed
public com.google.protobuf.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:
getStartClosedin interfaceKeyRangeOrBuilder- Returns:
- The startClosed.
-
setStartClosed
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; -
setStartClosed
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; -
mergeStartClosed
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; -
clearStartClosed
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; -
getStartClosedBuilder
public com.google.protobuf.ListValue.Builder getStartClosedBuilder()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; -
getStartClosedOrBuilder
public com.google.protobuf.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:
getStartClosedOrBuilderin interfaceKeyRangeOrBuilder
-
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:
hasStartOpenin interfaceKeyRangeOrBuilder- Returns:
- Whether the startOpen field is set.
-
getStartOpen
public com.google.protobuf.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:
getStartOpenin interfaceKeyRangeOrBuilder- Returns:
- The startOpen.
-
setStartOpen
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; -
setStartOpen
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; -
mergeStartOpen
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; -
clearStartOpen
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; -
getStartOpenBuilder
public com.google.protobuf.ListValue.Builder getStartOpenBuilder()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; -
getStartOpenOrBuilder
public com.google.protobuf.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:
getStartOpenOrBuilderin interfaceKeyRangeOrBuilder
-
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:
hasEndClosedin interfaceKeyRangeOrBuilder- Returns:
- Whether the endClosed field is set.
-
getEndClosed
public com.google.protobuf.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:
getEndClosedin interfaceKeyRangeOrBuilder- Returns:
- The endClosed.
-
setEndClosed
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; -
setEndClosed
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; -
mergeEndClosed
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; -
clearEndClosed
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; -
getEndClosedBuilder
public com.google.protobuf.ListValue.Builder getEndClosedBuilder()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; -
getEndClosedOrBuilder
public com.google.protobuf.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:
getEndClosedOrBuilderin interfaceKeyRangeOrBuilder
-
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:
hasEndOpenin interfaceKeyRangeOrBuilder- Returns:
- Whether the endOpen field is set.
-
getEndOpen
public com.google.protobuf.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:
getEndOpenin interfaceKeyRangeOrBuilder- Returns:
- The endOpen.
-
setEndOpen
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; -
setEndOpen
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; -
mergeEndOpen
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; -
clearEndOpen
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; -
getEndOpenBuilder
public com.google.protobuf.ListValue.Builder getEndOpenBuilder()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; -
getEndOpenOrBuilder
public com.google.protobuf.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:
getEndOpenOrBuilderin interfaceKeyRangeOrBuilder
-
setUnknownFields
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRange.Builder>
-
mergeUnknownFields
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<KeyRange.Builder>
-