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

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

Request message for AttachedClusters.ListAttachedClusters method.

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

Methods

build

Parameter
NameDescription
parent string

Required. The parent location which owns this collection of AttachedCluster 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\AttachedClustersClient::locationName()} for help formatting this field.

Returns
TypeDescription
Google\Cloud\GkeMultiCloud\V1\ListAttachedClustersRequest

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent location which owns this collection of AttachedCluster 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 attachedClusters.list request, if any.

getParent

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

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

Returns
TypeDescription
string

setParent

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

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

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.

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.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

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

Returns
TypeDescription
string

setPageToken

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this