Class Range (6.107.0)
Version latestkeyboard_arrow_down
public final class Range extends GeneratedMessageV3 implements RangeOrBuilder
A Range represents a range of keys in a database. The keys themselves
are encoded in "sortable string format", also known as ssformat. Consult
Spanner's open source client libraries for details on the encoding.
Each range represents a contiguous range of rows, possibly from multiple
tables/indexes. Each range is associated with a single paxos group (known as
a "group" throughout this API), a split (which names the exact range within
the group), and a generation that can be used to determine whether a given
Range represents a newer or older location for the key range.
Protobuf type google.spanner.v1.Range
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
GENERATION_FIELD_NUMBER
public static final int GENERATION_FIELD_NUMBER
Field Value
Type Description
int
GROUP_UID_FIELD_NUMBER
public static final int GROUP_UID_FIELD_NUMBER
Field Value
Type Description
int
LIMIT_KEY_FIELD_NUMBER
public static final int LIMIT_KEY_FIELD_NUMBER
Field Value
Type Description
int
SPLIT_ID_FIELD_NUMBER
public static final int SPLIT_ID_FIELD_NUMBER
Field Value
Type Description
int
START_KEY_FIELD_NUMBER
public static final int START_KEY_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static Range getDefaultInstance ()
Returns
Type Description
Range
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Range . Builder newBuilder ()
newBuilder(Range prototype)
public static Range . Builder newBuilder ( Range prototype )
Parameter
Name Description
prototypeRange
public static Range parseDelimitedFrom ( InputStream input )
Returns
Type Description
Range
public static Range parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Range
parseFrom(byte[] data)
public static Range parseFrom ( byte [] data )
Parameter
Name Description
databyte []
Returns
Type Description
Range
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Range parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Range
parseFrom(ByteString data)
public static Range parseFrom ( ByteString data )
Returns
Type Description
Range
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Range parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Range
public static Range parseFrom ( CodedInputStream input )
Returns
Type Description
Range
public static Range parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Range
public static Range parseFrom ( InputStream input )
Returns
Type Description
Range
public static Range parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Range
parseFrom(ByteBuffer data)
public static Range parseFrom ( ByteBuffer data )
Returns
Type Description
Range
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Range parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Range
parser()
public static Parser<Range> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public Range getDefaultInstanceForType ()
Returns
Type Description
Range
getGeneration()
public ByteString getGeneration ()
generation indicates the freshness of the range information contained
in this proto. Generations can be compared lexicographically; if generation
A is greater than generation B, then the Range corresponding to A is
newer than the Range corresponding to B, and should be used
preferentially.
bytes generation = 5;
Returns
Type Description
ByteString The generation.
getGroupUid()
public long getGroupUid ()
The UID of the paxos group where this range is stored. UIDs are unique
within the database. References Group.group_uid.
uint64 group_uid = 3;
Returns
Type Description
long The groupUid.
getLimitKey()
public ByteString getLimitKey ()
The limit key of the range, exclusive. Encoded in "sortable string format"
(ssformat).
bytes limit_key = 2;
getParserForType()
public Parser<Range> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getSplitId()
A group can store multiple ranges of keys. Each key range is named by an
ID (the split ID). Within a group, split IDs are unique. The split_id
names the exact split in group_uid where this range is stored.
uint64 split_id = 4;
Returns
Type Description
long The splitId.
getStartKey()
public ByteString getStartKey ()
The start key of the range, inclusive. Encoded in "sortable string format"
(ssformat).
bytes start_key = 1;
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Range . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Range . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Range . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-21 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-01-21 UTC."],[],[]]
