Cloud Bigtable V2 Client - Class ReadRowsRequest (1.30.0)

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 \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
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 projects/<project>/instances/<instance>/tables/<table>.

↳ 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.

↳ 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

Required. The unique name of the table from which to read.

Values are of the form projects/<project>/instances/<instance>/tables/<table>.

Returns
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getAppProfileId

This value specifies routing for replication. If not specified, the "default" application profile will be used.

Returns
TypeDescription
string

setAppProfileId

This value specifies routing for replication. If not specified, the "default" application profile will be used.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRows

The row keys and/or ranges to read sequentially. If not specified, reads from all rows.

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Bigtable\V2\RowSet
Returns
TypeDescription
$this

getFilter

The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Bigtable\V2\RowFilter
Returns
TypeDescription
$this

getRowsLimit

The read will stop after committing to N rows' worth of results. The default (zero) is to return all results.

Returns
TypeDescription
int|string

setRowsLimit

The read will stop after committing to N rows' worth of results. The default (zero) is to return all results.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getRequestStatsView

The view into RequestStats, as described above.

Returns
TypeDescription
int

setRequestStatsView

The view into RequestStats, as described above.

Parameter
NameDescription
var int
Returns
TypeDescription
$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"} ]

Returns
TypeDescription
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"} ]

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
tableName string

Required. The unique name of the table from which to read. Values are of the form projects/<project>/instances/<instance>/tables/<table>. Please see Google\Cloud\Bigtable\V2\BigtableClient::tableName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\Bigtable\V2\ReadRowsRequest

static::buildFromTableNameAppProfileId

Parameters
NameDescription
tableName string

Required. The unique name of the table from which to read. Values are of the form projects/<project>/instances/<instance>/tables/<table>. Please see Google\Cloud\Bigtable\V2\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.

Returns
TypeDescription
Google\Cloud\Bigtable\V2\ReadRowsRequest