Package Classes (1.15.0)

Summary of entries of Classes for composer.

Classes

ListEnvironmentsAsyncPager

A pager for iterating through list_environments requests.

This class thinly wraps an initial ListEnvironmentsResponse object, and provides an __aiter__ method to iterate through its environments field.

If there are more pages, the __aiter__ method will make additional ListEnvironments requests and continue to iterate through the environments field on the corresponding responses.

All the usual ListEnvironmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEnvironmentsPager

A pager for iterating through list_environments requests.

This class thinly wraps an initial ListEnvironmentsResponse object, and provides an __iter__ method to iterate through its environments field.

If there are more pages, the __iter__ method will make additional ListEnvironments requests and continue to iterate through the environments field on the corresponding responses.

All the usual ListEnvironmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListUserWorkloadsConfigMapsAsyncPager

A pager for iterating through list_user_workloads_config_maps requests.

This class thinly wraps an initial ListUserWorkloadsConfigMapsResponse object, and provides an __aiter__ method to iterate through its user_workloads_config_maps field.

If there are more pages, the __aiter__ method will make additional ListUserWorkloadsConfigMaps requests and continue to iterate through the user_workloads_config_maps field on the corresponding responses.

All the usual ListUserWorkloadsConfigMapsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListUserWorkloadsConfigMapsPager

A pager for iterating through list_user_workloads_config_maps requests.

This class thinly wraps an initial ListUserWorkloadsConfigMapsResponse object, and provides an __iter__ method to iterate through its user_workloads_config_maps field.

If there are more pages, the __iter__ method will make additional ListUserWorkloadsConfigMaps requests and continue to iterate through the user_workloads_config_maps field on the corresponding responses.

All the usual ListUserWorkloadsConfigMapsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListUserWorkloadsSecretsAsyncPager

A pager for iterating through list_user_workloads_secrets requests.

This class thinly wraps an initial ListUserWorkloadsSecretsResponse object, and provides an __aiter__ method to iterate through its user_workloads_secrets field.

If there are more pages, the __aiter__ method will make additional ListUserWorkloadsSecrets requests and continue to iterate through the user_workloads_secrets field on the corresponding responses.

All the usual ListUserWorkloadsSecretsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListUserWorkloadsSecretsPager

A pager for iterating through list_user_workloads_secrets requests.

This class thinly wraps an initial ListUserWorkloadsSecretsResponse object, and provides an __iter__ method to iterate through its user_workloads_secrets field.

If there are more pages, the __iter__ method will make additional ListUserWorkloadsSecrets requests and continue to iterate through the user_workloads_secrets field on the corresponding responses.

All the usual ListUserWorkloadsSecretsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListWorkloadsAsyncPager

A pager for iterating through list_workloads requests.

This class thinly wraps an initial ListWorkloadsResponse object, and provides an __aiter__ method to iterate through its workloads field.

If there are more pages, the __aiter__ method will make additional ListWorkloads requests and continue to iterate through the workloads field on the corresponding responses.

All the usual ListWorkloadsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListWorkloadsPager

A pager for iterating through list_workloads requests.

This class thinly wraps an initial ListWorkloadsResponse object, and provides an __iter__ method to iterate through its workloads field.

If there are more pages, the __iter__ method will make additional ListWorkloads requests and continue to iterate through the workloads field on the corresponding responses.

All the usual ListWorkloadsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ImageVersionsAsyncClient

Readonly service to query available ImageVersions.

ImageVersionsClient

Readonly service to query available ImageVersions.

ListImageVersionsAsyncPager

A pager for iterating through list_image_versions requests.

This class thinly wraps an initial ListImageVersionsResponse object, and provides an __aiter__ method to iterate through its image_versions field.

If there are more pages, the __aiter__ method will make additional ListImageVersions requests and continue to iterate through the image_versions field on the corresponding responses.

All the usual ListImageVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListImageVersionsPager

A pager for iterating through list_image_versions requests.

This class thinly wraps an initial ListImageVersionsResponse object, and provides an __iter__ method to iterate through its image_versions field.

If there are more pages, the __iter__ method will make additional ListImageVersions requests and continue to iterate through the image_versions field on the corresponding responses.

All the usual ListImageVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AirflowMetadataRetentionPolicyConfig

The policy for airflow metadata database retention.

RetentionMode

Describes retention policy.

CheckUpgradeRequest

Request to check whether image upgrade will succeed.

CheckUpgradeResponse

Message containing information about the result of an upgrade check operation.

ConflictResult

