Reference documentation and code samples for the Google Cloud Managed Kafka V1 Client class ListClustersRequest.
Request for ListClusters.
Generated from protobuf messagegoogle.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 likeprojects/{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 previousListClusterscall. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListClustersmust 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
likeprojects/{project}/locations/{location}.
Returns
Type
Description
string
setParent
Required. The parent location whose clusters are to be listed. Structured
likeprojects/{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 previousListClusterscall.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided toListClustersmust match
the call that provided the page token.
Returns
Type
Description
string
setPageToken
Optional. A page token, received from a previousListClusterscall.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided toListClustersmust 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
likeprojects/{project}/locations/{location}. Please seeManagedKafkaClient::locationName()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,["# Google Cloud Managed Kafka V1 Client - Class ListClustersRequest (0.6.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.6.1 (latest)](/php/docs/reference/cloud-managedkafka/latest/V1.ListClustersRequest)\n- [0.6.0](/php/docs/reference/cloud-managedkafka/0.6.0/V1.ListClustersRequest)\n- [0.5.0](/php/docs/reference/cloud-managedkafka/0.5.0/V1.ListClustersRequest)\n- [0.4.1](/php/docs/reference/cloud-managedkafka/0.4.1/V1.ListClustersRequest)\n- [0.3.1](/php/docs/reference/cloud-managedkafka/0.3.1/V1.ListClustersRequest)\n- [0.2.3](/php/docs/reference/cloud-managedkafka/0.2.3/V1.ListClustersRequest)\n- [0.1.3](/php/docs/reference/cloud-managedkafka/0.1.3/V1.ListClustersRequest) \nReference documentation and code samples for the Google Cloud Managed Kafka V1 Client class ListClustersRequest.\n\nRequest for ListClusters.\n\nGenerated from protobuf message `google.cloud.managedkafka.v1.ListClustersRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ ManagedKafka \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent location whose clusters are to be listed. Structured\nlike `projects/{project}/locations/{location}`.\n\n### setParent\n\nRequired. The parent location whose clusters are to be listed. Structured\nlike `projects/{project}/locations/{location}`.\n\n### getPageSize\n\nOptional. The maximum number of clusters to return. The service may return\nfewer than this value. If unspecified, server will pick an appropriate\ndefault.\n\n### setPageSize\n\nOptional. The maximum number of clusters to return. The service may return\nfewer than this value. If unspecified, server will pick an appropriate\ndefault.\n\n### getPageToken\n\nOptional. A page token, received from a previous `ListClusters` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `ListClusters` must match\nthe call that provided the page token.\n\n### setPageToken\n\nOptional. A page token, received from a previous `ListClusters` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `ListClusters` must match\nthe call that provided the page token.\n\n### getFilter\n\nOptional. Filter expression for the result.\n\n### setFilter\n\nOptional. Filter expression for the result.\n\n### getOrderBy\n\nOptional. Order by fields for the result.\n\n### setOrderBy\n\nOptional. Order by fields for the result.\n\n### static::build"]]
