Google Cloud Cloud Controls Partner V1beta Client - Class ListWorkloadsRequest (0.2.0)

Reference documentation and code samples for the Google Cloud Cloud Controls Partner V1beta Client class ListWorkloadsRequest.

Request to list customer workloads.

Generated from protobuf message google.cloud.cloudcontrolspartner.v1beta.ListWorkloadsRequest

Namespace

Google \ Cloud \ CloudControlsPartner \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. Parent resource Format: `organizations/{organization}/locations/{location}/customers/{customer}`
`↳ page_size`	`int` The maximum number of workloads to return. The service may return fewer than this value. If unspecified, at most 500 workloads will be returned.
`↳ page_token`	`string` A page token, received from a previous `ListWorkloads` call. Provide this to retrieve the subsequent page.
`↳ filter`	`string` Optional. Filtering results.
`↳ order_by`	`string` Optional. Hint for how to order the results.

getParent

Required. Parent resource Format: organizations/{organization}/locations/{location}/customers/{customer}

Returns
Type	Description
`string`

setParent

Required. Parent resource Format: organizations/{organization}/locations/{location}/customers/{customer}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

The maximum number of workloads to return. The service may return fewer than this value. If unspecified, at most 500 workloads will be returned.

Returns
Type	Description
`int`

setPageSize

The maximum number of workloads to return. The service may return fewer than this value. If unspecified, at most 500 workloads will be returned.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

A page token, received from a previous ListWorkloads call.

Provide this to retrieve the subsequent page.

Returns
Type	Description
`string`

setPageToken

A page token, received from a previous ListWorkloads call.

Provide this to retrieve the subsequent page.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilter

Optional. Filtering results.

Returns
Type	Description
`string`

setFilter

Optional. Filtering results.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOrderBy

Optional. Hint for how to order the results.

Returns
Type	Description
`string`

setOrderBy

Optional. Hint for how to order the results.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`parent`	`string` Required. Parent resource Format: `organizations/{organization}/locations/{location}/customers/{customer}` Please see Google\Cloud\CloudControlsPartner\V1beta\CloudControlsPartnerCoreClient::customerName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\CloudControlsPartner\V1beta\ListWorkloadsRequest`