Whether there were python modules conflict during image build.

PypiDependenciesEntry

The abstract base class for a message.

CloudDataLineageIntegration

Configuration for Cloud Data Lineage integration.

CreateEnvironmentRequest

Create a new environment.

CreateUserWorkloadsConfigMapRequest

Create user workloads ConfigMap request.

CreateUserWorkloadsSecretRequest

Create user workloads Secret request.

DataRetentionConfig

The configuration setting for Airflow database data retention mechanism.

DatabaseConfig

The configuration of Cloud SQL instance that is used by the Apache Airflow software.

DatabaseFailoverRequest

Request to trigger database failover (only for highly resilient environments).

DatabaseFailoverResponse

Response for DatabaseFailoverRequest.

DeleteEnvironmentRequest

Delete an environment.

DeleteUserWorkloadsConfigMapRequest

Delete user workloads ConfigMap request.

DeleteUserWorkloadsSecretRequest

Delete user workloads Secret request.

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.

LabelsEntry

The abstract base class for a message.

State

State of the environment.

EnvironmentConfig

Configuration information for an environment.

EnvironmentSize

The size of the Cloud Composer environment.

ResilienceMode

Resilience mode of the Cloud Composer Environment.

ExecuteAirflowCommandRequest

Execute Airflow Command request.

ExecuteAirflowCommandResponse

Response to ExecuteAirflowCommandRequest.

FetchDatabasePropertiesRequest

Request to fetch properties of environment's database.

FetchDatabasePropertiesResponse

Response for FetchDatabasePropertiesRequest.

GetEnvironmentRequest

Get an environment.

GetUserWorkloadsConfigMapRequest

Get user workloads ConfigMap request.

GetUserWorkloadsSecretRequest

Get user workloads Secret request.

IPAllocationPolicy

Configuration for controlling how IPs are allocated in the GKE cluster running the Apache Airflow software.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ImageVersion

ImageVersion information

ListEnvironmentsRequest

List environments in a project and location.

ListEnvironmentsResponse

The environments in a project and location.

ListImageVersionsRequest

List ImageVersions in a project and location.

ListImageVersionsResponse

The ImageVersions in a project and location.

ListUserWorkloadsConfigMapsRequest

List user workloads ConfigMaps request.

ListUserWorkloadsConfigMapsResponse

The user workloads ConfigMaps for a given environment.

ListUserWorkloadsSecretsRequest

List user workloads Secrets request.

ListUserWorkloadsSecretsResponse

The user workloads Secrets for a given environment.

ListWorkloadsRequest

Request for listing workloads in a Cloud Composer environment.

ListWorkloadsResponse

Response to ListWorkloadsRequest.

ComposerWorkload

Information about a single workload.

ComposerWorkloadState

Workload states.

ComposerWorkloadStatus

Workload status.

ComposerWorkloadType

Supported workload types.

LoadSnapshotRequest

Request to load a snapshot into a Cloud Composer environment.

LoadSnapshotResponse

Response to LoadSnapshotRequest.

MaintenanceWindow

The configuration settings for Cloud Composer maintenance window. The following example:

  {
    "startTime":"2019-08-01T01:00:00Z"
    "endTime":"2019-08-01T07:00:00Z"
    "recurrence":"FREQ=WEEKLY;BYDAY=TU,WE"
  }

would define a maintenance window between 01 and 07 hours UTC during each Tuesday and Wednesday.

MasterAuthorizedNetworksConfig

Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs.

CidrBlock

CIDR block with an optional name.

NetworkingConfig

Configuration options for networking connections in the Composer 2 environment.

ConnectionType

Represents connection type between Composer environment in Customer Project and the corresponding Tenant project, from a predefined list of available connection modes.

NodeConfig

The configuration information for the Kubernetes Engine nodes running the Apache Airflow software.

OperationMetadata

Metadata describing an operation.

State

An enum describing the overall state of an operation.

Type

Type of longrunning operation.

PollAirflowCommandRequest

Poll Airflow Command request.

PollAirflowCommandResponse

Response to PollAirflowCommandRequest.

ExitInfo

Information about how a command ended.

Line

Contains information about a single line from logs.

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.

RecoveryConfig

The Recovery settings of an environment.

SaveSnapshotRequest

Request to create a snapshot of a Cloud Composer environment.

SaveSnapshotResponse

Response to SaveSnapshotRequest.

ScheduledSnapshotsConfig

The configuration for scheduled snapshot creation mechanism.

SoftwareConfig

Specifies the selection and configuration of software inside the environment.

