Reference documentation and code samples for the Cloud Bigtable V2 Client class SampleRowKeysRequest.
Request message for Bigtable.SampleRowKeys.
Generated from protobuf messagegoogle.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 formprojects/<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 formprojects/<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 formprojects/<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 formprojects/<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 formprojects/<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 formprojects/<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 formprojects/<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 formprojects/<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 formprojects/<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 formprojects/<project>/instances/<instance>/tables/<table>. Please seeBigtableClient::tableName()for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Bigtable V2 Client - Class SampleRowKeysRequest (2.17.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.1 (latest)](/php/docs/reference/cloud-bigtable/latest/V2.SampleRowKeysRequest)\n- [2.17.0](/php/docs/reference/cloud-bigtable/2.17.0/V2.SampleRowKeysRequest)\n- [2.16.0](/php/docs/reference/cloud-bigtable/2.16.0/V2.SampleRowKeysRequest)\n- [2.15.0](/php/docs/reference/cloud-bigtable/2.15.0/V2.SampleRowKeysRequest)\n- [2.14.0](/php/docs/reference/cloud-bigtable/2.14.0/V2.SampleRowKeysRequest)\n- [2.13.0](/php/docs/reference/cloud-bigtable/2.13.0/V2.SampleRowKeysRequest)\n- [2.12.0](/php/docs/reference/cloud-bigtable/2.12.0/V2.SampleRowKeysRequest)\n- [2.11.1](/php/docs/reference/cloud-bigtable/2.11.1/V2.SampleRowKeysRequest)\n- [2.9.1](/php/docs/reference/cloud-bigtable/2.9.1/V2.SampleRowKeysRequest)\n- [2.8.0](/php/docs/reference/cloud-bigtable/2.8.0/V2.SampleRowKeysRequest)\n- [2.7.0](/php/docs/reference/cloud-bigtable/2.7.0/V2.SampleRowKeysRequest)\n- [2.6.3](/php/docs/reference/cloud-bigtable/2.6.3/V2.SampleRowKeysRequest)\n- [2.5.0](/php/docs/reference/cloud-bigtable/2.5.0/V2.SampleRowKeysRequest)\n- [2.4.0](/php/docs/reference/cloud-bigtable/2.4.0/V2.SampleRowKeysRequest)\n- [2.3.0](/php/docs/reference/cloud-bigtable/2.3.0/V2.SampleRowKeysRequest)\n- [2.2.1](/php/docs/reference/cloud-bigtable/2.2.1/V2.SampleRowKeysRequest)\n- [2.1.0](/php/docs/reference/cloud-bigtable/2.1.0/V2.SampleRowKeysRequest)\n- [2.0.1](/php/docs/reference/cloud-bigtable/2.0.1/V2.SampleRowKeysRequest)\n- [1.32.1](/php/docs/reference/cloud-bigtable/1.32.1/V2.SampleRowKeysRequest)\n- [1.31.1](/php/docs/reference/cloud-bigtable/1.31.1/V2.SampleRowKeysRequest)\n- [1.30.0](/php/docs/reference/cloud-bigtable/1.30.0/V2.SampleRowKeysRequest)\n- [1.29.2](/php/docs/reference/cloud-bigtable/1.29.2/V2.SampleRowKeysRequest)\n- [1.28.3](/php/docs/reference/cloud-bigtable/1.28.3/V2.SampleRowKeysRequest)\n- [1.27.0](/php/docs/reference/cloud-bigtable/1.27.0/V2.SampleRowKeysRequest)\n- [1.26.2](/php/docs/reference/cloud-bigtable/1.26.2/V2.SampleRowKeysRequest)\n- [1.25.0](/php/docs/reference/cloud-bigtable/1.25.0/V2.SampleRowKeysRequest)\n- [1.24.1](/php/docs/reference/cloud-bigtable/1.24.1/V2.SampleRowKeysRequest)\n- [1.23.0](/php/docs/reference/cloud-bigtable/1.23.0/V2.SampleRowKeysRequest)\n- [1.22.2](/php/docs/reference/cloud-bigtable/1.22.2/V2.SampleRowKeysRequest)\n- [1.21.1](/php/docs/reference/cloud-bigtable/1.21.1/V2.SampleRowKeysRequest)\n- [1.20.3](/php/docs/reference/cloud-bigtable/1.20.3/V2.SampleRowKeysRequest) \nReference documentation and code samples for the Cloud Bigtable V2 Client class SampleRowKeysRequest.\n\nRequest message for Bigtable.SampleRowKeys.\n\nGenerated from protobuf message `google.bigtable.v2.SampleRowKeysRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Bigtable \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getTableName\n\nOptional. The unique name of the table from which to sample row keys.\n\nValues are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/tables/\u003ctable\u003e`.\n\n### setTableName\n\nOptional. The unique name of the table from which to sample row keys.\n\nValues are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/tables/\u003ctable\u003e`.\n\n### getAuthorizedViewName\n\nOptional. The unique name of the AuthorizedView from which to sample row\nkeys.\n\nValues are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/tables/\u003ctable\u003e/authorizedViews/\u003cauthorized_view\u003e`.\n\n### setAuthorizedViewName\n\nOptional. The unique name of the AuthorizedView from which to sample row\nkeys.\n\nValues are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/tables/\u003ctable\u003e/authorizedViews/\u003cauthorized_view\u003e`.\n\n### getMaterializedViewName\n\nOptional. The unique name of the MaterializedView from which to read.\n\nValues are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/materializedViews/\u003cmaterialized_view\u003e`.\n\n### setMaterializedViewName\n\nOptional. The unique name of the MaterializedView from which to read.\n\nValues are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/materializedViews/\u003cmaterialized_view\u003e`.\n\n### getAppProfileId\n\nThis value specifies routing for replication. If not specified, the\n\"default\" application profile will be used.\n\n### setAppProfileId\n\nThis value specifies routing for replication. If not specified, the\n\"default\" application profile will be used.\n\n### static::build\n\n### static::buildFromTableNameAppProfileId"]]
