Composer

import { Composer } from "https://googleapis.deno.dev/v1/composer:v1.ts";

Manages Apache Airflow environments on Google Cloud Platform.

class Composer {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsLocationsEnvironmentsCreate(parent: string, req: Environment): Promise<Operation>;

async projectsLocationsEnvironmentsDatabaseFailover(environment: string, req: DatabaseFailoverRequest): Promise<Operation>;

async projectsLocationsEnvironmentsDelete(name: string): Promise<Operation>;

async projectsLocationsEnvironmentsExecuteAirflowCommand(environment: string, req: ExecuteAirflowCommandRequest): Promise<ExecuteAirflowCommandResponse>;

async projectsLocationsEnvironmentsFetchDatabaseProperties(environment: string): Promise<FetchDatabasePropertiesResponse>;

async projectsLocationsEnvironmentsGet(name: string): Promise<Environment>;

async projectsLocationsEnvironmentsList(parent: string, opts?: ProjectsLocationsEnvironmentsListOptions): Promise<ListEnvironmentsResponse>;

async projectsLocationsEnvironmentsLoadSnapshot(environment: string, req: LoadSnapshotRequest): Promise<Operation>;

async projectsLocationsEnvironmentsPatch(

name: string,

req: Environment,

opts?: ProjectsLocationsEnvironmentsPatchOptions,

): Promise<Operation>;

async projectsLocationsEnvironmentsPollAirflowCommand(environment: string, req: PollAirflowCommandRequest): Promise<PollAirflowCommandResponse>;

async projectsLocationsEnvironmentsSaveSnapshot(environment: string, req: SaveSnapshotRequest): Promise<Operation>;

async projectsLocationsEnvironmentsStopAirflowCommand(environment: string, req: StopAirflowCommandRequest): Promise<StopAirflowCommandResponse>;

async projectsLocationsEnvironmentsUserWorkloadsConfigMapsCreate(parent: string, req: UserWorkloadsConfigMap): Promise<UserWorkloadsConfigMap>;

async projectsLocationsEnvironmentsUserWorkloadsConfigMapsDelete(name: string): Promise<Empty>;

async projectsLocationsEnvironmentsUserWorkloadsConfigMapsGet(name: string): Promise<UserWorkloadsConfigMap>;

async projectsLocationsEnvironmentsUserWorkloadsConfigMapsList(parent: string, opts?: ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListOptions): Promise<ListUserWorkloadsConfigMapsResponse>;

async projectsLocationsEnvironmentsUserWorkloadsConfigMapsUpdate(name: string, req: UserWorkloadsConfigMap): Promise<UserWorkloadsConfigMap>;

async projectsLocationsEnvironmentsUserWorkloadsSecretsCreate(parent: string, req: UserWorkloadsSecret): Promise<UserWorkloadsSecret>;

async projectsLocationsEnvironmentsUserWorkloadsSecretsDelete(name: string): Promise<Empty>;

async projectsLocationsEnvironmentsUserWorkloadsSecretsGet(name: string): Promise<UserWorkloadsSecret>;

async projectsLocationsEnvironmentsUserWorkloadsSecretsList(parent: string, opts?: ProjectsLocationsEnvironmentsUserWorkloadsSecretsListOptions): Promise<ListUserWorkloadsSecretsResponse>;

async projectsLocationsEnvironmentsUserWorkloadsSecretsUpdate(name: string, req: UserWorkloadsSecret): Promise<UserWorkloadsSecret>;

async projectsLocationsEnvironmentsWorkloadsList(parent: string, opts?: ProjectsLocationsEnvironmentsWorkloadsListOptions): Promise<ListWorkloadsResponse>;

async projectsLocationsImageVersionsList(parent: string, opts?: ProjectsLocationsImageVersionsListOptions): Promise<ListImageVersionsResponse>;

async projectsLocationsOperationsDelete(name: string): Promise<Empty>;

async projectsLocationsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

}

§Constructors

