Google Cloud Vmware Engine V1 Client - Class ListNodesRequest (0.5.5)

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

Request message for VmwareEngine.ListNodes

Generated from protobuf message google.cloud.vmwareengine.v1.ListNodesRequest

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 cluster to be queried for nodes. 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/clusters/my-cluster
↳ page_size int

The maximum number of nodes 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 ListNodes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListNodes must match the call that provided the page token.

getParent

Required. The resource name of the cluster to be queried for nodes.

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/clusters/my-cluster

Returns
Type Description
string

setParent

Required. The resource name of the cluster to be queried for nodes.

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/clusters/my-cluster

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of nodes 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 nodes 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 ListNodes call.

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

Returns
Type Description
string

setPageToken

A page token, received from a previous ListNodes call.

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

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The resource name of the cluster to be queried for nodes. 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/clusters/my-cluster Please see Google\Cloud\VmwareEngine\V1\VmwareEngineClient::clusterName() for help formatting this field.
Returns
Type Description
Google\Cloud\VmwareEngine\V1\ListNodesRequest