Cloud Bigtable V2 Client - Class ListClustersRequest (1.31.1)

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

Request message for BigtableInstanceAdmin.ListClusters.

Generated from protobuf message google.bigtable.admin.v2.ListClustersRequest

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The unique name of the instance for which a list of clusters is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list Clusters for all Instances in a project, e.g., projects/myproject/instances/-.
↳ page_token string

DEPRECATED: This field is unused and ignored.

getParent

Required. The unique name of the instance for which a list of clusters is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list Clusters for all Instances in a project, e.g., projects/myproject/instances/-.

Returns
Type Description
string

setParent

Required. The unique name of the instance for which a list of clusters is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list Clusters for all Instances in a project, e.g., projects/myproject/instances/-.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageToken

DEPRECATED: This field is unused and ignored.

Returns
Type Description
string

setPageToken

DEPRECATED: This field is unused and ignored.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The unique name of the instance for which a list of clusters is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list Clusters for all Instances in a project, e.g., projects/myproject/instances/-. Please see Google\Cloud\Bigtable\Admin\V2\BigtableInstanceAdminClient::instanceName() for help formatting this field.
Returns
Type Description
Google\Cloud\Bigtable\Admin\V2\ListClustersRequest