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
Namespace
Google \ Cloud \ Bigtable \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ table_name
string
Optional. The unique name of the table from which to read. Values are of the form projects/<project>/instances/<instance>/tables/<table>
.
↳ authorized_view_name
string
Optional. The unique name of the AuthorizedView from which to read. Values are of the form projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>
.
↳ materialized_view_name
string
Optional. The unique name of the MaterializedView from which to read. Values are of the form projects/<project>/instances/<instance>/materializedViews/<materialized_view>
.
↳ app_profile_id
string
This value specifies routing for replication. If not specified, the "default" application profile will be used.
↳ rows
↳ filter
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.
↳ reversed
bool
Experimental API - Please note that this API is currently experimental and can change in the future. Return rows in lexiographical descending order of the row keys. The row contents will not be affected by this flag. Example result set: [ {key: "k2", "f:col1": "v1", "f:col2": "v1"}, {key: "k1", "f:col1": "v2", "f:col2": "v2"} ]
getTableName
Optional. The unique name of the table from which to read.
Values are of the form projects/<project>/instances/<instance>/tables/<table>
.
string
setTableName
Optional. The unique name of the table from which to read.
Values are of the form projects/<project>/instances/<instance>/tables/<table>
.
var
string
$this
getAuthorizedViewName
Optional. The unique name of the AuthorizedView from which to read.
Values are of the form projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>
.
string
setAuthorizedViewName
Optional. The unique name of the AuthorizedView from which to read.
Values are of the form projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>
.
var
string
$this
getMaterializedViewName
Optional. The unique name of the MaterializedView from which to read.
Values are of the form projects/<project>/instances/<instance>/materializedViews/<materialized_view>
.
string
setMaterializedViewName
Optional. The unique name of the MaterializedView from which to read.
Values are of the form projects/<project>/instances/<instance>/materializedViews/<materialized_view>
.
var
string
$this
getAppProfileId
This value specifies routing for replication. If not specified, the "default" application profile will be used.
string
setAppProfileId
This value specifies routing for replication. If not specified, the "default" application profile will be used.
var
string
$this
getRows
The row keys and/or ranges to read sequentially. If not specified, reads from all rows.
hasRows
clearRows
setRows
The row keys and/or ranges to read sequentially. If not specified, reads from all rows.
$this
getFilter
The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.
hasFilter
clearFilter
setFilter
The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.
$this
getRowsLimit
The read will stop after committing to N rows' worth of results. The default (zero) is to return all results.
int|string
setRowsLimit
The read will stop after committing to N rows' worth of results. The default (zero) is to return all results.
var
int|string
$this
getRequestStatsView
The view into RequestStats, as described above.
int
setRequestStatsView
The view into RequestStats, as described above.
var
int
$this
getReversed
Experimental API - Please note that this API is currently experimental and can change in the future.
Return rows in lexiographical descending order of the row keys. The row contents will not be affected by this flag. Example result set: [ {key: "k2", "f:col1": "v1", "f:col2": "v1"}, {key: "k1", "f:col1": "v2", "f:col2": "v2"} ]
bool
setReversed
Experimental API - Please note that this API is currently experimental and can change in the future.
Return rows in lexiographical descending order of the row keys. The row contents will not be affected by this flag. Example result set: [ {key: "k2", "f:col1": "v1", "f:col2": "v1"}, {key: "k1", "f:col1": "v2", "f:col2": "v2"} ]
var
bool
$this
static::build
tableName
string
Optional. The unique name of the table from which to read.
Values are of the form projects/<project>/instances/<instance>/tables/<table>
. Please see BigtableClient::tableName()
for help formatting this field.
static::buildFromTableNameAppProfileId
tableName
string
Optional. The unique name of the table from which to read.
Values are of the form projects/<project>/instances/<instance>/tables/<table>
. Please see BigtableClient::tableName()
for help formatting this field.
appProfileId
string
This value specifies routing for replication. If not specified, the "default" application profile will be used.
