v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13226495.2 KB
projects

Lists workloads in a Cloud Composer environment. Workload is a unit that runs a single Composer component. This method is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.

get/v1/{+parent}/workloads

Path parameters

parentstring required

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

Query parameters

filterstring

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.

pageSizeinteger

Optional. The maximum number of environments to return.

pageTokenstring

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

Response

Successful response