Package-level declarations

Types

Link copied to clipboard
data class AllowedIpRangeResponse(val description: String, val value: String)

Allowed IP range with user-provided description.

Link copied to clipboard
data class CidrBlockResponse(val cidrBlock: String, val displayName: String)

CIDR block with an optional name.

Link copied to clipboard

Configuration for Cloud Data Lineage integration.

Link copied to clipboard
data class DatabaseConfigResponse(val machineType: String)

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

Link copied to clipboard
data class EncryptionConfigResponse(val kmsKeyName: String)

The encryption options for the Cloud Composer environment and its dependencies. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.

Link copied to clipboard
data class EnvironmentConfigResponse(val airflowByoidUri: String, val airflowUri: String, val dagGcsPrefix: String, val databaseConfig: DatabaseConfigResponse, val encryptionConfig: EncryptionConfigResponse, val environmentSize: String, val gkeCluster: String, val maintenanceWindow: MaintenanceWindowResponse, val masterAuthorizedNetworksConfig: MasterAuthorizedNetworksConfigResponse, val nodeConfig: NodeConfigResponse, val nodeCount: Int, val privateEnvironmentConfig: PrivateEnvironmentConfigResponse, val recoveryConfig: RecoveryConfigResponse, val softwareConfig: SoftwareConfigResponse, val webServerConfig: WebServerConfigResponse, val webServerNetworkAccessControl: WebServerNetworkAccessControlResponse, val workloadsConfig: WorkloadsConfigResponse)

Configuration information for an environment.

Link copied to clipboard
data class GetEnvironmentResult(val config: EnvironmentConfigResponse, val createTime: String, val labels: Map<String, String>, val name: String, val state: String, val updateTime: String, val uuid: String)
Link copied to clipboard
data class IPAllocationPolicyResponse(val clusterIpv4CidrBlock: String, val clusterSecondaryRangeName: String, val servicesIpv4CidrBlock: String, val servicesSecondaryRangeName: String, val useIpAliases: Boolean)

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

Link copied to clipboard
data class MaintenanceWindowResponse(val endTime: String, val recurrence: String, val startTime: String)

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. @property endTime Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for end_time must be in the future, relative to start_time. @property recurrence Maintenance window recurrence. Format is a subset of RFC-5545 RRULE. The only allowed values for FREQ field are FREQ=DAILY and FREQ=WEEKLY;BYDAY=... Example values: FREQ=WEEKLY;BYDAY=TU,WE, FREQ=DAILY. @property startTime Start time of the first recurrence of the maintenance window.

Link copied to clipboard
data class MasterAuthorizedNetworksConfigResponse(val cidrBlocks: List<CidrBlockResponse>, val enabled: Boolean)

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.

Link copied to clipboard
data class NetworkingConfigResponse(val connectionType: String)

Configuration options for networking connections in the Composer 2 environment.

Link copied to clipboard
data class NodeConfigResponse(val diskSizeGb: Int, val enableIpMasqAgent: Boolean, val ipAllocationPolicy: IPAllocationPolicyResponse, val location: String, val machineType: String, val maxPodsPerNode: Int, val network: String, val oauthScopes: List<String>, val serviceAccount: String, val subnetwork: String, val tags: List<String>)

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

Link copied to clipboard
data class PrivateClusterConfigResponse(val enablePrivateEndpoint: Boolean, val masterIpv4CidrBlock: String, val masterIpv4ReservedRange: String)

Configuration options for the private GKE cluster in a Cloud Composer environment.

Link copied to clipboard
data class PrivateEnvironmentConfigResponse(val cloudComposerConnectionSubnetwork: String, val cloudComposerNetworkIpv4CidrBlock: String, val cloudComposerNetworkIpv4ReservedRange: String, val cloudSqlIpv4CidrBlock: String, val enablePrivateEnvironment: Boolean, val enablePrivatelyUsedPublicIps: Boolean, val networkingConfig: NetworkingConfigResponse, val privateClusterConfig: PrivateClusterConfigResponse, val webServerIpv4CidrBlock: String, val webServerIpv4ReservedRange: String)

The configuration information for configuring a Private IP Cloud Composer environment.

Link copied to clipboard
data class RecoveryConfigResponse(val scheduledSnapshotsConfig: ScheduledSnapshotsConfigResponse)

The Recovery settings of an environment.

Link copied to clipboard
data class ScheduledSnapshotsConfigResponse(val enabled: Boolean, val snapshotCreationSchedule: String, val snapshotLocation: String, val timeZone: String)

The configuration for scheduled snapshot creation mechanism.

Link copied to clipboard
data class SchedulerResourceResponse(val count: Int, val cpu: Double, val memoryGb: Double, val storageGb: Double)

Configuration for resources used by Airflow schedulers.

Link copied to clipboard
data class SoftwareConfigResponse(val airflowConfigOverrides: Map<String, String>, val cloudDataLineageIntegration: CloudDataLineageIntegrationResponse, val envVariables: Map<String, String>, val imageVersion: String, val pypiPackages: Map<String, String>, val pythonVersion: String, val schedulerCount: Int)

Specifies the selection and configuration of software inside the environment.

Link copied to clipboard
data class TriggererResourceResponse(val count: Int, val cpu: Double, val memoryGb: Double)

Configuration for resources used by Airflow triggerers.

Link copied to clipboard
data class WebServerConfigResponse(val machineType: String)

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

Link copied to clipboard

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

Link copied to clipboard
data class WebServerResourceResponse(val cpu: Double, val memoryGb: Double, val storageGb: Double)

Configuration for resources used by Airflow web server.

Link copied to clipboard
data class WorkerResourceResponse(val cpu: Double, val maxCount: Int, val memoryGb: Double, val minCount: Int, val storageGb: Double)

Configuration for resources used by Airflow workers.

Link copied to clipboard

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.