AirflowConfigOverridesEntry

The abstract base class for a message.

EnvVariablesEntry

The abstract base class for a message.

PypiPackagesEntry

The abstract base class for a message.

WebServerPluginsMode

Web server plugins mode of the Cloud Composer 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.

TaskLogsStorageMode

The definition of task_logs_storage_mode.

UpdateEnvironmentRequest

Update an environment.

UpdateUserWorkloadsConfigMapRequest

Update user workloads ConfigMap request.

UpdateUserWorkloadsSecretRequest

Update user workloads Secret request.

UserWorkloadsConfigMap

User workloads ConfigMap used by Airflow tasks that run with Kubernetes executor or KubernetesPodOperator.

DataEntry

The abstract base class for a message.

UserWorkloadsSecret

User workloads Secret used by Airflow tasks that run with Kubernetes executor or KubernetesPodOperator.

DataEntry

The abstract base class for a message.

WebServerConfig

The configuration settings for the Airflow web server App Engine instance. Supported for Cloud Composer environments in versions composer-1.\ .-airflow-..*

WebServerNetworkAccessControl

Network-level access control policy for the Airflow web server.

AllowedIpRange

Allowed IP range with user-provided description.

WorkloadsConfig

The Kubernetes workloads configuration for GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2.\ .-airflow-..* and newer.

DagProcessorResource

Configuration for resources used by Airflow DAG processors.

This field is supported for Cloud Composer environments in versions composer-3.\ .-airflow-..* and newer.

SchedulerResource

Configuration for resources used by Airflow schedulers.

TriggererResource

Configuration for resources used by Airflow triggerers.

WebServerResource

Configuration for resources used by Airflow web server.

WorkerResource

Configuration for resources used by Airflow workers.

EnvironmentsAsyncClient

Managed Apache Airflow Environments.

EnvironmentsClient

Managed Apache Airflow Environments.

ListEnvironmentsAsyncPager

A pager for iterating through list_environments requests.

This class thinly wraps an initial ListEnvironmentsResponse object, and provides an __aiter__ method to iterate through its environments field.

If there are more pages, the __aiter__ method will make additional ListEnvironments requests and continue to iterate through the environments field on the corresponding responses.

All the usual ListEnvironmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEnvironmentsPager

A pager for iterating through list_environments requests.

This class thinly wraps an initial ListEnvironmentsResponse object, and provides an __iter__ method to iterate through its environments field.

If there are more pages, the __iter__ method will make additional ListEnvironments requests and continue to iterate through the environments field on the corresponding responses.

All the usual ListEnvironmentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListUserWorkloadsConfigMapsAsyncPager

A pager for iterating through list_user_workloads_config_maps requests.

This class thinly wraps an initial ListUserWorkloadsConfigMapsResponse object, and provides an __aiter__ method to iterate through its user_workloads_config_maps field.

All the usual ListUserWorkloadsConfigMapsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListUserWorkloadsConfigMapsPager

A pager for iterating through list_user_workloads_config_maps requests.

This class thinly wraps an initial ListUserWorkloadsConfigMapsResponse object, and provides an __iter__ method to iterate through its user_workloads_config_maps field.

All the usual ListUserWorkloadsConfigMapsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListUserWorkloadsSecretsAsyncPager

A pager for iterating through list_user_workloads_secrets requests.

This class thinly wraps an initial ListUserWorkloadsSecretsResponse object, and provides an __aiter__ method to iterate through its user_workloads_secrets field.

All the usual ListUserWorkloadsSecretsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListUserWorkloadsSecretsPager

A pager for iterating through list_user_workloads_secrets requests.

This class thinly wraps an initial ListUserWorkloadsSecretsResponse object, and provides an __iter__ method to iterate through its user_workloads_secrets field.

All the usual ListUserWorkloadsSecretsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListWorkloadsAsyncPager

A pager for iterating through list_workloads requests.

This class thinly wraps an initial ListWorkloadsResponse object, and provides an __aiter__ method to iterate through its workloads field.

If there are more pages, the __aiter__ method will make additional ListWorkloads requests and continue to iterate through the workloads field on the corresponding responses.

All the usual ListWorkloadsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListWorkloadsPager

A pager for iterating through list_workloads requests.

This class thinly wraps an initial ListWorkloadsResponse object, and provides an __iter__ method to iterate through its workloads field.

If there are more pages, the __iter__ method will make additional ListWorkloads requests and continue to iterate through the workloads field on the corresponding responses.

