Package com.google.cloud.orchestration.airflow.service.v1 (1.33.0)

GitHub Repository RPC Documentation REST Documentation

Client Classes

Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.

Client Description
com.google.cloud.orchestration.airflow.service.v1.EnvironmentsClient Service Description: Managed Apache Airflow Environments.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

com.google.cloud.orchestration.airflow.service.v1.ImageVersionsClient Service Description: Readonly service to query available ImageVersions.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

Settings Classes

Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.

Settings Description
com.google.cloud.orchestration.airflow.service.v1.EnvironmentsSettings Settings class to configure an instance of EnvironmentsClient.

The default instance has everything set to sensible defaults:

com.google.cloud.orchestration.airflow.service.v1.ImageVersionsSettings Settings class to configure an instance of ImageVersionsClient.

The default instance has everything set to sensible defaults:

Classes

Class Description
com.google.cloud.orchestration.airflow.service.v1.CheckUpgradeResponse Message containing information about the result of an upgrade check operation.
com.google.cloud.orchestration.airflow.service.v1.CheckUpgradeResponse.Builder Message containing information about the result of an upgrade check operation.
com.google.cloud.orchestration.airflow.service.v1.CreateEnvironmentRequest Create a new environment.
com.google.cloud.orchestration.airflow.service.v1.CreateEnvironmentRequest.Builder Create a new environment.
com.google.cloud.orchestration.airflow.service.v1.DatabaseConfig The configuration of Cloud SQL instance that is used by the Apache Airflow software.
com.google.cloud.orchestration.airflow.service.v1.DatabaseConfig.Builder The configuration of Cloud SQL instance that is used by the Apache Airflow software.
com.google.cloud.orchestration.airflow.service.v1.DatabaseFailoverRequest Request to trigger database failover (only for highly resilient environments).
com.google.cloud.orchestration.airflow.service.v1.DatabaseFailoverRequest.Builder Request to trigger database failover (only for highly resilient environments).
com.google.cloud.orchestration.airflow.service.v1.DatabaseFailoverResponse Response for DatabaseFailoverRequest.
com.google.cloud.orchestration.airflow.service.v1.DatabaseFailoverResponse.Builder Response for DatabaseFailoverRequest.
com.google.cloud.orchestration.airflow.service.v1.DeleteEnvironmentRequest Delete an environment.
com.google.cloud.orchestration.airflow.service.v1.DeleteEnvironmentRequest.Builder Delete an environment.
com.google.cloud.orchestration.airflow.service.v1.EncryptionConfig The encryption options for the Cloud Composer environment and its dependencies.Supported for Cloud Composer environments in versions composer-1..-airflow-...
com.google.cloud.orchestration.airflow.service.v1.EncryptionConfig.Builder The encryption options for the Cloud Composer environment and its dependencies.Supported for Cloud Composer environments in versions composer-1..-airflow-...
com.google.cloud.orchestration.airflow.service.v1.Environment An environment for running orchestration tasks.
com.google.cloud.orchestration.airflow.service.v1.Environment.Builder An environment for running orchestration tasks.
com.google.cloud.orchestration.airflow.service.v1.EnvironmentConfig Configuration information for an environment.
com.google.cloud.orchestration.airflow.service.v1.EnvironmentConfig.Builder Configuration information for an environment.
com.google.cloud.orchestration.airflow.service.v1.EnvironmentName
com.google.cloud.orchestration.airflow.service.v1.EnvironmentName.Builder Builder for projects/{project}/locations/{location}/environments/{environment}.
com.google.cloud.orchestration.airflow.service.v1.EnvironmentsClient.ListEnvironmentsFixedSizeCollection
com.google.cloud.orchestration.airflow.service.v1.EnvironmentsClient.ListEnvironmentsPage
com.google.cloud.orchestration.airflow.service.v1.EnvironmentsClient.ListEnvironmentsPagedResponse
com.google.cloud.orchestration.airflow.service.v1.EnvironmentsGrpc Managed Apache Airflow Environments.
com.google.cloud.orchestration.airflow.service.v1.EnvironmentsGrpc.EnvironmentsImplBase Base class for the server implementation of the service Environments. Managed Apache Airflow Environments.
com.google.cloud.orchestration.airflow.service.v1.EnvironmentsOuterClass
com.google.cloud.orchestration.airflow.service.v1.EnvironmentsSettings.Builder Builder for EnvironmentsSettings.
com.google.cloud.orchestration.airflow.service.v1.ExecuteAirflowCommandRequest Execute Airflow Command request.
com.google.cloud.orchestration.airflow.service.v1.ExecuteAirflowCommandRequest.Builder Execute Airflow Command request.
com.google.cloud.orchestration.airflow.service.v1.ExecuteAirflowCommandResponse Response to ExecuteAirflowCommandRequest.
com.google.cloud.orchestration.airflow.service.v1.ExecuteAirflowCommandResponse.Builder Response to ExecuteAirflowCommandRequest.
com.google.cloud.orchestration.airflow.service.v1.FetchDatabasePropertiesRequest Request to fetch properties of environment's database.
com.google.cloud.orchestration.airflow.service.v1.FetchDatabasePropertiesRequest.Builder Request to fetch properties of environment's database.
com.google.cloud.orchestration.airflow.service.v1.FetchDatabasePropertiesResponse Response for FetchDatabasePropertiesRequest.
com.google.cloud.orchestration.airflow.service.v1.FetchDatabasePropertiesResponse.Builder Response for FetchDatabasePropertiesRequest.
com.google.cloud.orchestration.airflow.service.v1.GetEnvironmentRequest Get an environment.
com.google.cloud.orchestration.airflow.service.v1.GetEnvironmentRequest.Builder Get an environment.
com.google.cloud.orchestration.airflow.service.v1.IPAllocationPolicy Configuration for controlling how IPs are allocated in the GKE cluster running the Apache Airflow software.
com.google.cloud.orchestration.airflow.service.v1.IPAllocationPolicy.Builder Configuration for controlling how IPs are allocated in the GKE cluster running the Apache Airflow software.
com.google.cloud.orchestration.airflow.service.v1.ImageVersion ImageVersion information
com.google.cloud.orchestration.airflow.service.v1.ImageVersion.Builder ImageVersion information
com.google.cloud.orchestration.airflow.service.v1.ImageVersionsClient.ListImageVersionsFixedSizeCollection
com.google.cloud.orchestration.airflow.service.v1.ImageVersionsClient.ListImageVersionsPage
com.google.cloud.orchestration.airflow.service.v1.ImageVersionsClient.ListImageVersionsPagedResponse
com.google.cloud.orchestration.airflow.service.v1.ImageVersionsGrpc Readonly service to query available ImageVersions.
com.google.cloud.orchestration.airflow.service.v1.ImageVersionsGrpc.ImageVersionsImplBase Base class for the server implementation of the service ImageVersions. Readonly service to query available ImageVersions.
com.google.cloud.orchestration.airflow.service.v1.ImageVersionsOuterClass
com.google.cloud.orchestration.airflow.service.v1.ImageVersionsSettings.Builder Builder for ImageVersionsSettings.
com.google.cloud.orchestration.airflow.service.v1.ListEnvironmentsRequest List environments in a project and location.
com.google.cloud.orchestration.airflow.service.v1.ListEnvironmentsRequest.Builder List environments in a project and location.
com.google.cloud.orchestration.airflow.service.v1.ListEnvironmentsResponse The environments in a project and location.
com.google.cloud.orchestration.airflow.service.v1.ListEnvironmentsResponse.Builder The environments in a project and location.
com.google.cloud.orchestration.airflow.service.v1.ListImageVersionsRequest List ImageVersions in a project and location.
com.google.cloud.orchestration.airflow.service.v1.ListImageVersionsRequest.Builder List ImageVersions in a project and location.
com.google.cloud.orchestration.airflow.service.v1.ListImageVersionsResponse The ImageVersions in a project and location.
com.google.cloud.orchestration.airflow.service.v1.ListImageVersionsResponse.Builder The ImageVersions in a project and location.
com.google.cloud.orchestration.airflow.service.v1.LoadSnapshotRequest Request to load a snapshot into a Cloud Composer environment.
com.google.cloud.orchestration.airflow.service.v1.LoadSnapshotRequest.Builder Request to load a snapshot into a Cloud Composer environment.
com.google.cloud.orchestration.airflow.service.v1.LoadSnapshotResponse Response to LoadSnapshotRequest.
com.google.cloud.orchestration.airflow.service.v1.LoadSnapshotResponse.Builder Response to LoadSnapshotRequest.
com.google.cloud.orchestration.airflow.service.v1.MaintenanceWindow The configuration settings for Cloud Composer maintenance window. The following example:
com.google.cloud.orchestration.airflow.service.v1.MaintenanceWindow.Builder The configuration settings for Cloud Composer maintenance window. The following example:
com.google.cloud.orchestration.airflow.service.v1.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,
com.google.cloud.orchestration.airflow.service.v1.MasterAuthorizedNetworksConfig.Builder 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,
com.google.cloud.orchestration.airflow.service.v1.MasterAuthorizedNetworksConfig.CidrBlock CIDR block with an optional name.
com.google.cloud.orchestration.airflow.service.v1.MasterAuthorizedNetworksConfig.CidrBlock.Builder CIDR block with an optional name.
com.google.cloud.orchestration.airflow.service.v1.NetworkingConfig Configuration options for networking connections in the Composer 2 environment.
com.google.cloud.orchestration.airflow.service.v1.NetworkingConfig.Builder Configuration options for networking connections in the Composer 2 environment.
com.google.cloud.orchestration.airflow.service.v1.NodeConfig The configuration information for the Kubernetes Engine nodes running the Apache Airflow software.
com.google.cloud.orchestration.airflow.service.v1.NodeConfig.Builder The configuration information for the Kubernetes Engine nodes running the Apache Airflow software.
com.google.cloud.orchestration.airflow.service.v1.OperationMetadata Metadata describing an operation.
com.google.cloud.orchestration.airflow.service.v1.OperationMetadata.Builder Metadata describing an operation.
com.google.cloud.orchestration.airflow.service.v1.OperationsProto
com.google.cloud.orchestration.airflow.service.v1.PollAirflowCommandRequest Poll Airflow Command request.
com.google.cloud.orchestration.airflow.service.v1.PollAirflowCommandRequest.Builder Poll Airflow Command request.
com.google.cloud.orchestration.airflow.service.v1.PollAirflowCommandResponse Response to PollAirflowCommandRequest.
com.google.cloud.orchestration.airflow.service.v1.PollAirflowCommandResponse.Builder Response to PollAirflowCommandRequest.
com.google.cloud.orchestration.airflow.service.v1.PollAirflowCommandResponse.ExitInfo Information about how a command ended.
com.google.cloud.orchestration.airflow.service.v1.PollAirflowCommandResponse.ExitInfo.Builder Information about how a command ended.
com.google.cloud.orchestration.airflow.service.v1.PollAirflowCommandResponse.Line Contains information about a single line from logs.
com.google.cloud.orchestration.airflow.service.v1.PollAirflowCommandResponse.Line.Builder Contains information about a single line from logs.
com.google.cloud.orchestration.airflow.service.v1.PrivateClusterConfig Configuration options for the private GKE cluster in a Cloud Composer environment.
com.google.cloud.orchestration.airflow.service.v1.PrivateClusterConfig.Builder Configuration options for the private GKE cluster in a Cloud Composer environment.
com.google.cloud.orchestration.airflow.service.v1.PrivateEnvironmentConfig The configuration information for configuring a Private IP Cloud Composer environment.
com.google.cloud.orchestration.airflow.service.v1.PrivateEnvironmentConfig.Builder The configuration information for configuring a Private IP Cloud Composer environment.
com.google.cloud.orchestration.airflow.service.v1.RecoveryConfig The Recovery settings of an environment.
com.google.cloud.orchestration.airflow.service.v1.RecoveryConfig.Builder The Recovery settings of an environment.
com.google.cloud.orchestration.airflow.service.v1.SaveSnapshotRequest Request to create a snapshot of a Cloud Composer environment.
com.google.cloud.orchestration.airflow.service.v1.SaveSnapshotRequest.Builder Request to create a snapshot of a Cloud Composer environment.
com.google.cloud.orchestration.airflow.service.v1.SaveSnapshotResponse Response to SaveSnapshotRequest.
com.google.cloud.orchestration.airflow.service.v1.SaveSnapshotResponse.Builder Response to SaveSnapshotRequest.
com.google.cloud.orchestration.airflow.service.v1.ScheduledSnapshotsConfig The configuration for scheduled snapshot creation mechanism.
com.google.cloud.orchestration.airflow.service.v1.ScheduledSnapshotsConfig.Builder The configuration for scheduled snapshot creation mechanism.
com.google.cloud.orchestration.airflow.service.v1.SoftwareConfig Specifies the selection and configuration of software inside the environment.
com.google.cloud.orchestration.airflow.service.v1.SoftwareConfig.Builder Specifies the selection and configuration of software inside the environment.
com.google.cloud.orchestration.airflow.service.v1.StopAirflowCommandRequest Stop Airflow Command request.
com.google.cloud.orchestration.airflow.service.v1.StopAirflowCommandRequest.Builder Stop Airflow Command request.
com.google.cloud.orchestration.airflow.service.v1.StopAirflowCommandResponse Response to StopAirflowCommandRequest.
com.google.cloud.orchestration.airflow.service.v1.StopAirflowCommandResponse.Builder Response to StopAirflowCommandRequest.
com.google.cloud.orchestration.airflow.service.v1.UpdateEnvironmentRequest Update an environment.
com.google.cloud.orchestration.airflow.service.v1.UpdateEnvironmentRequest.Builder Update an environment.
com.google.cloud.orchestration.airflow.service.v1.WebServerConfig The configuration settings for the Airflow web server App Engine instance. Supported for Cloud Composer environments in versions composer-1..-airflow-..
com.google.cloud.orchestration.airflow.service.v1.WebServerConfig.Builder The configuration settings for the Airflow web server App Engine instance. Supported for Cloud Composer environments in versions composer-1..-airflow-..
com.google.cloud.orchestration.airflow.service.v1.WebServerNetworkAccessControl Network-level access control policy for the Airflow web server.
com.google.cloud.orchestration.airflow.service.v1.WebServerNetworkAccessControl.AllowedIpRange Allowed IP range with user-provided description.
com.google.cloud.orchestration.airflow.service.v1.WebServerNetworkAccessControl.AllowedIpRange.Builder Allowed IP range with user-provided description.
com.google.cloud.orchestration.airflow.service.v1.WebServerNetworkAccessControl.Builder Network-level access control policy for the Airflow web server.
com.google.cloud.orchestration.airflow.service.v1.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.
com.google.cloud.orchestration.airflow.service.v1.WorkloadsConfig.Builder 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.
com.google.cloud.orchestration.airflow.service.v1.WorkloadsConfig.SchedulerResource Configuration for resources used by Airflow schedulers.
com.google.cloud.orchestration.airflow.service.v1.WorkloadsConfig.SchedulerResource.Builder Configuration for resources used by Airflow schedulers.
com.google.cloud.orchestration.airflow.service.v1.WorkloadsConfig.WebServerResource Configuration for resources used by Airflow web server.
com.google.cloud.orchestration.airflow.service.v1.WorkloadsConfig.WebServerResource.Builder Configuration for resources used by Airflow web server.
com.google.cloud.orchestration.airflow.service.v1.WorkloadsConfig.WorkerResource Configuration for resources used by Airflow workers.
com.google.cloud.orchestration.airflow.service.v1.WorkloadsConfig.WorkerResource.Builder Configuration for resources used by Airflow workers.

