workloads

Creates, updates, deletes, gets or lists a workloads resource.

Overview

Name	workloads
Type	Resource
Id	google.composer.workloads

Fields

The following fields are returned by SELECT queries:

list

Successful response

Name	Datatype	Description
name	string	Name of a workload.
status	object	Output only. Status of a workload. (id: ComposerWorkloadStatus)
type	string	Type of a workload.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	projectsId, locationsId, environmentsId	pageSize, pageToken, filter	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
environmentsId	string
locationsId	string
projectsId	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

list

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.

SELECT
name,
status,
type
FROM google.composer.workloads
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';