composer/v1 library
Cloud Composer API - v1
Manages Apache Airflow environments on Google Cloud Platform.
For more information, see cloud.google.com/composer/
Create an instance of CloudComposerApi to access these resources:
Classes
- AirflowMetadataRetentionPolicyConfig
- The policy for airflow metadata database retention.
- AllowedIpRange
- Allowed IP range with user-provided description.
- CheckUpgradeRequest
- Request to check whether image upgrade will succeed.
- CidrBlock
- CIDR block with an optional name.
- CloudComposerApi
- Manages Apache Airflow environments on Google Cloud Platform.
- CloudDataLineageIntegration
- Configuration for Cloud Data Lineage integration.
- ComposerWorkload
- Information about a single workload.
- ComposerWorkloadStatus
- Workload status.
- DagProcessorResource
- Configuration for resources used by Airflow DAG processors.
- DatabaseConfig
- The configuration of Cloud SQL instance that is used by the Apache Airflow software.
- DataRetentionConfig
- The configuration setting for Airflow database data retention mechanism.
- EncryptionConfig
- The encryption options for the Cloud Composer environment and its dependencies.Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- Environment
- An environment for running orchestration tasks.
- EnvironmentConfig
- Configuration information for an environment.
- ExecuteAirflowCommandRequest
- Execute Airflow Command request.
- ExecuteAirflowCommandResponse
- Response to ExecuteAirflowCommandRequest.
- ExitInfo
- Information about how a command ended.
- FetchDatabasePropertiesResponse
- Response for FetchDatabasePropertiesRequest.
- ImageVersion
- ImageVersion information
- IPAllocationPolicy
- Configuration for controlling how IPs are allocated in the GKE cluster running the Apache Airflow software.
- Line
- Contains information about a single line from logs.
- ListEnvironmentsResponse
- The environments in a project and location.
- ListImageVersionsResponse
- The ImageVersions in a project and location.
- ListOperationsResponse
- The response message for Operations.ListOperations.
- ListUserWorkloadsConfigMapsResponse
- The user workloads ConfigMaps for a given environment.
- ListUserWorkloadsSecretsResponse
- The user workloads Secrets for a given environment.
- ListWorkloadsResponse
- Response to ListWorkloadsRequest.
- LoadSnapshotRequest
- Request to load a snapshot into a Cloud Composer environment.
- MaintenanceWindow
- The configuration settings for Cloud Composer maintenance window.
- MasterAuthorizedNetworksConfig
- Configuration options for the master authorized networks feature.
- NetworkingConfig
- Configuration options for networking connections in the Composer 2 environment.
- NodeConfig
- The configuration information for the Kubernetes Engine nodes running the Apache Airflow software.
- Operation
- This resource represents a long-running operation that is the result of a network API call.
- PollAirflowCommandRequest
- Poll Airflow Command request.
- PollAirflowCommandResponse
- Response to PollAirflowCommandRequest.
- PrivateClusterConfig
- Configuration options for the private GKE cluster in a Cloud Composer environment.
- PrivateEnvironmentConfig
- The configuration information for configuring a Private IP Cloud Composer environment.
- ProjectsLocationsEnvironmentsResource
- ProjectsLocationsEnvironmentsUserWorkloadsConfigMapsResource
- ProjectsLocationsEnvironmentsUserWorkloadsSecretsResource
- ProjectsLocationsEnvironmentsWorkloadsResource
- ProjectsLocationsImageVersionsResource
- ProjectsLocationsOperationsResource
- ProjectsLocationsResource
- ProjectsResource
- RecoveryConfig
- The Recovery settings of an environment.
- SaveSnapshotRequest
- Request to create a snapshot of a Cloud Composer environment.
- ScheduledSnapshotsConfig
- The configuration for scheduled snapshot creation mechanism.
- SchedulerResource
- Configuration for resources used by Airflow schedulers.
- SoftwareConfig
- Specifies the selection and configuration of software inside the environment.
- StopAirflowCommandRequest
- Stop Airflow Command request.
- StopAirflowCommandResponse
- Response to StopAirflowCommandRequest.
- StorageConfig
- The configuration for data storage in the environment.
- TaskLogsRetentionConfig
- The configuration setting for Task Logs.
- TriggererResource
- Configuration for resources used by Airflow triggerers.
- UserWorkloadsConfigMap
- User workloads ConfigMap used by Airflow tasks that run with Kubernetes executor or KubernetesPodOperator.
- UserWorkloadsSecret
- User workloads Secret used by Airflow tasks that run with Kubernetes executor or KubernetesPodOperator.
- WebServerConfig
- The configuration settings for the Airflow web server App Engine instance.
- WebServerNetworkAccessControl
- Network-level access control policy for the Airflow web server.
- WebServerResource
- Configuration for resources used by Airflow web server.
- WorkerResource
- Configuration for resources used by Airflow workers.
- WorkloadsConfig
- The Kubernetes workloads configuration for GKE cluster associated with the Cloud Composer environment.
Typedefs
- DatabaseFailoverRequest = $Empty
- Request to trigger database failover (only for highly resilient environments).
- Date = $Date
- Represents a whole or partial calendar date, such as a birthday.
- Empty = $Empty
- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
- Status = $Status00
-
The
Statustype defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
Exceptions / Errors
- ApiRequestError
- Represents a general error reported by the API endpoint.
- DetailedApiRequestError
- Represents a specific error reported by the API endpoint.