Cloud Composer API (composer:v1)

Additions

Methods


• ▼ ▲ composer.projects.locations.environments.workloads.list

  Path: v1/{+parent}/workloads

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/workloads

  HTTP Method: GET

  Parameters:

  parent

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

  Pattern: ^projects/[^/]+/locations/[^/]+/environments/[^/]+$

  Location: path

  Required: Yes

  Type: string

  pageSize

  Description: Optional. The maximum number of environments to return.

  Location: query

  Type: integer

  Format: int32

  pageToken

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

  Location: query

  Type: string

  filter

  Description: 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.

  Location: query

  Type: string

  Parameter Order: parent

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Description: 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-3.*.*-airflow-*.*.* and newer.