Package com.google.cloud.datafusion.v1

Stay organized with collections Save and categorize content based on your preferences.

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

DataFusionClient

Service Description: Service for creating and managing Data Fusion instances. Data Fusion enables ETL developers to build code-free, data integration pipelines via a point-and-click UI.

Sample for DataFusionClient:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   GetInstanceRequest request =
       GetInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   Instance response = dataFusionClient.getInstance(request);
 }
 

Classes

Accelerator

Identifies Data Fusion accelerators for an instance.

Protobuf type google.cloud.datafusion.v1.Accelerator

Accelerator.Builder

Identifies Data Fusion accelerators for an instance.

Protobuf type google.cloud.datafusion.v1.Accelerator

CreateInstanceRequest

Request message for creating a Data Fusion instance.

Protobuf type google.cloud.datafusion.v1.CreateInstanceRequest

CreateInstanceRequest.Builder

Request message for creating a Data Fusion instance.

Protobuf type google.cloud.datafusion.v1.CreateInstanceRequest

CryptoKeyConfig

The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature.

Protobuf type google.cloud.datafusion.v1.CryptoKeyConfig

CryptoKeyConfig.Builder

The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature.

Protobuf type google.cloud.datafusion.v1.CryptoKeyConfig

DataFusionClient

Service Description: Service for creating and managing Data Fusion instances. Data Fusion enables ETL developers to build code-free, data integration pipelines via a point-and-click UI.

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:


 try (DataFusionClient dataFusionClient = DataFusionClient.create()) {
   GetInstanceRequest request =
       GetInstanceRequest.newBuilder()
           .setName(InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]").toString())
           .build();
   Instance response = dataFusionClient.getInstance(request);
 }
 

Note: close() needs to be called on the DataFusionClient 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:

  1. 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.
  2. 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.
  3. 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 DataFusionSettings to create(). For example:

To customize credentials:


 DataFusionSettings dataFusionSettings =
     DataFusionSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataFusionClient dataFusionClient = DataFusionClient.create(dataFusionSettings);
 

To customize the endpoint:


 DataFusionSettings dataFusionSettings =
     DataFusionSettings.newBuilder().setEndpoint(myEndpoint).build();
 DataFusionClient dataFusionClient = DataFusionClient.create(dataFusionSettings);
 

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

DataFusionClient.ListAvailableVersionsFixedSizeCollection

DataFusionClient.ListAvailableVersionsPage

DataFusionClient.ListAvailableVersionsPagedResponse

DataFusionClient.ListInstancesFixedSizeCollection

DataFusionClient.ListInstancesPage

DataFusionClient.ListInstancesPagedResponse

DataFusionGrpc

Service for creating and managing Data Fusion instances. Data Fusion enables ETL developers to build code-free, data integration pipelines via a point-and-click UI.

DataFusionGrpc.DataFusionBlockingStub

Service for creating and managing Data Fusion instances. Data Fusion enables ETL developers to build code-free, data integration pipelines via a point-and-click UI.

DataFusionGrpc.DataFusionFutureStub

Service for creating and managing Data Fusion instances. Data Fusion enables ETL developers to build code-free, data integration pipelines via a point-and-click UI.

DataFusionGrpc.DataFusionImplBase

Service for creating and managing Data Fusion instances. Data Fusion enables ETL developers to build code-free, data integration pipelines via a point-and-click UI.

DataFusionGrpc.DataFusionStub

Service for creating and managing Data Fusion instances. Data Fusion enables ETL developers to build code-free, data integration pipelines via a point-and-click UI.

DataFusionSettings

Settings class to configure an instance of DataFusionClient.