All the usual ListWorkloadsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ImageVersionsAsyncClient

Readonly service to query available ImageVersions.

ImageVersionsClient

Readonly service to query available ImageVersions.

ListImageVersionsAsyncPager

A pager for iterating through list_image_versions requests.

This class thinly wraps an initial ListImageVersionsResponse object, and provides an __aiter__ method to iterate through its image_versions field.

If there are more pages, the __aiter__ method will make additional ListImageVersions requests and continue to iterate through the image_versions field on the corresponding responses.

All the usual ListImageVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListImageVersionsPager

A pager for iterating through list_image_versions requests.

This class thinly wraps an initial ListImageVersionsResponse object, and provides an __iter__ method to iterate through its image_versions field.

If there are more pages, the __iter__ method will make additional ListImageVersions requests and continue to iterate through the image_versions field on the corresponding responses.

All the usual ListImageVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AirflowMetadataRetentionPolicyConfig

The policy for airflow metadata database retention.

RetentionMode

Describes retention policy.

CheckUpgradeRequest

Request to check whether image upgrade will succeed.

CheckUpgradeResponse

Message containing information about the result of an upgrade check operation.

ConflictResult

Whether there were python modules conflict during image build.

PypiDependenciesEntry

The abstract base class for a message.

CloudDataLineageIntegration

Configuration for Cloud Data Lineage integration.

CreateEnvironmentRequest

Create a new environment.

CreateUserWorkloadsConfigMapRequest

Create user workloads ConfigMap request.

CreateUserWorkloadsSecretRequest

Create user workloads Secret request.

DataRetentionConfig

The configuration setting for Airflow database data retention mechanism.

DatabaseConfig

The configuration of Cloud SQL instance that is used by the Apache Airflow software.

DatabaseFailoverRequest

Request to trigger database failover (only for highly resilient environments).

DatabaseFailoverResponse

Response for DatabaseFailoverRequest.

DeleteEnvironmentRequest

Delete an environment.

DeleteUserWorkloadsConfigMapRequest

Delete user workloads ConfigMap request.

DeleteUserWorkloadsSecretRequest

Delete user workloads Secret request.

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.

LabelsEntry

The abstract base class for a message.

State

State of the environment.

EnvironmentConfig

Configuration information for an environment.

EnvironmentSize

The size of the Cloud Composer environment.

ResilienceMode

Resilience mode of the Cloud Composer Environment.

ExecuteAirflowCommandRequest

Execute Airflow Command request.

ExecuteAirflowCommandResponse

Response to ExecuteAirflowCommandRequest.

FetchDatabasePropertiesRequest

Request to fetch properties of environment's database.

FetchDatabasePropertiesResponse

Response for FetchDatabasePropertiesRequest.

GetEnvironmentRequest

Get an environment.

GetUserWorkloadsConfigMapRequest

Get user workloads ConfigMap request.

GetUserWorkloadsSecretRequest

Get user workloads Secret request.

IPAllocationPolicy

Configuration for controlling how IPs are allocated in the GKE cluster.

ImageVersion

Image Version information

ListEnvironmentsRequest

List environments in a project and location.

ListEnvironmentsResponse

The environments in a project and location.

ListImageVersionsRequest

List ImageVersions in a project and location.

ListImageVersionsResponse

The ImageVersions in a project and location.

ListUserWorkloadsConfigMapsRequest

List user workloads ConfigMaps request.

ListUserWorkloadsConfigMapsResponse

The user workloads ConfigMaps for a given environment.

ListUserWorkloadsSecretsRequest

List user workloads Secrets request.

ListUserWorkloadsSecretsResponse

The user workloads Secrets for a given environment.

ListWorkloadsRequest

Request for listing workloads in a Cloud Composer environment.

ListWorkloadsResponse

Response to ListWorkloadsRequest.

ComposerWorkload

Information about a single workload.

ComposerWorkloadState

Workload states.

ComposerWorkloadStatus

Workload status.

ComposerWorkloadType

Supported workload types.

LoadSnapshotRequest

Request to load a snapshot into a Cloud Composer environment.

LoadSnapshotResponse

Response to LoadSnapshotRequest.

MaintenanceWindow

The configuration settings for Cloud Composer maintenance window. The following example:

  {
    "startTime":"2019-08-01T01:00:00Z"
    "endTime":"2019-08-01T07:00:00Z"
    "recurrence":"FREQ=WEEKLY;BYDAY=TU,WE"
  }

would define a maintenance window between 01 and 07 hours UTC during each Tuesday and Wednesday.