KeyOffset (Google Cloud Bigtable Parent 2.27.2 API)

java.lang.Object
- com.google.cloud.bigtable.data.v2.models.KeyOffset

All Implemented Interfaces:

Serializable
```
@InternalExtensionOnly
public abstract class KeyOffset
extends Object
implements Serializable
```
Represents the offset of a row key in a table.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

KeyOffset()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`static KeyOffset`	`create(com.google.protobuf.ByteString key, long offsetBytes)`
`abstract com.google.protobuf.ByteString`	`getKey()`	A row key value that is returned as part of the response of `BigtableDataClient.sampleRowKeysAsync(String)`.
`abstract long`	`getOffsetBytes()`	Approximate total storage space used by all rows in the table which precede `getKey()`.

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

- Constructor Detail
  - KeyOffset
```
public KeyOffset()
```
- Method Detail
  - create
```
@InternalApi
public static KeyOffset create(com.google.protobuf.ByteString key,
                               long offsetBytes)
```
  - getKey
```
public abstract com.google.protobuf.ByteString getKey()
```
    A row key value that is returned as part of the response of 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.
  - 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.