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

A client to Cloud Composer API

The interfaces provided are listed below, along with usage samples.

EnvironmentsClient

Service Description: Managed Apache Airflow Environments.

Sample for EnvironmentsClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
   String name = "name3373707";
   Environment response = environmentsClient.getEnvironment(name);
 }

ImageVersionsClient

Service Description: Readonly service to query available ImageVersions.

Sample for ImageVersionsClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ImageVersionsClient imageVersionsClient = ImageVersionsClient.create()) {
   String parent = "parent-995424086";
   for (ImageVersion element : imageVersionsClient.listImageVersions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Classes

CheckUpgradeResponse

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

Protobuf type google.cloud.orchestration.airflow.service.v1.CheckUpgradeResponse

CheckUpgradeResponse.Builder

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

Protobuf type google.cloud.orchestration.airflow.service.v1.CheckUpgradeResponse

CreateEnvironmentRequest

Create a new environment.

Protobuf type google.cloud.orchestration.airflow.service.v1.CreateEnvironmentRequest

CreateEnvironmentRequest.Builder

Create a new environment.

Protobuf type google.cloud.orchestration.airflow.service.v1.CreateEnvironmentRequest

DatabaseConfig

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

Protobuf type google.cloud.orchestration.airflow.service.v1.DatabaseConfig

DatabaseConfig.Builder

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

Protobuf type google.cloud.orchestration.airflow.service.v1.DatabaseConfig

DatabaseFailoverRequest

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

Protobuf type google.cloud.orchestration.airflow.service.v1.DatabaseFailoverRequest

DatabaseFailoverRequest.Builder

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

Protobuf type google.cloud.orchestration.airflow.service.v1.DatabaseFailoverRequest

DatabaseFailoverResponse

Response for DatabaseFailoverRequest.

Protobuf type google.cloud.orchestration.airflow.service.v1.DatabaseFailoverResponse

DatabaseFailoverResponse.Builder

Response for DatabaseFailoverRequest.

Protobuf type google.cloud.orchestration.airflow.service.v1.DatabaseFailoverResponse

DeleteEnvironmentRequest

Delete an environment.

Protobuf type google.cloud.orchestration.airflow.service.v1.DeleteEnvironmentRequest

DeleteEnvironmentRequest.Builder

Delete an environment.

Protobuf type google.cloud.orchestration.airflow.service.v1.DeleteEnvironmentRequest

EncryptionConfig

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

Protobuf type google.cloud.orchestration.airflow.service.v1.EncryptionConfig

EncryptionConfig.Builder

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

Protobuf type google.cloud.orchestration.airflow.service.v1.EncryptionConfig

Environment

An environment for running orchestration tasks.

Protobuf type google.cloud.orchestration.airflow.service.v1.Environment

Environment.Builder

An environment for running orchestration tasks.

Protobuf type google.cloud.orchestration.airflow.service.v1.Environment

EnvironmentConfig

Configuration information for an environment.

Protobuf type google.cloud.orchestration.airflow.service.v1.EnvironmentConfig

EnvironmentConfig.Builder

Configuration information for an environment.

Protobuf type google.cloud.orchestration.airflow.service.v1.EnvironmentConfig

EnvironmentName.Builder

Builder for projects/{project}/locations/{location}/environments/{environment}.

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
   String name = "name3373707";
   Environment response = environmentsClient.getEnvironment(name);
 }

Note: close() needs to be called on the EnvironmentsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of EnvironmentsSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EnvironmentsSettings environmentsSettings =
     EnvironmentsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EnvironmentsClient environmentsClient = EnvironmentsClient.create(environmentsSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EnvironmentsSettings environmentsSettings =
     EnvironmentsSettings.newBuilder().setEndpoint(myEndpoint).build();
 EnvironmentsClient environmentsClient = EnvironmentsClient.create(environmentsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EnvironmentsSettings environmentsSettings = EnvironmentsSettings.newHttpJsonBuilder().build();
 EnvironmentsClient environmentsClient = EnvironmentsClient.create(environmentsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

EnvironmentsClient.ListEnvironmentsFixedSizeCollection

EnvironmentsClient.ListEnvironmentsPage

EnvironmentsClient.ListEnvironmentsPagedResponse

EnvironmentsGrpc

Managed Apache Airflow Environments.

EnvironmentsGrpc.EnvironmentsBlockingStub

A stub to allow clients to do synchronous rpc calls to service Environments.

Managed Apache Airflow Environments.

EnvironmentsGrpc.EnvironmentsFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Environments.

Managed Apache Airflow Environments.

EnvironmentsGrpc.EnvironmentsImplBase

Base class for the server implementation of the service Environments.

Managed Apache Airflow Environments.

EnvironmentsGrpc.EnvironmentsStub

A stub to allow clients to do asynchronous rpc calls to service Environments.

Managed Apache Airflow Environments.

EnvironmentsOuterClass

EnvironmentsSettings

Settings class to configure an instance of EnvironmentsClient.

The default instance has everything set to sensible defaults:

The default service address (composer.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getEnvironment to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EnvironmentsSettings.Builder environmentsSettingsBuilder = EnvironmentsSettings.newBuilder();
 environmentsSettingsBuilder
     .getEnvironmentSettings()
     .setRetrySettings(
         environmentsSettingsBuilder
             .getEnvironmentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 EnvironmentsSettings environmentsSettings = environmentsSettingsBuilder.build();

EnvironmentsSettings.Builder

Builder for EnvironmentsSettings.

ExecuteAirflowCommandRequest

Execute Airflow Command request.

Protobuf type google.cloud.orchestration.airflow.service.v1.ExecuteAirflowCommandRequest

ExecuteAirflowCommandRequest.Builder

Execute Airflow Command request.

Protobuf type google.cloud.orchestration.airflow.service.v1.ExecuteAirflowCommandRequest

ExecuteAirflowCommandResponse

Response to ExecuteAirflowCommandRequest.

Protobuf type google.cloud.orchestration.airflow.service.v1.ExecuteAirflowCommandResponse

ExecuteAirflowCommandResponse.Builder

Response to ExecuteAirflowCommandRequest.

Protobuf type google.cloud.orchestration.airflow.service.v1.ExecuteAirflowCommandResponse

FetchDatabasePropertiesRequest

Request to fetch properties of environment's database.

Protobuf type google.cloud.orchestration.airflow.service.v1.FetchDatabasePropertiesRequest

FetchDatabasePropertiesRequest.Builder

Request to fetch properties of environment's database.

Protobuf type google.cloud.orchestration.airflow.service.v1.FetchDatabasePropertiesRequest

FetchDatabasePropertiesResponse

Response for FetchDatabasePropertiesRequest.

Protobuf type google.cloud.orchestration.airflow.service.v1.FetchDatabasePropertiesResponse

FetchDatabasePropertiesResponse.Builder

Response for FetchDatabasePropertiesRequest.

Protobuf type google.cloud.orchestration.airflow.service.v1.FetchDatabasePropertiesResponse

GetEnvironmentRequest

Get an environment.

Protobuf type google.cloud.orchestration.airflow.service.v1.GetEnvironmentRequest

GetEnvironmentRequest.Builder

Get an environment.

Protobuf type google.cloud.orchestration.airflow.service.v1.GetEnvironmentRequest

IPAllocationPolicy

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

Protobuf type google.cloud.orchestration.airflow.service.v1.IPAllocationPolicy

IPAllocationPolicy.Builder

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

Protobuf type google.cloud.orchestration.airflow.service.v1.IPAllocationPolicy

ImageVersion

ImageVersion information

Protobuf type google.cloud.orchestration.airflow.service.v1.ImageVersion

ImageVersion.Builder

ImageVersion information

Protobuf type google.cloud.orchestration.airflow.service.v1.ImageVersion

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ImageVersionsClient imageVersionsClient = ImageVersionsClient.create()) {
   String parent = "parent-995424086";
   for (ImageVersion element : imageVersionsClient.listImageVersions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Note: close() needs to be called on the ImageVersionsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

This class can be customized by passing in a custom instance of ImageVersionsSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ImageVersionsSettings imageVersionsSettings =
     ImageVersionsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ImageVersionsClient imageVersionsClient = ImageVersionsClient.create(imageVersionsSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ImageVersionsSettings imageVersionsSettings =
     ImageVersionsSettings.newBuilder().setEndpoint(myEndpoint).build();
 ImageVersionsClient imageVersionsClient = ImageVersionsClient.create(imageVersionsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ImageVersionsSettings imageVersionsSettings =
     ImageVersionsSettings.newHttpJsonBuilder().build();
 ImageVersionsClient imageVersionsClient = ImageVersionsClient.create(imageVersionsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.