Cloud Composer API . projects . locations . environments . workloads

close()

Close httplib2 connections.

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

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.

Args:
  parent: string, Required. The environment name to get workloads for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" (required)
  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.
  pageSize: integer, Optional. The maximum number of environments to return.
  pageToken: string, Optional. The next_page_token value returned from a previous List request, if any.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response to ListWorkloadsRequest.
  "nextPageToken": "A String", # The page token used to query for the next page if one exists.
  "workloads": [ # The list of environment workloads.
    { # Information about a single workload.
      "name": "A String", # Name of a workload.
      "status": { # Workload status. # Output only. Status of a workload.
        "detailedStatusMessage": "A String", # Output only. Detailed message of the status.
        "state": "A String", # Output only. Workload state.
        "statusMessage": "A String", # Output only. Text to provide more descriptive status.
      },
      "type": "A String", # Type of a workload.
    },
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.