Interfaces

Interface Description
com.google.cloud.orchestration.airflow.service.v1.CheckUpgradeResponseOrBuilder
com.google.cloud.orchestration.airflow.service.v1.CreateEnvironmentRequestOrBuilder
com.google.cloud.orchestration.airflow.service.v1.DatabaseConfigOrBuilder
com.google.cloud.orchestration.airflow.service.v1.DatabaseFailoverRequestOrBuilder
com.google.cloud.orchestration.airflow.service.v1.DatabaseFailoverResponseOrBuilder
com.google.cloud.orchestration.airflow.service.v1.DeleteEnvironmentRequestOrBuilder
com.google.cloud.orchestration.airflow.service.v1.EncryptionConfigOrBuilder
com.google.cloud.orchestration.airflow.service.v1.EnvironmentConfigOrBuilder
com.google.cloud.orchestration.airflow.service.v1.EnvironmentOrBuilder
com.google.cloud.orchestration.airflow.service.v1.EnvironmentsGrpc.AsyncService Managed Apache Airflow Environments.
com.google.cloud.orchestration.airflow.service.v1.ExecuteAirflowCommandRequestOrBuilder
com.google.cloud.orchestration.airflow.service.v1.ExecuteAirflowCommandResponseOrBuilder
com.google.cloud.orchestration.airflow.service.v1.FetchDatabasePropertiesRequestOrBuilder
com.google.cloud.orchestration.airflow.service.v1.FetchDatabasePropertiesResponseOrBuilder
com.google.cloud.orchestration.airflow.service.v1.GetEnvironmentRequestOrBuilder
com.google.cloud.orchestration.airflow.service.v1.IPAllocationPolicyOrBuilder
com.google.cloud.orchestration.airflow.service.v1.ImageVersionOrBuilder
com.google.cloud.orchestration.airflow.service.v1.ImageVersionsGrpc.AsyncService Readonly service to query available ImageVersions.
com.google.cloud.orchestration.airflow.service.v1.ListEnvironmentsRequestOrBuilder
com.google.cloud.orchestration.airflow.service.v1.ListEnvironmentsResponseOrBuilder
com.google.cloud.orchestration.airflow.service.v1.ListImageVersionsRequestOrBuilder
com.google.cloud.orchestration.airflow.service.v1.ListImageVersionsResponseOrBuilder
com.google.cloud.orchestration.airflow.service.v1.LoadSnapshotRequestOrBuilder
com.google.cloud.orchestration.airflow.service.v1.LoadSnapshotResponseOrBuilder
com.google.cloud.orchestration.airflow.service.v1.MaintenanceWindowOrBuilder
com.google.cloud.orchestration.airflow.service.v1.MasterAuthorizedNetworksConfig.CidrBlockOrBuilder
com.google.cloud.orchestration.airflow.service.v1.MasterAuthorizedNetworksConfigOrBuilder
com.google.cloud.orchestration.airflow.service.v1.NetworkingConfigOrBuilder
com.google.cloud.orchestration.airflow.service.v1.NodeConfigOrBuilder
com.google.cloud.orchestration.airflow.service.v1.OperationMetadataOrBuilder
com.google.cloud.orchestration.airflow.service.v1.PollAirflowCommandRequestOrBuilder
com.google.cloud.orchestration.airflow.service.v1.PollAirflowCommandResponse.ExitInfoOrBuilder
com.google.cloud.orchestration.airflow.service.v1.PollAirflowCommandResponse.LineOrBuilder
com.google.cloud.orchestration.airflow.service.v1.PollAirflowCommandResponseOrBuilder
com.google.cloud.orchestration.airflow.service.v1.PrivateClusterConfigOrBuilder
com.google.cloud.orchestration.airflow.service.v1.PrivateEnvironmentConfigOrBuilder
com.google.cloud.orchestration.airflow.service.v1.RecoveryConfigOrBuilder
com.google.cloud.orchestration.airflow.service.v1.SaveSnapshotRequestOrBuilder
com.google.cloud.orchestration.airflow.service.v1.SaveSnapshotResponseOrBuilder
com.google.cloud.orchestration.airflow.service.v1.ScheduledSnapshotsConfigOrBuilder
com.google.cloud.orchestration.airflow.service.v1.SoftwareConfigOrBuilder
com.google.cloud.orchestration.airflow.service.v1.StopAirflowCommandRequestOrBuilder
com.google.cloud.orchestration.airflow.service.v1.StopAirflowCommandResponseOrBuilder
com.google.cloud.orchestration.airflow.service.v1.UpdateEnvironmentRequestOrBuilder
com.google.cloud.orchestration.airflow.service.v1.WebServerConfigOrBuilder
com.google.cloud.orchestration.airflow.service.v1.WebServerNetworkAccessControl.AllowedIpRangeOrBuilder
com.google.cloud.orchestration.airflow.service.v1.WebServerNetworkAccessControlOrBuilder
com.google.cloud.orchestration.airflow.service.v1.WorkloadsConfig.SchedulerResourceOrBuilder
com.google.cloud.orchestration.airflow.service.v1.WorkloadsConfig.WebServerResourceOrBuilder
com.google.cloud.orchestration.airflow.service.v1.WorkloadsConfig.WorkerResourceOrBuilder
com.google.cloud.orchestration.airflow.service.v1.WorkloadsConfigOrBuilder

Enums

Enum Description
com.google.cloud.orchestration.airflow.service.v1.CheckUpgradeResponse.ConflictResult Whether there were python modules conflict during image build.
com.google.cloud.orchestration.airflow.service.v1.Environment.State State of the environment.
com.google.cloud.orchestration.airflow.service.v1.EnvironmentConfig.EnvironmentSize The size of the Cloud Composer environment.
com.google.cloud.orchestration.airflow.service.v1.EnvironmentConfig.ResilienceMode Resilience mode of the Cloud Composer Environment.
com.google.cloud.orchestration.airflow.service.v1.IPAllocationPolicy.ClusterIpAllocationCase
com.google.cloud.orchestration.airflow.service.v1.IPAllocationPolicy.ServicesIpAllocationCase
com.google.cloud.orchestration.airflow.service.v1.NetworkingConfig.ConnectionType Represents connection type between Composer environment in Customer Project and the corresponding Tenant project, from a predefined list of available connection modes.
com.google.cloud.orchestration.airflow.service.v1.OperationMetadata.State An enum describing the overall state of an operation.
com.google.cloud.orchestration.airflow.service.v1.OperationMetadata.Type Type of longrunning operation.