tessl/pypi-google-cloud-orchestration-airflow
Google Cloud Composer (Orchestration Airflow) API client library for managing Apache Airflow environments
—
Pending
environment-management.mddocs/
Environment Management
Complete lifecycle management for Cloud Composer environments, including creation, configuration updates, monitoring, snapshots, database operations, and Airflow command execution.
Capabilities
Environment Lifecycle Operations
Create, retrieve, list, update, and delete Cloud Composer environments with full configuration control.
def create_environment(
self,
request: CreateEnvironmentRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> Operation:
"""
Create a new environment.
Parameters:
request (CreateEnvironmentRequest): Required. Request object containing parent location and environment configuration.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
Operation: Long-running operation representing the environment creation.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""
def get_environment(
self,
request: GetEnvironmentRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> Environment:
"""
Get environment details.
Parameters:
request (GetEnvironmentRequest): Required. Request object containing environment name.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
Environment: Environment details including configuration and state.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""
def list_environments(
self,
request: ListEnvironmentsRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> pagers.ListEnvironmentsPager:
"""
List environments in a location.
Parameters:
request (ListEnvironmentsRequest): Required. Request object containing parent location and pagination options.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
pagers.ListEnvironmentsPager: Paginated list of environments.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""
def update_environment(
self,
request: UpdateEnvironmentRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> Operation:
"""
Update environment configuration.
Parameters:
request (UpdateEnvironmentRequest): Required. Request object containing environment name, updated configuration, and field mask.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
Operation: Long-running operation representing the environment update.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""
def delete_environment(
self,
request: DeleteEnvironmentRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> Operation:
"""
Delete an environment.
Parameters:
request (DeleteEnvironmentRequest): Required. Request object containing environment name.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
Operation: Long-running operation representing the environment deletion.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""Airflow Command Execution
Execute, monitor, and control Airflow CLI commands within Cloud Composer environments.
def execute_airflow_command(
self,
request: ExecuteAirflowCommandRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> ExecuteAirflowCommandResponse:
"""
Execute an Airflow CLI command.
Parameters:
request (ExecuteAirflowCommandRequest): Required. Request object containing environment and command details.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
ExecuteAirflowCommandResponse: Response containing execution ID and initial status.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""
def poll_airflow_command(
self,
request: PollAirflowCommandRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> PollAirflowCommandResponse:
"""
Poll the status of an Airflow command execution.
Parameters:
request (PollAirflowCommandRequest): Required. Request object containing environment and execution ID.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
PollAirflowCommandResponse: Response containing command output and execution status.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""
def stop_airflow_command(
self,
request: StopAirflowCommandRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> StopAirflowCommandResponse:
"""
Stop a running Airflow command execution.
Parameters:
request (StopAirflowCommandRequest): Required. Request object containing environment and execution ID.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
StopAirflowCommandResponse: Response confirming command termination.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""Snapshot Operations
Save and restore environment snapshots for backup and migration purposes.
def save_snapshot(
self,
request: SaveSnapshotRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> Operation:
"""
Save environment snapshot.
Parameters:
request (SaveSnapshotRequest): Required. Request object containing environment and snapshot details.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
Operation: Long-running operation representing the snapshot save process.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""
def load_snapshot(
self,
request: LoadSnapshotRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> Operation:
"""
Load environment from snapshot.
Parameters:
request (LoadSnapshotRequest): Required. Request object containing environment and snapshot source details.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
Operation: Long-running operation representing the snapshot load process.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""Database Operations
Manage environment database operations including failover and property retrieval.
def database_failover(
self,
request: DatabaseFailoverRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> Operation:
"""
Perform database failover.
Parameters:
request (DatabaseFailoverRequest): Required. Request object containing environment name.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
Operation: Long-running operation representing the database failover process.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""
def fetch_database_properties(
self,
request: FetchDatabasePropertiesRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> FetchDatabasePropertiesResponse:
"""
Fetch database connection properties.
Parameters:
request (FetchDatabasePropertiesRequest): Required. Request object containing environment name.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
FetchDatabasePropertiesResponse: Response containing database connection details.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""Environment Upgrade and Workloads
Check upgrade availability and manage workloads within environments.
def check_upgrade(
self,
request: CheckUpgradeRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> Operation:
"""
Check if environment can be upgraded.
Parameters:
request (CheckUpgradeRequest): Required. Request object containing environment name and target image version.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
Operation: Long-running operation that will contain upgrade check results.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""
def list_workloads(
self,
request: ListWorkloadsRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> pagers.ListWorkloadsPager:
"""
List workloads in an environment.
Parameters:
request (ListWorkloadsRequest): Required. Request object containing environment parent and pagination options.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
pagers.ListWorkloadsPager: Paginated list of workloads.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""Request/Response Types
Environment Management Requests
class CreateEnvironmentRequest:
"""
Request to create a new environment.
Attributes:
parent (str): Required. Location where to create environment (projects/{project}/locations/{location})
environment (Environment): Required. Environment to create
"""
class UpdateEnvironmentRequest:
"""
Request to update environment configuration.
Attributes:
name (str): Environment resource name
environment (Environment): Required. Patched environment configuration
update_mask (google.protobuf.field_mask_pb2.FieldMask): Required. Fields to update
"""
class DeleteEnvironmentRequest:
"""
Request to delete an environment.
Attributes:
name (str): Required. Environment resource name to delete
"""Command Execution Types
class ExecuteAirflowCommandRequest:
"""
Request to execute an Airflow CLI command.
Attributes:
environment (str): Required. Environment resource name
command (str): Required. Airflow CLI command to execute
subcommand (str): Required. Airflow CLI subcommand
parameters (MutableSequence[str]): Parameters for the command
"""
class ExecuteAirflowCommandResponse:
"""
Response from executing an Airflow command.
Attributes:
execution_id (str): Unique identifier for the command execution
pod (str): Name of the pod where the command is executing
pod_namespace (str): Namespace of the pod
"""
class PollAirflowCommandRequest:
"""
Request to poll command execution status.
Attributes:
environment (str): Required. Environment resource name
execution_id (str): Required. Execution ID from ExecuteAirflowCommandResponse
pod (str): Required. Pod name from ExecuteAirflowCommandResponse
pod_namespace (str): Required. Pod namespace from ExecuteAirflowCommandResponse
"""
class PollAirflowCommandResponse:
"""
Response from polling command execution.
Attributes:
output (MutableSequence[Line]): Command output lines
output_end (bool): True if command has finished
exit_info (ExitInfo): Exit information if command completed
"""Snapshot Operation Types
class SaveSnapshotRequest:
"""
Request to save environment snapshot.
Attributes:
environment (str): Required. Environment resource name
snapshot_location (str): Location in Cloud Storage to save snapshot
"""
class LoadSnapshotRequest:
"""
Request to load environment from snapshot.
Attributes:
environment (str): Required. Environment resource name
snapshot_path (str): Required. Cloud Storage path to snapshot
skip_pypi_packages_installation (bool): Skip installing PyPI packages
skip_environment_variables_setting (bool): Skip setting environment variables
skip_airflow_overrides_setting (bool): Skip setting Airflow configuration overrides
skip_gcs_data_copying (bool): Skip copying Cloud Storage data
"""Install with Tessl CLI
npx tessl i tessl/pypi-google-cloud-orchestration-airflow