Reference documentation and code samples for the Cloud Bigtable V2 Client class ReadRowsResponse.
Response message for Bigtable.ReadRows.
Generated from protobuf message google.bigtable.v2.ReadRowsResponse
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ chunks |
array<Google\Cloud\Bigtable\V2\ReadRowsResponse\CellChunk>
A collection of a row's contents as part of the read request. |
↳ last_scanned_row_key |
string
Optionally the server might return the row key of the last row it has scanned. The client can use this to construct a more efficient retry request if needed: any row keys or portions of ranges less than this row key can be dropped from the request. This is primarily useful for cases where the server has read a lot of data that was filtered out since the last committed row key, allowing the client to skip that work on a retry. |
↳ request_stats |
Google\Cloud\Bigtable\V2\RequestStats
If requested, provide enhanced query performance statistics. The semantics dictate: * request_stats is empty on every (streamed) response, except * request_stats has non-empty information after all chunks have been streamed, where the ReadRowsResponse message only contains request_stats. * For example, if a read request would have returned an empty response instead a single ReadRowsResponse is streamed with empty chunks and request_stats filled. Visually, response messages will stream as follows: ... -> {chunks: [...]} -> {chunks: [], request_stats: {...}} __/ __/ Primary response Trailer of RequestStats info Or if the read did not return any values: {chunks: [], request_stats: {...}} __/ Trailer of RequestStats info |
getChunks
A collection of a row's contents as part of the read request.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setChunks
A collection of a row's contents as part of the read request.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Bigtable\V2\ReadRowsResponse\CellChunk>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLastScannedRowKey
Optionally the server might return the row key of the last row it has scanned. The client can use this to construct a more efficient retry request if needed: any row keys or portions of ranges less than this row key can be dropped from the request.
This is primarily useful for cases where the server has read a lot of data that was filtered out since the last committed row key, allowing the client to skip that work on a retry.
| Returns | |
|---|---|
| Type | Description |
string | |
setLastScannedRowKey
Optionally the server might return the row key of the last row it has scanned. The client can use this to construct a more efficient retry request if needed: any row keys or portions of ranges less than this row key can be dropped from the request.
This is primarily useful for cases where the server has read a lot of data that was filtered out since the last committed row key, allowing the client to skip that work on a retry.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRequestStats
If requested, provide enhanced query performance statistics. The semantics dictate:
- request_stats is empty on every (streamed) response, except
- request_stats has non-empty information after all chunks have been streamed, where the ReadRowsResponse message only contains request_stats.
- For example, if a read request would have returned an empty response instead a single ReadRowsResponse is streamed with empty chunks and request_stats filled. Visually, response messages will stream as follows: ... -> {chunks: [...]} -> {chunks: [], request_stats: {...}} __/ __/ Primary response Trailer of RequestStats info Or if the read did not return any values: {chunks: [], request_stats: {...}} __/ Trailer of RequestStats info
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Bigtable\V2\RequestStats|null | |
hasRequestStats
clearRequestStats
setRequestStats
If requested, provide enhanced query performance statistics. The semantics dictate:
- request_stats is empty on every (streamed) response, except
- request_stats has non-empty information after all chunks have been streamed, where the ReadRowsResponse message only contains request_stats.
- For example, if a read request would have returned an empty response instead a single ReadRowsResponse is streamed with empty chunks and request_stats filled. Visually, response messages will stream as follows: ... -> {chunks: [...]} -> {chunks: [], request_stats: {...}} __/ __/ Primary response Trailer of RequestStats info Or if the read did not return any values: {chunks: [], request_stats: {...}} __/ Trailer of RequestStats info
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Bigtable\V2\RequestStats
|
| Returns | |
|---|---|
| Type | Description |
$this | |