KeyRange.Builder (Google Cloud Spanner Parent 6.25.1 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<KeyRange.Builder>
    - - com.google.spanner.v1.KeyRange.Builder

All Implemented Interfaces:: Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, KeyRangeOrBuilder, Cloneable

Enclosing class:: KeyRange

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][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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KeyRange.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, Object value)`
`KeyRange`	`build()`
`KeyRange`	`buildPartial()`
`KeyRange.Builder`	`clear()`
`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`.
`KeyRange.Builder`	`clearEndKeyType()`
`KeyRange.Builder`	`clearEndOpen()` If the end is open, then the range excludes rows whose first `len(end_open)` key columns exactly match `end_open`.
`KeyRange.Builder`	`clearField(Descriptors.FieldDescriptor field)`
`KeyRange.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`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`.
`KeyRange.Builder`	`clearStartKeyType()`
`KeyRange.Builder`	`clearStartOpen()` If the start is open, then the range excludes rows whose first `len(start_open)` key columns exactly match `start_open`.
`KeyRange.Builder`	`clone()`
`KeyRange`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()`
`ListValue`	`getEndClosed()` If the end is closed, then the range includes all rows whose first `len(end_closed)` key columns exactly match `end_closed`.
`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`.
`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`.
`ListValue.Builder`	`getEndOpenBuilder()` 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`.
`ListValue`	`getStartClosed()` If the start is closed, then the range includes all rows whose first `len(start_closed)` key columns exactly match `start_closed`.
`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`.
`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`.
`ListValue.Builder`	`getStartOpenBuilder()` 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`.
`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`.
`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()`
`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`.
`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`.
`KeyRange.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`KeyRange.Builder`	`mergeFrom(KeyRange other)`
`KeyRange.Builder`	`mergeFrom(Message other)`
`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`.
`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`.
`KeyRange.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)`
`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`.
`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`.
`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`.
`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`.
`KeyRange.Builder`	`setField(Descriptors.FieldDescriptor field, Object value)`
`KeyRange.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)`
`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`.
`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`.
`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`.
`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`.
`KeyRange.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<KeyRange.Builder>

clear
```
public KeyRange.Builder clear()
```
Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<KeyRange.Builder>

getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<KeyRange.Builder>

getDefaultInstanceForType
```
public KeyRange getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build
```
public KeyRange build()
```
Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial
```
public KeyRange buildPartial()
```
Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone
```
public KeyRange.Builder clone()
```
Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<KeyRange.Builder>

setField

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

Specified by:: setField in interface Message.Builder
Overrides:: setField in class GeneratedMessageV3.Builder<KeyRange.Builder>

clearField
```
public KeyRange.Builder clearField(Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<KeyRange.Builder>

clearOneof
```
public KeyRange.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<KeyRange.Builder>

setRepeatedField

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

Specified by:: setRepeatedField in interface Message.Builder
Overrides:: setRepeatedField in class GeneratedMessageV3.Builder<KeyRange.Builder>

addRepeatedField

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

Specified by:: addRepeatedField in interface Message.Builder
Overrides:: addRepeatedField in class GeneratedMessageV3.Builder<KeyRange.Builder>

mergeFrom
```
public KeyRange.Builder mergeFrom(Message other)
```
Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<KeyRange.Builder>

mergeFrom

public KeyRange.Builder mergeFrom(KeyRange other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<KeyRange.Builder>

mergeFrom

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

Specified by:: mergeFrom in interface Message.Builder
Specified by:: mergeFrom in interface MessageLite.Builder
Overrides:: mergeFrom in class AbstractMessage.Builder<KeyRange.Builder>
Throws:: IOException

getStartKeyTypeCase
```
public KeyRange.StartKeyTypeCase getStartKeyTypeCase()
```
Specified by:

getStartKeyTypeCase in interface KeyRangeOrBuilder

clearStartKeyType

public KeyRange.Builder clearStartKeyType()

getEndKeyTypeCase
```
public KeyRange.EndKeyTypeCase getEndKeyTypeCase()
```
Specified by:

getEndKeyTypeCase in interface KeyRangeOrBuilder

clearEndKeyType

public KeyRange.Builder 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:: hasStartClosed in interface KeyRangeOrBuilder
Returns:: Whether the startClosed field is set.

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
Returns:: The startClosed.

setStartClosed

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;

setStartClosed

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;

mergeStartClosed

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;

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;

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;

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
Returns:: Whether the startOpen field is set.

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
Returns:: The startOpen.

setStartOpen

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;

setStartOpen

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;

mergeStartOpen

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;

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;

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;

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