Google Cloud Managed Kafka V1 Client - Class ListClustersRequest (0.1.1)

Reference documentation and code samples for the Google Cloud Managed Kafka V1 Client class ListClustersRequest.

Request for ListClusters.

Generated from protobuf message google.cloud.managedkafka.v1.ListClustersRequest

Namespace

Google \ Cloud \ ManagedKafka \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent location whose clusters are to be listed. Structured like projects/{project}/locations/{location}.

↳ page_size int

Optional. The maximum number of clusters to return. The service may return fewer than this value. If unspecified, server will pick an appropriate default.

↳ page_token string

Optional. A page token, received from a previous ListClusters call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListClusters must match the call that provided the page token.

↳ filter string

Optional. Filter expression for the result.

↳ order_by string

Optional. Order by fields for the result.

getParent

Required. The parent location whose clusters are to be listed. Structured like projects/{project}/locations/{location}.

Returns
Type Description
string

setParent

Required. The parent location whose clusters are to be listed. Structured like projects/{project}/locations/{location}.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of clusters to return. The service may return fewer than this value. If unspecified, server will pick an appropriate default.

Returns
Type Description
int

setPageSize

Optional. The maximum number of clusters to return. The service may return fewer than this value. If unspecified, server will pick an appropriate default.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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

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

Returns
Type Description
string

setPageToken

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

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

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. Filter expression for the result.

Returns
Type Description
string

setFilter

Optional. Filter expression for the result.

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. Order by fields for the result.

Returns
Type Description
string

setOrderBy

Optional. Order by fields for the result.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent location whose clusters are to be listed. Structured like projects/{project}/locations/{location}. Please see Google\Cloud\ManagedKafka\V1\ManagedKafkaClient::locationName() for help formatting this field.

Returns
Type Description
Google\Cloud\ManagedKafka\V1\ListClustersRequest