Cloud Composer API (composer:v1)

Additions

Methods


• ▼ ▲ composer.projects.locations.environments.hibernate

  Parameter Order : name

  HTTP Method : POST

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

  Parameters :

  name

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

  Location : path

  Description : Required. The resource name of the environment to hibernate, in the form: "projects/{project}/locations/{location}/environments/{environment}"

  Type : string

  Required : Yes

  Description : Hibernates (pauses) a running environment. It requests the environment to switch to the `HIBERNATED` state, keeping its data and minimizing cost, but not running any DAGs. This method is supported for Cloud Composer environments in development mode in versions composer-3-airflow-*.*.*-build.* and newer.

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloudcomposer

  Path : v1/{+name}:hibernate

• ▼ ▲ composer.projects.locations.environments.resume

  Parameter Order : name

  HTTP Method : POST

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

  Path : v1/{+name}:resume

  Scopes :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloudcomposer

  Parameters :

  name

  Location : path

  Description : Required. The resource name of the environment to resume, in the form: "projects/{project}/locations/{location}/environments/{environment}"

  Required : Yes

  Type : string

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

  Description : Resumes (unpauses) a hibernated environment. It requests the environment to switch to the `RUNNING` state, so that it is ready to use and run DAGs. This method is supported for Cloud Composer environments in development mode in versions composer-3-airflow-*.*.*-build.* and newer.