The default instance has everything set to sensible defaults:

  • The default service address (datafusion.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 getInstance to 30 seconds:


 DataFusionSettings.Builder dataFusionSettingsBuilder = DataFusionSettings.newBuilder();
 dataFusionSettingsBuilder
     .getInstanceSettings()
     .setRetrySettings(
         dataFusionSettingsBuilder
             .getInstanceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DataFusionSettings dataFusionSettings = dataFusionSettingsBuilder.build();
 

DataFusionSettings.Builder

Builder for DataFusionSettings.

Datafusion

DeleteInstanceRequest

Request message for deleting a Data Fusion instance.

Protobuf type google.cloud.datafusion.v1.DeleteInstanceRequest

DeleteInstanceRequest.Builder

Request message for deleting a Data Fusion instance.

Protobuf type google.cloud.datafusion.v1.DeleteInstanceRequest

GetInstanceRequest

Request message for getting details about a Data Fusion instance.

Protobuf type google.cloud.datafusion.v1.GetInstanceRequest

GetInstanceRequest.Builder

Request message for getting details about a Data Fusion instance.

Protobuf type google.cloud.datafusion.v1.GetInstanceRequest

Instance

Represents a Data Fusion instance.

Protobuf type google.cloud.datafusion.v1.Instance

Instance.Builder

Represents a Data Fusion instance.

Protobuf type google.cloud.datafusion.v1.Instance

InstanceName

InstanceName.Builder

Builder for projects/{project}/locations/{location}/instances/{instance}.

ListAvailableVersionsRequest

Request message for the list available versions request.

Protobuf type google.cloud.datafusion.v1.ListAvailableVersionsRequest

ListAvailableVersionsRequest.Builder

Request message for the list available versions request.

Protobuf type google.cloud.datafusion.v1.ListAvailableVersionsRequest

ListAvailableVersionsResponse

Response message for the list available versions request.

Protobuf type google.cloud.datafusion.v1.ListAvailableVersionsResponse

ListAvailableVersionsResponse.Builder

Response message for the list available versions request.

Protobuf type google.cloud.datafusion.v1.ListAvailableVersionsResponse

ListInstancesRequest

Request message for listing Data Fusion instances.

Protobuf type google.cloud.datafusion.v1.ListInstancesRequest

ListInstancesRequest.Builder

Request message for listing Data Fusion instances.

Protobuf type google.cloud.datafusion.v1.ListInstancesRequest

ListInstancesResponse

Response message for the list instance request.

Protobuf type google.cloud.datafusion.v1.ListInstancesResponse

ListInstancesResponse.Builder

Response message for the list instance request.

Protobuf type google.cloud.datafusion.v1.ListInstancesResponse

LocationName

LocationName.Builder

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

NetworkConfig

Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources.

Protobuf type google.cloud.datafusion.v1.NetworkConfig

NetworkConfig.Builder

Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources.

Protobuf type google.cloud.datafusion.v1.NetworkConfig

OperationMetadata

Represents the metadata of a long-running operation.

Protobuf type google.cloud.datafusion.v1.OperationMetadata

OperationMetadata.Builder

Represents the metadata of a long-running operation.

Protobuf type google.cloud.datafusion.v1.OperationMetadata

RestartInstanceRequest

Request message for restarting a Data Fusion instance.

Protobuf type google.cloud.datafusion.v1.RestartInstanceRequest

RestartInstanceRequest.Builder

Request message for restarting a Data Fusion instance.

Protobuf type google.cloud.datafusion.v1.RestartInstanceRequest

UpdateInstanceRequest

Request message for updating a Data Fusion instance. Data Fusion allows updating the labels, options, and stack driver settings. This is also used for CDF version upgrade.

Protobuf type google.cloud.datafusion.v1.UpdateInstanceRequest

UpdateInstanceRequest.Builder

Request message for updating a Data Fusion instance. Data Fusion allows updating the labels, options, and stack driver settings. This is also used for CDF version upgrade.

Protobuf type google.cloud.datafusion.v1.UpdateInstanceRequest

Version

The Data Fusion version. This proto message stores information about certain Data Fusion version, which is used for Data Fusion version upgrade.

Protobuf type google.cloud.datafusion.v1.Version

Version.Builder

The Data Fusion version. This proto message stores information about certain Data Fusion version, which is used for Data Fusion version upgrade.

Protobuf type google.cloud.datafusion.v1.Version

Interfaces

AcceleratorOrBuilder

CreateInstanceRequestOrBuilder

CryptoKeyConfigOrBuilder

DeleteInstanceRequestOrBuilder

GetInstanceRequestOrBuilder

InstanceOrBuilder

ListAvailableVersionsRequestOrBuilder

ListAvailableVersionsResponseOrBuilder

ListInstancesRequestOrBuilder

ListInstancesResponseOrBuilder

NetworkConfigOrBuilder

OperationMetadataOrBuilder

RestartInstanceRequestOrBuilder

UpdateInstanceRequestOrBuilder

VersionOrBuilder

Enums

Accelerator.AcceleratorType

Each type represents an Accelerator (Add-On) supported by Cloud Data Fusion service.

Protobuf enum google.cloud.datafusion.v1.Accelerator.AcceleratorType

Accelerator.State

Different values possible for the state of an accelerator

Protobuf enum google.cloud.datafusion.v1.Accelerator.State

Instance.DisabledReason

The reason for disabling the instance if the state is DISABLED.

Protobuf enum google.cloud.datafusion.v1.Instance.DisabledReason

Instance.State

Represents the state of a Data Fusion instance

Protobuf enum google.cloud.datafusion.v1.Instance.State

Instance.Type

Represents the type of Data Fusion instance. Each type is configured with the default settings for processing and memory.

Protobuf enum google.cloud.datafusion.v1.Instance.Type

Version.Type

Each type represents the release availability of a CDF version

Protobuf enum google.cloud.datafusion.v1.Version.Type