Cloud Bigtable V2 Client - Class SampleRowKeysRequest (1.24.1)

Reference documentation and code samples for the Cloud Bigtable V2 Client class SampleRowKeysRequest.

Request message for Bigtable.SampleRowKeys.

Generated from protobuf message google.bigtable.v2.SampleRowKeysRequest

Namespace

Google \ Cloud \ Bigtable \ V2

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 sample row keys. 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.

getTableName

Required. The unique name of the table from which to sample row keys.

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 sample row keys.

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

static::build

Parameter
Name Description
tableName string

Required. The unique name of the table from which to sample row keys. 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
Type Description
Google\Cloud\Bigtable\V2\SampleRowKeysRequest

static::buildFromTableNameAppProfileId

Parameters
Name Description
tableName string

Required. The unique name of the table from which to sample row keys. 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
Type Description
Google\Cloud\Bigtable\V2\SampleRowKeysRequest