Reference documentation and code samples for the Cloud Bigtable V2 Client class ReadRowsRequest.
Request message for Bigtable.ReadRows.
Generated from protobuf message google.bigtable.v2.ReadRowsRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ table_name |
string
Required. The unique name of the table from which to read. Values are of the form |
↳ app_profile_id |
string
This value specifies routing for replication. If not specified, the "default" application profile will be used. |
↳ rows |
Google\Cloud\Bigtable\V2\RowSet
The row keys and/or ranges to read sequentially. If not specified, reads from all rows. |
↳ filter |
Google\Cloud\Bigtable\V2\RowFilter
The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row. |
↳ rows_limit |
int|string
The read will stop after committing to N rows' worth of results. The default (zero) is to return all results. |
↳ request_stats_view |
int
The view into RequestStats, as described above. |
getTableName
Required. The unique name of the table from which to read.
Values are of the form
projects/<project>/instances/<instance>/tables/<table>.
| Returns | |
|---|---|
| Type | Description |
string | |
setTableName
Required. The unique name of the table from which to read.
Values are of the form
projects/<project>/instances/<instance>/tables/<table>.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAppProfileId
This value specifies routing for replication. If not specified, the "default" application profile will be used.
| Returns | |
|---|---|
| Type | Description |
string | |
setAppProfileId
This value specifies routing for replication. If not specified, the "default" application profile will be used.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRows
The row keys and/or ranges to read sequentially. If not specified, reads from all rows.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Bigtable\V2\RowSet|null | |
hasRows
clearRows
setRows
The row keys and/or ranges to read sequentially. If not specified, reads from all rows.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Bigtable\V2\RowSet
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Bigtable\V2\RowFilter|null | |
hasFilter
clearFilter
setFilter
The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Bigtable\V2\RowFilter
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRowsLimit
The read will stop after committing to N rows' worth of results. The default (zero) is to return all results.
| Returns | |
|---|---|
| Type | Description |
int|string | |
setRowsLimit
The read will stop after committing to N rows' worth of results. The default (zero) is to return all results.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRequestStatsView
The view into RequestStats, as described above.
| Returns | |
|---|---|
| Type | Description |
int | |
setRequestStatsView
The view into RequestStats, as described above.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |