Google Cloud Vmware Engine V1 Client - Class ListClustersRequest (1.2.1)

Reference documentation and code samples for the Google Cloud Vmware Engine V1 Client class ListClustersRequest.

Request message for VmwareEngine.ListClusters

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.

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

Returns
Type	Description
`string`

setParent

Required. The resource name of the private cloud to query for clusters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

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

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.

Returns
Type	Description
`ListClustersRequest`