Google Anthos Multi Cloud V1 Client - Class ListAwsNodePoolsRequest (0.5.4)

Reference documentation and code samples for the Google Anthos Multi Cloud V1 Client class ListAwsNodePoolsRequest.

Request message for AwsClusters.ListAwsNodePools method.

Generated from protobuf message google.cloud.gkemulticloud.v1.ListAwsNodePoolsRequest

Namespace

Google \ Cloud \ GkeMultiCloud \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The parent AwsCluster which owns this collection of AwsNodePool resources. AwsCluster names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>. See Resource Names for more details on Google Cloud resource names.
↳ page_size int

The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the pageSize value, the response can include a partial list and a caller should only rely on response's nextPageToken to determine if there are more instances left to be queried.
↳ page_token string

The nextPageToken value returned from a previous awsNodePools.list request, if any.

getParent

Required. The parent AwsCluster which owns this collection of AwsNodePool resources.

AwsCluster names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>. See Resource Names for more details on Google Cloud resource names.

Returns
Type Description
string

setParent

Required. The parent AwsCluster which owns this collection of AwsNodePool resources.

AwsCluster names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>. See Resource Names for more details on Google Cloud resource names.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of items to return.

If not specified, a default value of 50 will be used by the service. Regardless of the pageSize value, the response can include a partial list and a caller should only rely on response's nextPageToken to determine if there are more instances left to be queried.

Returns
Type Description
int

setPageSize

The maximum number of items to return.

If not specified, a default value of 50 will be used by the service. Regardless of the pageSize value, the response can include a partial list and a caller should only rely on response's nextPageToken to determine if there are more instances left to be queried.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

The nextPageToken value returned from a previous awsNodePools.list request, if any.

Returns
Type Description
string

setPageToken

The nextPageToken value returned from a previous awsNodePools.list request, if any.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent AwsCluster which owns this collection of AwsNodePool resources.

AwsCluster names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>.

See Resource Names for more details on Google Cloud resource names. Please see Google\Cloud\GkeMultiCloud\V1\AwsClustersClient::awsClusterName() for help formatting this field.
Returns
Type Description
Google\Cloud\GkeMultiCloud\V1\ListAwsNodePoolsRequest