public final class KeyRange extends GeneratedMessageV3 implements KeyRangeOrBuilderKeyRange 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > KeyRangeImplements
KeyRangeOrBuilderStatic Fields
LIMIT_FIELD_NUMBER
public static final int LIMIT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
START_FIELD_NUMBER
public static final int START_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static KeyRange getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
KeyRange |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static KeyRange.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
KeyRange.Builder |
|
newBuilder(KeyRange prototype)
public static KeyRange.Builder newBuilder(KeyRange prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
KeyRange |
| Returns | |
|---|---|
| Type | Description |
KeyRange.Builder |
|
parseDelimitedFrom(InputStream input)
public static KeyRange parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
KeyRange |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static KeyRange parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
KeyRange |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static KeyRange parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
KeyRange |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static KeyRange parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
KeyRange |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static KeyRange parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
KeyRange |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static KeyRange parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
KeyRange |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static KeyRange parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
KeyRange |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static KeyRange parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
KeyRange |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static KeyRange parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
KeyRange |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static KeyRange parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
KeyRange |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static KeyRange parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
KeyRange |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static KeyRange parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
KeyRange |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<KeyRange> parser()| Returns | |
|---|---|
| Type | Description |
Parser<KeyRange> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public KeyRange getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
KeyRange |
|
getLimit()
public ValueList getLimit()The end key of this KeyRange.
.google.spanner.executor.v1.ValueList limit = 2;
| Returns | |
|---|---|
| Type | Description |
ValueList |
The limit. |
getLimitOrBuilder()
public ValueListOrBuilder getLimitOrBuilder()The end key of this KeyRange.
.google.spanner.executor.v1.ValueList limit = 2;
| Returns | |
|---|---|
| Type | Description |
ValueListOrBuilder |
|
getParserForType()
public Parser<KeyRange> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<KeyRange> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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. |
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. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public KeyRange.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
KeyRange.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected KeyRange.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
KeyRange.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public KeyRange.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
KeyRange.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|