Google Cloud Orchestration Airflow V1 Client - Class ListWorkloadsRequest (2.1.0)

Reference documentation and code samples for the Google Cloud Orchestration Airflow V1 Client class ListWorkloadsRequest.

Request for listing workloads in a Cloud Composer environment.

Generated from protobuf message google.cloud.orchestration.airflow.service.v1.ListWorkloadsRequest

Namespace

Google \ Cloud \ Orchestration \ Airflow \ Service \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The environment name to get workloads for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

↳ page_size int

Optional. The maximum number of environments to return.

↳ page_token string

Optional. The next_page_token value returned from a previous List request, if any.

↳ filter string

Optional. The list filter. Currently only supports equality on the type field. The value of a field specified in the filter expression must be one ComposerWorkloadType enum option. It's possible to get multiple types using "OR" operator, e.g.: "type=SCHEDULER OR type=CELERY_WORKER". If not specified, all items are returned.

getParent

Required. The environment name to get workloads for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

Returns
Type Description
string

setParent

Required. The environment name to get workloads for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of environments to return.

Returns
Type Description
int

setPageSize

Optional. The maximum number of environments to return.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. The next_page_token value returned from a previous List request, if any.

Returns
Type Description
string

setPageToken

Optional. The next_page_token value returned from a previous List request, if any.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. The list filter.

Currently only supports equality on the type field. The value of a field specified in the filter expression must be one ComposerWorkloadType enum option. It's possible to get multiple types using "OR" operator, e.g.: "type=SCHEDULER OR type=CELERY_WORKER". If not specified, all items are returned.

Returns
Type Description
string

setFilter

Optional. The list filter.

Currently only supports equality on the type field. The value of a field specified in the filter expression must be one ComposerWorkloadType enum option. It's possible to get multiple types using "OR" operator, e.g.: "type=SCHEDULER OR type=CELERY_WORKER". If not specified, all items are returned.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The environment name to get workloads for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" Please see Google\Cloud\Orchestration\Airflow\Service\V1\EnvironmentsClient::environmentName() for help formatting this field.

Returns
Type Description
Google\Cloud\Orchestration\Airflow\Service\V1\ListWorkloadsRequest