Cloud Composer API (composer:v1beta1)

2023-05-22

5 new methods

Additions

    Methods
  • composer.projects.locations.environments.fetchDatabaseProperties

      Parameters:

        environment

          Type: string

          Required: Yes

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

          Location: path

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

      HTTP Method: GET

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

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

      Path: v1beta1/{+environment}:fetchDatabaseProperties

      Description: Fetches database properties.

      Parameter Order: environment

  • composer.projects.locations.environments.pollAirflowCommand

      Description: Polls Airflow CLI command execution and fetches logs.

      Parameters:

        environment

          Required: Yes

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

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

          Type: string

          Location: path

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

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

      HTTP Method: POST

      Path: v1beta1/{+environment}:pollAirflowCommand

      Parameter Order: environment

  • composer.projects.locations.environments.databaseFailover

      Path: v1beta1/{+environment}:databaseFailover

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

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

      Parameters:

        environment

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

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

          Location: path

          Type: string

          Required: Yes

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

      HTTP Method: POST

      Parameter Order: environment

  • composer.projects.locations.environments.executeAirflowCommand

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

      Parameter Order: environment

      Path: v1beta1/{+environment}:executeAirflowCommand

      Parameters:

        environment

          Location: path

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

          Required: Yes

          Type: string

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

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

      Description: Executes Airflow CLI command.

      HTTP Method: POST

  • composer.projects.locations.environments.stopAirflowCommand

      Parameter Order: environment

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

      Parameters:

        environment

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

          Location: path

          Type: string

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

          Required: Yes

      Description: Stops Airflow CLI command execution.

      Path: v1beta1/{+environment}:stopAirflowCommand

      HTTP Method: POST

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