Google Anthos Multi Cloud V1 Client - Class ListAwsClustersRequest (0.3.0)

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

Request message for AwsClusters.ListAwsClusters method.

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

Methods

build

Parameter
Name
Description
parent
string

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

Location names are formatted as projects/<project-id>/locations/<region> .

See Resource Names for more details on Google Cloud Platform resource names. Please see {@see \Google\Cloud\GkeMultiCloud\V1\AwsClustersClient::locationName()} for help formatting this field.

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ parent
string

Required. The parent location which owns this collection of AwsCluster resources. Location names are formatted as projects/<project-id>/locations/<region> . See Resource Names for more details on Google Cloud Platform 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 awsClusters.list request, if any.

getParent

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

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

Returns
Type
Description
string

setParent

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

Location names are formatted as projects/<project-id>/locations/<region> . See Resource Names for more details on Google Cloud Platform 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 awsClusters.list request, if any.

Returns
Type
Description
string

setPageToken

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: