Cloud Bigtable V2 Client - Class SampleRowKeysRequest (2.19.2)

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` Optional. The unique name of the table from which to sample row keys. 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 sample row keys. 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.

getTableName

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

Optional. 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`

getAuthorizedViewName

Optional. The unique name of the AuthorizedView from which to sample row keys.

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

Returns
Type	Description
`string`

setAuthorizedViewName

Optional. The unique name of the AuthorizedView from which to sample row keys.

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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>.

Returns
Type	Description
`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>.

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

Optional. 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 BigtableClient::tableName() for help formatting this field.

Returns
Type	Description
`SampleRowKeysRequest`

static::buildFromTableNameAppProfileId

Parameters

Name Description

tableName

string

Optional. 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 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
`SampleRowKeysRequest`