Class KeyOffset (2.51.0)

Version latest

• 2.51.0 (latest)
• 2.49.0
• 2.46.0
• 2.45.1
• 2.44.1
• 2.43.0
• 2.42.0
• 2.40.0
• 2.39.5
• 2.37.0
• 2.35.1
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.1
• 2.28.0

public abstract class KeyOffset implements Serializable

Represents the offset of a row key in a table.

Inheritance

java.lang.Object > KeyOffset

Implements

Serializable

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(ByteString key, long offsetBytes)

public static KeyOffset create(ByteString key, long offsetBytes)

Internal Only: This feature is not stable for application use.

Parameters
Name	Description
key	ByteString
offsetBytes	long

Returns
Type	Description
KeyOffset

Constructors

KeyOffset()

public KeyOffset()

Methods

getKey()

public abstract ByteString getKey()

A row key value that is returned as part of the response of com.google.cloud.bigtable.data.v2.BigtableDataClient#sampleRowKeysAsync(String). The key represents end boundary of one of the contiguous sections in a list of approximately equal sized sections.

Note that row key may not have ever been written to or read from, and users should therefore not make any assumptions about the row key structure that are specific to their use case.

Returns
Type	Description
ByteString

getOffsetBytes()

public abstract long getOffsetBytes()

Approximate total storage space used by all rows in the table which precede #getKey(). Buffering the contents of all rows between two subsequent samples would require space roughly equal to the difference in their #getOffsetBytes() fields.

Returns
Type	Description
long