Cloud Bigtable V2 Client - Class ListMemoryLayersRequest (2.29.0)

2.29.0 (latest) 2.25.0 2.24.0 2.23.0 2.22.0 2.21.1 2.20.2 2.19.2 2.18.0 2.17.1 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.1 2.9.1 2.8.0 2.7.0 2.6.3 2.5.0 2.4.0 2.3.0 2.2.1 2.1.0 2.0.1 1.32.1 1.31.1 1.30.0 1.29.2 1.28.3 1.27.0 1.26.2 1.25.0 1.24.1 1.23.0 1.22.2 1.21.1 1.20.3

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

Request message for BigtableInstanceAdmin.ListMemoryLayers.

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

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 cluster for which a list of memory layers is requested. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}. Use {cluster} = '-' to list MemoryLayers for all Clusters in an instance, e.g., projects/myproject/instances/myinstance/clusters/-.
↳ page_size	int Optional. The maximum number of memory layers to return. The service may return fewer than this value.
↳ page_token	string Optional. A page token, received from a previous ListMemoryLayers call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMemoryLayers must match the call that provided the page token.

getParent

Required. The unique name of the cluster for which a list of memory layers is requested. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

Use {cluster} = '-' to list MemoryLayers for all Clusters in an instance, e.g., projects/myproject/instances/myinstance/clusters/-.

Returns
Type	Description
string

setParent

Required. The unique name of the cluster for which a list of memory layers is requested. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

Use {cluster} = '-' to list MemoryLayers for all Clusters in an instance, e.g., projects/myproject/instances/myinstance/clusters/-.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

Optional. The maximum number of memory layers to return. The service may return fewer than this value.

Returns
Type	Description
int

setPageSize

Optional. The maximum number of memory layers to return. The service may return fewer than this value.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

Optional. A page token, received from a previous ListMemoryLayers call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMemoryLayers must match the call that provided the page token.

Returns
Type	Description
string

setPageToken

Optional. A page token, received from a previous ListMemoryLayers call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListMemoryLayers must match the call that provided the page token.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
parent	string Required. The unique name of the cluster for which a list of memory layers is requested. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}. Use {cluster} = '-' to list MemoryLayers for all Clusters in an instance, e.g., projects/myproject/instances/myinstance/clusters/-. Please see BigtableInstanceAdminClient::clusterName() for help formatting this field.

Returns
Type	Description
ListMemoryLayersRequest