Cloud Bigtable V2 Client - Class ListAppProfilesRequest (2.5.0)

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

Request message for BigtableInstanceAdmin.ListAppProfiles.

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

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 app profiles is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list AppProfiles for all Instances in a project, e.g., projects/myproject/instances/-.
↳ page_size int

Maximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request.
↳ page_token string

The value of next_page_token returned by a previous call.

getParent

Required. The unique name of the instance for which a list of app profiles is requested. Values are of the form projects/{project}/instances/{instance}.

Use {instance} = '-' to list AppProfiles 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 app profiles is requested. Values are of the form projects/{project}/instances/{instance}.

Use {instance} = '-' to list AppProfiles for all Instances in a project, e.g., projects/myproject/instances/-.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Maximum number of results per page.

A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request.

Returns
Type Description
int

setPageSize

Maximum number of results per page.

A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

The value of next_page_token returned by a previous call.

Returns
Type Description
string

setPageToken

The value of next_page_token returned by a previous call.

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 app profiles is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list AppProfiles 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\ListAppProfilesRequest