new Composer(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsLocationsEnvironmentsCreate(parent: string, req: Environment): Promise<Operation>

[src]

Create a new environment.

@param parent

The parent must be of the form "projects/{projectId}/locations/{locationId}".

projectsLocationsEnvironmentsDatabaseFailover(environment: string, req: DatabaseFailoverRequest): Promise<Operation>

[src]

Triggers database failover (only for highly resilient environments).

@param environment

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

projectsLocationsEnvironmentsDelete(name: string): Promise<Operation>

[src]

Delete an environment.

@param name

The environment to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

projectsLocationsEnvironmentsExecuteAirflowCommand(environment: string, req: ExecuteAirflowCommandRequest): Promise<ExecuteAirflowCommandResponse>

[src]

Executes Airflow CLI command.

@param environment

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

projectsLocationsEnvironmentsFetchDatabaseProperties(environment: string): Promise<FetchDatabasePropertiesResponse>

[src]

Fetches database properties.

@param environment

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

projectsLocationsEnvironmentsGet(name: string): Promise<Environment>

[src]

Get an existing environment.

@param name

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

projectsLocationsEnvironmentsList(parent: string, opts?: ProjectsLocationsEnvironmentsListOptions): Promise<ListEnvironmentsResponse>

[src]

List environments.

@param parent

List environments in the given project and location, in the form: "projects/{projectId}/locations/{locationId}"

projectsLocationsEnvironmentsLoadSnapshot(environment: string, req: LoadSnapshotRequest): Promise<Operation>

[src]

Loads a snapshot of a Cloud Composer environment. As a result of this operation, a snapshot of environment's specified in LoadSnapshotRequest is loaded into the environment.

@param environment

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

projectsLocationsEnvironmentsPatch(name: string, req: Environment, opts?: ProjectsLocationsEnvironmentsPatchOptions): Promise<Operation>

[src]

Update an environment.

@param name

The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

projectsLocationsEnvironmentsPollAirflowCommand(environment: string, req: PollAirflowCommandRequest): Promise<PollAirflowCommandResponse>

[src]

Polls Airflow CLI command execution and fetches logs.

@param environment

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

projectsLocationsEnvironmentsSaveSnapshot(environment: string, req: SaveSnapshotRequest): Promise<Operation>

[src]

Creates a snapshots of a Cloud Composer environment. As a result of this operation, snapshot of environment's state is stored in a location specified in the SaveSnapshotRequest.

@param environment

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

projectsLocationsEnvironmentsStopAirflowCommand(environment: string, req: StopAirflowCommandRequest): Promise<StopAirflowCommandResponse>

[src]

Stops Airflow CLI command execution.

@param environment

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

projectsLocationsEnvironmentsUserWorkloadsConfigMapsCreate(parent: string, req: UserWorkloadsConfigMap): Promise<UserWorkloadsConfigMap>

[src]

Creates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

@param parent

Required. The environment name to create a ConfigMap for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

projectsLocationsEnvironmentsUserWorkloadsConfigMapsDelete(name: string): Promise<Empty>

[src]

Deletes a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

@param name

Required. The ConfigMap to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}"

projectsLocationsEnvironmentsUserWorkloadsConfigMapsGet(name: string): Promise<UserWorkloadsConfigMap>

[src]

Gets an existing user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

@param name

Required. The resource name of the ConfigMap to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}"

projectsLocationsEnvironmentsUserWorkloadsConfigMapsList(parent: string, opts?: ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsListOptions): Promise<ListUserWorkloadsConfigMapsResponse>

[src]

Lists user workloads ConfigMaps. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

@param parent

Required. List ConfigMaps in the given environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

projectsLocationsEnvironmentsUserWorkloadsConfigMapsUpdate(name: string, req: UserWorkloadsConfigMap): Promise<UserWorkloadsConfigMap>

[src]

Updates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

@param name

Identifier. The resource name of the ConfigMap, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}"

projectsLocationsEnvironmentsUserWorkloadsSecretsCreate(parent: string, req: UserWorkloadsSecret): Promise<UserWorkloadsSecret>

[src]

Creates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

@param parent

Required. The environment name to create a Secret for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

projectsLocationsEnvironmentsUserWorkloadsSecretsDelete(name: string): Promise<Empty>

[src]

Deletes a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

@param name

Required. The Secret to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}"

projectsLocationsEnvironmentsUserWorkloadsSecretsGet(name: string): Promise<UserWorkloadsSecret>

[src]

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.

@param name

Required. The resource name of the Secret to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}"

projectsLocationsEnvironmentsUserWorkloadsSecretsList(parent: string, opts?: ProjectsLocationsEnvironmentsUserWorkloadsSecretsListOptions): Promise<ListUserWorkloadsSecretsResponse>

[src]

Lists user workloads Secrets. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

@param parent

Required. List Secrets in the given environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

projectsLocationsEnvironmentsUserWorkloadsSecretsUpdate(name: string, req: UserWorkloadsSecret): Promise<UserWorkloadsSecret>

[src]

Updates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

@param name

Identifier. The resource name of the Secret, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}"

projectsLocationsEnvironmentsWorkloadsList(parent: string, opts?: ProjectsLocationsEnvironmentsWorkloadsListOptions): Promise<ListWorkloadsResponse>

[src]

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.

@param parent

Required. The environment name to get workloads for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}"

projectsLocationsImageVersionsList(parent: string, opts?: ProjectsLocationsImageVersionsListOptions): Promise<ListImageVersionsResponse>

[src]

List ImageVersions for provided location.

@param parent

List ImageVersions in the given project and location, in the form: "projects/{projectId}/locations/{locationId}"

projectsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

projectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.