2024-01-31
▼ ▲ composer.projects.locations.environments.workloads.list
Path: v1beta1/{+parent}/workloads
Flat Path: v1beta1/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.
▼ ▲ composer.projects.locations.environments.userWorkloadsSecrets.create
Path: v1beta1/{+parent}/userWorkloadsSecrets
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsSecrets
HTTP Method: POST
Parameters:
parent
Description: Required. The environment name to create a Secret for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
Pattern: ^projects/[^/]+/locations/[^/]+/environments/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
▼ ▲ composer.projects.locations.environments.userWorkloadsSecrets.get
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsSecrets/{userWorkloadsSecretsId}
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the Secret to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}"
Pattern: ^projects/[^/]+/locations/[^/]+/environments/[^/]+/userWorkloadsSecrets/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets an existing user workloads Secret. Values of the "data" field in the response are cleared. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
▼ ▲ composer.projects.locations.environments.userWorkloadsSecrets.list
Path: v1beta1/{+parent}/userWorkloadsSecrets
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsSecrets
HTTP Method: GET
Parameters:
parent
Description: Required. List Secrets in the given environment, 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 Secrets 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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists user workloads Secrets. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
▼ ▲ composer.projects.locations.environments.userWorkloadsSecrets.update
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsSecrets/{userWorkloadsSecretsId}
HTTP Method: PUT
Parameters:
name
Description: Identifier. The resource name of the Secret, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}"
Pattern: ^projects/[^/]+/locations/[^/]+/environments/[^/]+/userWorkloadsSecrets/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
▼ ▲ composer.projects.locations.environments.userWorkloadsSecrets.delete
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsSecrets/{userWorkloadsSecretsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The Secret to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}"
Pattern: ^projects/[^/]+/locations/[^/]+/environments/[^/]+/userWorkloadsSecrets/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
▼ ▲ composer.projects.locations.environments.userWorkloadsConfigMaps.create
Path: v1beta1/{+parent}/userWorkloadsConfigMaps
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsConfigMaps
HTTP Method: POST
Parameters:
parent
Description: Required. The environment name to create a ConfigMap for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"
Pattern: ^projects/[^/]+/locations/[^/]+/environments/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
▼ ▲ composer.projects.locations.environments.userWorkloadsConfigMaps.get
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapsId}
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the ConfigMap to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}"
Pattern: ^projects/[^/]+/locations/[^/]+/environments/[^/]+/userWorkloadsConfigMaps/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets an existing user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
▼ ▲ composer.projects.locations.environments.userWorkloadsConfigMaps.list
Path: v1beta1/{+parent}/userWorkloadsConfigMaps
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsConfigMaps
HTTP Method: GET
Parameters:
parent
Description: Required. List ConfigMaps in the given environment, 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 ConfigMaps 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
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists user workloads ConfigMaps. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
▼ ▲ composer.projects.locations.environments.userWorkloadsConfigMaps.update
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapsId}
HTTP Method: PUT
Parameters:
name
Description: Identifier. The resource name of the ConfigMap, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}"
Pattern: ^projects/[^/]+/locations/[^/]+/environments/[^/]+/userWorkloadsConfigMaps/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.
▼ ▲ composer.projects.locations.environments.userWorkloadsConfigMaps.delete
Path: v1beta1/{+name}
Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The ConfigMap to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}"
Pattern: ^projects/[^/]+/locations/[^/]+/environments/[^/]+/userWorkloadsConfigMaps/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.