Class KeyRange.Builder (6.68.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 "ValueList", where the ith value in the list corresponds to the ith component of the table or index primary key.

Protobuf type google.spanner.executor.v1.KeyRange

Implements

KeyRangeOrBuilder

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

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

clearField(Descriptors.FieldDescriptor field)

public KeyRange.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
KeyRange.Builder
Overrides

clearLimit()

public KeyRange.Builder clearLimit()

The end key of this KeyRange.

.google.spanner.executor.v1.ValueList limit = 2;

Returns
Type Description
KeyRange.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public KeyRange.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
KeyRange.Builder
Overrides

clearStart()

public KeyRange.Builder clearStart()

"start" and "limit" must have the same number of key parts, though they may name only a prefix of the table or index key. The start key of this KeyRange.

.google.spanner.executor.v1.ValueList start = 1;

Returns
Type Description
KeyRange.Builder

clearType()

public KeyRange.Builder clearType()

"start" and "limit" type for this KeyRange.

optional .google.spanner.executor.v1.KeyRange.Type type = 3;

Returns
Type Description
KeyRange.Builder

This builder for chaining.

clone()

public KeyRange.Builder clone()
Returns
Type Description
KeyRange.Builder
Overrides

getDefaultInstanceForType()

public KeyRange getDefaultInstanceForType()
Returns
Type Description
KeyRange

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getLimit()

public ValueList getLimit()

The end key of this KeyRange.

.google.spanner.executor.v1.ValueList limit = 2;

Returns
Type Description
ValueList

The limit.

getLimitBuilder()

public ValueList.Builder getLimitBuilder()

The end key of this KeyRange.

.google.spanner.executor.v1.ValueList limit = 2;

Returns
Type Description
ValueList.Builder

getLimitOrBuilder()

public ValueListOrBuilder getLimitOrBuilder()

The end key of this KeyRange.

.google.spanner.executor.v1.ValueList limit = 2;

Returns
Type Description
ValueListOrBuilder

getStart()

public ValueList getStart()

"start" and "limit" must have the same number of key parts, though they may name only a prefix of the table or index key. The start key of this KeyRange.

.google.spanner.executor.v1.ValueList start = 1;

Returns
Type Description
ValueList

The start.

getStartBuilder()

public ValueList.Builder getStartBuilder()

"start" and "limit" must have the same number of key parts, though they may name only a prefix of the table or index key. The start key of this KeyRange.

.google.spanner.executor.v1.ValueList start = 1;

Returns
Type Description
ValueList.Builder

getStartOrBuilder()

public ValueListOrBuilder getStartOrBuilder()

"start" and "limit" must have the same number of key parts, though they may name only a prefix of the table or index key. The start key of this KeyRange.

.google.spanner.executor.v1.ValueList start = 1;

Returns
Type Description
ValueListOrBuilder

getType()

public KeyRange.Type getType()

"start" and "limit" type for this KeyRange.

optional .google.spanner.executor.v1.KeyRange.Type type = 3;

Returns
Type Description
KeyRange.Type

The type.

getTypeValue()

public int getTypeValue()

"start" and "limit" type for this KeyRange.

optional .google.spanner.executor.v1.KeyRange.Type type = 3;

Returns
Type Description
int

The enum numeric value on the wire for type.

hasLimit()

public boolean hasLimit()

The end key of this KeyRange.

.google.spanner.executor.v1.ValueList limit = 2;

Returns
Type Description
boolean

Whether the limit field is set.

hasStart()

public boolean hasStart()

"start" and "limit" must have the same number of key parts, though they may name only a prefix of the table or index key. The start key of this KeyRange.

.google.spanner.executor.v1.ValueList start = 1;

Returns
Type Description
boolean

Whether the start field is set.

hasType()

public boolean hasType()

"start" and "limit" type for this KeyRange.

optional .google.spanner.executor.v1.KeyRange.Type type = 3;

Returns
Type Description
boolean

Whether the type field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public KeyRange.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
KeyRange.Builder
Overrides

mergeFrom(KeyRange other)

public KeyRange.Builder mergeFrom(KeyRange other)
Parameter
Name Description
other KeyRange
Returns
Type Description
KeyRange.Builder

mergeLimit(ValueList value)

public KeyRange.Builder mergeLimit(ValueList value)

The end key of this KeyRange.

.google.spanner.executor.v1.ValueList limit = 2;

Parameter
Name Description
value ValueList
Returns
Type Description
KeyRange.Builder

mergeStart(ValueList value)

public KeyRange.Builder mergeStart(ValueList value)

"start" and "limit" must have the same number of key parts, though they may name only a prefix of the table or index key. The start key of this KeyRange.

.google.spanner.executor.v1.ValueList start = 1;

Parameter
Name Description
value ValueList
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

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

setLimit(ValueList value)

public KeyRange.Builder setLimit(ValueList value)

The end key of this KeyRange.

.google.spanner.executor.v1.ValueList limit = 2;

Parameter
Name Description
value ValueList
Returns
Type Description
KeyRange.Builder

setLimit(ValueList.Builder builderForValue)

public KeyRange.Builder setLimit(ValueList.Builder builderForValue)

The end key of this KeyRange.

.google.spanner.executor.v1.ValueList limit = 2;

Parameter
Name Description
builderForValue ValueList.Builder
Returns
Type Description
KeyRange.Builder

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

setStart(ValueList value)

public KeyRange.Builder setStart(ValueList value)

"start" and "limit" must have the same number of key parts, though they may name only a prefix of the table or index key. The start key of this KeyRange.

.google.spanner.executor.v1.ValueList start = 1;

Parameter
Name Description
value ValueList
Returns
Type Description
KeyRange.Builder

setStart(ValueList.Builder builderForValue)

public KeyRange.Builder setStart(ValueList.Builder builderForValue)

"start" and "limit" must have the same number of key parts, though they may name only a prefix of the table or index key. The start key of this KeyRange.

.google.spanner.executor.v1.ValueList start = 1;

Parameter
Name Description
builderForValue ValueList.Builder
Returns
Type Description
KeyRange.Builder

setType(KeyRange.Type value)

public KeyRange.Builder setType(KeyRange.Type value)

"start" and "limit" type for this KeyRange.

optional .google.spanner.executor.v1.KeyRange.Type type = 3;

Parameter
Name Description
value KeyRange.Type

The type to set.

Returns
Type Description
KeyRange.Builder

This builder for chaining.

setTypeValue(int value)

public KeyRange.Builder setTypeValue(int value)

"start" and "limit" type for this KeyRange.

optional .google.spanner.executor.v1.KeyRange.Type type = 3;

Parameter
Name Description
value int

The enum numeric value on the wire for type to set.

Returns
Type Description
KeyRange.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final KeyRange.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
KeyRange.Builder
Overrides