Google Anthos Multi Cloud V1 Client - Class ListAwsNodePoolsRequest (0.1.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

Methods

__construct

Constructor.

Parameters
NameDescription
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.

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
TypeDescription
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.

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field int32 page_size = 2;

Returns
TypeDescription
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.

Generated from protobuf field int32 page_size = 2;

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

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

Generated from protobuf field string page_token = 3;

Returns
TypeDescription
string

setPageToken

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

Generated from protobuf field string page_token = 3;

Parameter
NameDescription
var string
Returns
TypeDescription
$this