Cloud Composer API (composer:v1)

Additions

Methods


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

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

  Description : Polls Airflow CLI command execution and fetches logs.

  Parameters :

  environment

  Location : path

  Required : Yes

  Description : The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

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

  Type : string

  Parameter Order : environment

  HTTP Method : POST

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

  Path : v1/{+environment}:pollAirflowCommand

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

  Description : Fetches database properties.

  Parameter Order : environment

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

  Parameters :

  environment

  Type : string

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

  Description : Required. The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

  Required : Yes

  Location : path

  Path : v1/{+environment}:fetchDatabaseProperties

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

  HTTP Method : GET

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

  Parameters :

  environment

  Description : The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

  Type : string

  Location : path

  Required : Yes

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

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

  Description : Executes Airflow CLI command.

  HTTP Method : POST

  Parameter Order : environment

  Path : v1/{+environment}:executeAirflowCommand

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

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

  Path : v1/{+environment}:stopAirflowCommand

  Parameters :

  environment

  Required : Yes

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

  Description : The resource name of the environment in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}".

  Type : string

  Location : path

  Parameter Order : environment

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

  Description : Stops Airflow CLI command execution.

  HTTP Method : POST

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

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

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

  Path : v1/{+environment}:databaseFailover

  Parameters :

  environment

  Description : Target environment: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

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

  Type : string

  Required : Yes

  Location : path

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

  Description : Triggers database failover (only for highly resilient environments).

  Parameter Order : environment

  HTTP Method : POST