Class KeyRange.Builder (6.69.0)

public static final class KeyRange.Builder extends 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.

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > KeyRange.Builder

Implements

KeyRangeOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public KeyRange.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`KeyRange.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public KeyRange build()

Returns
Type	Description
`KeyRange`

buildPartial()

public KeyRange buildPartial()

Returns
Type	Description
`KeyRange`

clear()

public KeyRange.Builder clear()

Returns
Type	Description
`KeyRange.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearEndClosed()

public KeyRange.Builder 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;

Returns
Type	Description
`KeyRange.Builder`

clearEndKeyType()

public KeyRange.Builder clearEndKeyType()

Returns
Type	Description
`KeyRange.Builder`

clearEndOpen()

public KeyRange.Builder 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;

Returns
Type	Description
`KeyRange.Builder`

clearField(Descriptors.FieldDescriptor field)

public KeyRange.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`KeyRange.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public KeyRange.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`KeyRange.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearStartClosed()

public KeyRange.Builder 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;

Returns
Type	Description
`KeyRange.Builder`

clearStartKeyType()

public KeyRange.Builder clearStartKeyType()

Returns
Type	Description
`KeyRange.Builder`

clearStartOpen()

public KeyRange.Builder 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;

Returns
Type	Description
`KeyRange.Builder`

clone()

public KeyRange.Builder clone()

Returns
Type	Description
`KeyRange.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public KeyRange getDefaultInstanceForType()

Returns
Type	Description
`KeyRange`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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;

Returns
Type	Description
`ListValue`	The endClosed.

getEndClosedBuilder()

public 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;

Returns
Type	Description
`Builder`

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;

Returns
Type	Description
`ListValueOrBuilder`

getEndKeyTypeCase()

public KeyRange.EndKeyTypeCase getEndKeyTypeCase()

Returns
Type	Description
`KeyRange.EndKeyTypeCase`

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;

Returns
Type	Description
`ListValue`	The endOpen.

getEndOpenBuilder()

public 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;

Returns
Type	Description
`Builder`

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;

Returns
Type	Description
`ListValueOrBuilder`

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;

Returns
Type	Description
`ListValue`	The startClosed.

getStartClosedBuilder()

public 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;

Returns
Type	Description
`Builder`

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;

Returns
Type	Description
`ListValueOrBuilder`

getStartKeyTypeCase()

public KeyRange.StartKeyTypeCase getStartKeyTypeCase()

Returns
Type	Description
`KeyRange.StartKeyTypeCase`

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;

Returns
Type	Description
`ListValue`	The startOpen.

getStartOpenBuilder()

public 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;

Returns
Type	Description
`Builder`

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;

Returns
Type	Description
`ListValueOrBuilder`

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;

Returns
Type	Description
`boolean`	Whether the endClosed field is set.

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;

Returns
Type	Description
`boolean`	Whether the endOpen field is set.

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;

Returns
Type	Description
`boolean`	Whether the startClosed field is set.

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;

Returns
Type	Description
`boolean`	Whether the startOpen field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeEndClosed(ListValue value)

public KeyRange.Builder mergeEndClosed(ListValue value)

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;

Parameter
Name	Description
`value`	`ListValue`

Returns
Type	Description
`KeyRange.Builder`

mergeEndOpen(ListValue value)

public KeyRange.Builder mergeEndOpen(ListValue value)

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;

Parameter
Name	Description
`value`	`ListValue`

Returns
Type	Description
`KeyRange.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public KeyRange.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`KeyRange.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public KeyRange.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`KeyRange.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeFrom(KeyRange other)

public KeyRange.Builder mergeFrom(KeyRange other)

Parameter
Name	Description
`other`	`KeyRange`

Returns
Type	Description
`KeyRange.Builder`

mergeStartClosed(ListValue value)

public KeyRange.Builder mergeStartClosed(ListValue value)

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;

Parameter
Name	Description
`value`	`ListValue`

Returns
Type	Description
`KeyRange.Builder`

mergeStartOpen(ListValue value)

public KeyRange.Builder mergeStartOpen(ListValue value)

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;

Parameter
Name	Description
`value`	`ListValue`

Returns
Type	Description
`KeyRange.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final KeyRange.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`KeyRange.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setEndClosed(ListValue value)

public KeyRange.Builder setEndClosed(ListValue value)

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;

Parameter
Name	Description
`value`	`ListValue`

Returns
Type	Description
`KeyRange.Builder`

setEndClosed(ListValue.Builder builderForValue)

public KeyRange.Builder setEndClosed(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.

.google.protobuf.ListValue end_closed = 3;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`KeyRange.Builder`

setEndOpen(ListValue value)

public KeyRange.Builder setEndOpen(ListValue value)

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;

Parameter
Name	Description
`value`	`ListValue`

Returns
Type	Description
`KeyRange.Builder`

setEndOpen(ListValue.Builder builderForValue)

public KeyRange.Builder setEndOpen(ListValue.Builder builderForValue)

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;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`KeyRange.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public KeyRange.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`KeyRange.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public KeyRange.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`KeyRange.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setStartClosed(ListValue value)

public KeyRange.Builder setStartClosed(ListValue value)

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;

Parameter
Name	Description
`value`	`ListValue`

Returns
Type	Description
`KeyRange.Builder`

setStartClosed(ListValue.Builder builderForValue)

public KeyRange.Builder setStartClosed(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.

.google.protobuf.ListValue start_closed = 1;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`KeyRange.Builder`

setStartOpen(ListValue value)

public KeyRange.Builder setStartOpen(ListValue value)

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;

Parameter
Name	Description
`value`	`ListValue`

Returns
Type	Description
`KeyRange.Builder`

setStartOpen(ListValue.Builder builderForValue)

public KeyRange.Builder setStartOpen(ListValue.Builder builderForValue)

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;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`KeyRange.Builder`

setUnknownFields(UnknownFieldSet unknownFields)

public final KeyRange.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`KeyRange.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)