Reference documentation and code samples for the Cloud Bigtable V2 Client class SampleRowKeysResponse.
Response message for Bigtable.SampleRowKeys.
Generated from protobuf message google.bigtable.v2.SampleRowKeysResponse
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ row_key |
string
Sorted streamed sequence of sample row keys in the table. The table might have contents before the first row key in the list and after the last one, but a key containing the empty string indicates "end of table" and will be the last response given, if present. Note that row keys in this list 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. |
↳ offset_bytes |
int|string
Approximate total storage space used by all rows in the table which precede |
getRowKey
Sorted streamed sequence of sample row keys in the table. The table might have contents before the first row key in the list and after the last one, but a key containing the empty string indicates "end of table" and will be the last response given, if present.
Note that row keys in this list 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 |
string | |
setRowKey
Sorted streamed sequence of sample row keys in the table. The table might have contents before the first row key in the list and after the last one, but a key containing the empty string indicates "end of table" and will be the last response given, if present.
Note that row keys in this list 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOffsetBytes
Approximate total storage space used by all rows in the table which precede
row_key. Buffering the contents of all rows between two subsequent
samples would require space roughly equal to the difference in their
offset_bytes fields.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setOffsetBytes
Approximate total storage space used by all rows in the table which precede
row_key. Buffering the contents of all rows between two subsequent
samples would require space roughly equal to the difference in their
offset_bytes fields.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |