Generated from protobuf message google.cloud.vmwareengine.v1.ListClustersRequest
Namespace
Google \ Cloud \ VmwareEngine \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The resource name of the private cloud to query for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-central1-a/privateClouds/my-cloud
↳ page_size
int
The maximum number of clusters to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
↳ page_token
string
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
To filter on multiple expressions, provide each separate expression within parentheses. For example: (name = "example-cluster") (nodeCount = "3") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: (name = "example-cluster-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "example-cluster-2")
↳ order_by
string
Sorts list results by a certain order. By default, returned results are ordered by name in ascending order. You can also sort results in descending order based on the name value using orderBy="name desc". Currently, only ordering by name is supported.
getParent
Required. The resource name of the private cloud to query for clusters.
The maximum number of clusters to return in one page.
The service may return fewer than this value.
The maximum value is coerced to 1000.
The default value of this field is 500.
Returns
Type
Description
int
setPageSize
The maximum number of clusters to return in one page.
The service may return fewer than this value.
The maximum value is coerced to 1000.
The default value of this field is 500.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
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
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
To filter on multiple expressions, provide each separate expression within
parentheses. For example:
(name = "example-cluster")
(nodeCount = "3")
By default, each expression is an AND expression. However, you can
include AND and OR expressions explicitly. For example:
(name = "example-cluster-1") AND
(createTime > "2021-04-12T08:15:10.40Z") OR
(name = "example-cluster-2")
Returns
Type
Description
string
setFilter
To filter on multiple expressions, provide each separate expression within
parentheses. For example:
(name = "example-cluster")
(nodeCount = "3")
By default, each expression is an AND expression. However, you can
include AND and OR expressions explicitly. For example:
(name = "example-cluster-1") AND
(createTime > "2021-04-12T08:15:10.40Z") OR
(name = "example-cluster-2")
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOrderBy
Sorts list results by a certain order. By default, returned results are
ordered by name in ascending order. You can also sort results in
descending order based on the name value using orderBy="name desc".
Currently, only ordering by name is supported.
Returns
Type
Description
string
setOrderBy
Sorts list results by a certain order. By default, returned results are
ordered by name in ascending order. You can also sort results in
descending order based on the name value using orderBy="name desc".
Currently, only ordering by name is supported.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The resource name of the private cloud to query for clusters.
Resource names are schemeless URIs that follow the conventions in
https://cloud.google.com/apis/design/resource_names.
For example:
projects/my-project/locations/us-central1-a/privateClouds/my-cloud
Please see VmwareEngineClient::privateCloudName() 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-09 UTC."],[],[],null,["# Google Cloud Vmware Engine V1 Client - Class ListClustersRequest (1.1.4)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.4 (latest)](/php/docs/reference/cloud-vmware-engine/latest/V1.ListClustersRequest)\n- [1.1.3](/php/docs/reference/cloud-vmware-engine/1.1.3/V1.ListClustersRequest)\n- [1.0.0](/php/docs/reference/cloud-vmware-engine/1.0.0/V1.ListClustersRequest)\n- [0.5.6](/php/docs/reference/cloud-vmware-engine/0.5.6/V1.ListClustersRequest)\n- [0.4.0](/php/docs/reference/cloud-vmware-engine/0.4.0/V1.ListClustersRequest)\n- [0.3.3](/php/docs/reference/cloud-vmware-engine/0.3.3/V1.ListClustersRequest)\n- [0.2.1](/php/docs/reference/cloud-vmware-engine/0.2.1/V1.ListClustersRequest)\n- [0.1.4](/php/docs/reference/cloud-vmware-engine/0.1.4/V1.ListClustersRequest) \nReference documentation and code samples for the Google Cloud Vmware Engine V1 Client class ListClustersRequest.\n\nRequest message for\n[VmwareEngine.ListClusters](/php/docs/reference/cloud-vmware-engine/latest/V1.Client.VmwareEngineClient#_Google_Cloud_VmwareEngine_V1_Client_VmwareEngineClient__listClusters__)\n\nGenerated from protobuf message `google.cloud.vmwareengine.v1.ListClustersRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ VmwareEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The resource name of the private cloud to query for clusters.\n\nResource names are schemeless URIs that follow the conventions in\n\u003chttps://cloud.google.com/apis/design/resource_names\u003e.\nFor example:\n`projects/my-project/locations/us-central1-a/privateClouds/my-cloud`\n\n### setParent\n\nRequired. The resource name of the private cloud to query for clusters.\n\nResource names are schemeless URIs that follow the conventions in\n\u003chttps://cloud.google.com/apis/design/resource_names\u003e.\nFor example:\n`projects/my-project/locations/us-central1-a/privateClouds/my-cloud`\n\n### getPageSize\n\nThe maximum number of clusters to return in one page.\n\nThe service may return fewer than this value.\nThe maximum value is coerced to 1000.\nThe default value of this field is 500.\n\n### setPageSize\n\nThe maximum number of clusters to return in one page.\n\nThe service may return fewer than this value.\nThe maximum value is coerced to 1000.\nThe default value of this field is 500.\n\n### getPageToken\n\nA page token, received from a previous `ListClusters` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `ListClusters`\nmust match the call that provided the page token.\n\n### setPageToken\n\nA page token, received from a previous `ListClusters` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `ListClusters`\nmust match the call that provided the page token.\n\n### getFilter\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example: \n\n (name = \"example-cluster\")\n (nodeCount = \"3\")\n\nBy default, each expression is an `AND` expression. However, you can\ninclude `AND` and `OR` expressions explicitly. For example: \n\n (name = \"example-cluster-1\") AND\n (createTime \u003e \"2021-04-12T08:15:10.40Z\") OR\n (name = \"example-cluster-2\")\n\n### setFilter\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example: \n\n (name = \"example-cluster\")\n (nodeCount = \"3\")\n\nBy default, each expression is an `AND` expression. However, you can\ninclude `AND` and `OR` expressions explicitly. For example: \n\n (name = \"example-cluster-1\") AND\n (createTime \u003e \"2021-04-12T08:15:10.40Z\") OR\n (name = \"example-cluster-2\")\n\n### getOrderBy\n\nSorts list results by a certain order. By default, returned results are\nordered by `name` in ascending order. You can also sort results in\ndescending order based on the `name` value using `orderBy=\"name desc\"`.\n\nCurrently, only ordering by `name` is supported.\n\n### setOrderBy\n\nSorts list results by a certain order. By default, returned results are\nordered by `name` in ascending order. You can also sort results in\ndescending order based on the `name` value using `orderBy=\"name desc\"`.\n\nCurrently, only ordering by `name` is supported.\n\n### static::build"]]
