Package com.google.cloud.datacatalog.lineage.v1 (0.15.0)

A client to Data Lineage API

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

LineageClient

Service Description: Lineage is used to track data flows between assets over time. You can create LineageEvents to record lineage between multiple sources and a single target, for example, when table data is based on data from multiple tables.

Sample for LineageClient:


 // 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 (LineageClient lineageClient = LineageClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Process process = Process.newBuilder().build();
   Process response = lineageClient.createProcess(parent, process);
 }

Classes

BatchSearchLinkProcessesRequest

Request message for BatchSearchLinkProcesses.

Protobuf type google.cloud.datacatalog.lineage.v1.BatchSearchLinkProcessesRequest

BatchSearchLinkProcessesRequest.Builder

Request message for BatchSearchLinkProcesses.

Protobuf type google.cloud.datacatalog.lineage.v1.BatchSearchLinkProcessesRequest

BatchSearchLinkProcessesResponse

Response message for BatchSearchLinkProcesses.

Protobuf type google.cloud.datacatalog.lineage.v1.BatchSearchLinkProcessesResponse

BatchSearchLinkProcessesResponse.Builder

Response message for BatchSearchLinkProcesses.

Protobuf type google.cloud.datacatalog.lineage.v1.BatchSearchLinkProcessesResponse

CreateLineageEventRequest

Request message for CreateLineageEvent.

Protobuf type google.cloud.datacatalog.lineage.v1.CreateLineageEventRequest

CreateLineageEventRequest.Builder

Request message for CreateLineageEvent.

Protobuf type google.cloud.datacatalog.lineage.v1.CreateLineageEventRequest

CreateProcessRequest

Request message for CreateProcess.

Protobuf type google.cloud.datacatalog.lineage.v1.CreateProcessRequest

CreateProcessRequest.Builder

Request message for CreateProcess.

Protobuf type google.cloud.datacatalog.lineage.v1.CreateProcessRequest

CreateRunRequest

Request message for CreateRun.

Protobuf type google.cloud.datacatalog.lineage.v1.CreateRunRequest

CreateRunRequest.Builder

Request message for CreateRun.

Protobuf type google.cloud.datacatalog.lineage.v1.CreateRunRequest

DeleteLineageEventRequest

Request message for DeleteLineageEvent.

Protobuf type google.cloud.datacatalog.lineage.v1.DeleteLineageEventRequest

DeleteLineageEventRequest.Builder

Request message for DeleteLineageEvent.

Protobuf type google.cloud.datacatalog.lineage.v1.DeleteLineageEventRequest

DeleteProcessRequest

Request message for DeleteProcess.

Protobuf type google.cloud.datacatalog.lineage.v1.DeleteProcessRequest

DeleteProcessRequest.Builder

Request message for DeleteProcess.

Protobuf type google.cloud.datacatalog.lineage.v1.DeleteProcessRequest

DeleteRunRequest

Request message for DeleteRun.

Protobuf type google.cloud.datacatalog.lineage.v1.DeleteRunRequest

DeleteRunRequest.Builder

Request message for DeleteRun.

Protobuf type google.cloud.datacatalog.lineage.v1.DeleteRunRequest

EntityReference

The soft reference to everything you can attach a lineage event to.

Protobuf type google.cloud.datacatalog.lineage.v1.EntityReference

EntityReference.Builder

The soft reference to everything you can attach a lineage event to.

Protobuf type google.cloud.datacatalog.lineage.v1.EntityReference

EventLink

A lineage between source and target entities.

Protobuf type google.cloud.datacatalog.lineage.v1.EventLink

EventLink.Builder

A lineage between source and target entities.

Protobuf type google.cloud.datacatalog.lineage.v1.EventLink

GetLineageEventRequest

Request message for GetLineageEvent.

Protobuf type google.cloud.datacatalog.lineage.v1.GetLineageEventRequest

GetLineageEventRequest.Builder

Request message for GetLineageEvent.

Protobuf type google.cloud.datacatalog.lineage.v1.GetLineageEventRequest

GetProcessRequest

Request message for GetProcess.

Protobuf type google.cloud.datacatalog.lineage.v1.GetProcessRequest

GetProcessRequest.Builder

Request message for GetProcess.

Protobuf type google.cloud.datacatalog.lineage.v1.GetProcessRequest

GetRunRequest

Request message for GetRun.

Protobuf type google.cloud.datacatalog.lineage.v1.GetRunRequest

GetRunRequest.Builder

Request message for GetRun.

Protobuf type google.cloud.datacatalog.lineage.v1.GetRunRequest

LineageClient

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 (LineageClient lineageClient = LineageClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Process process = Process.newBuilder().build();
   Process response = lineageClient.createProcess(parent, process);
 }

Note: close() needs to be called on the LineageClient 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 LineageSettings 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
 LineageSettings lineageSettings =
     LineageSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 LineageClient lineageClient = LineageClient.create(lineageSettings);

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
 LineageSettings lineageSettings = LineageSettings.newBuilder().setEndpoint(myEndpoint).build();
 LineageClient lineageClient = LineageClient.create(lineageSettings);

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
 LineageSettings lineageSettings = LineageSettings.newHttpJsonBuilder().build();
 LineageClient lineageClient = LineageClient.create(lineageSettings);

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

LineageClient.BatchSearchLinkProcessesFixedSizeCollection

LineageClient.BatchSearchLinkProcessesPage

LineageClient.BatchSearchLinkProcessesPagedResponse

LineageClient.ListLineageEventsFixedSizeCollection

LineageClient.ListLineageEventsPage

LineageClient.ListLineageEventsPagedResponse

LineageClient.ListProcessesFixedSizeCollection

LineageClient.ListProcessesPage

LineageClient.ListProcessesPagedResponse

LineageClient.ListRunsFixedSizeCollection

LineageClient.ListRunsPage

LineageClient.ListRunsPagedResponse

LineageClient.SearchLinksFixedSizeCollection

LineageClient.SearchLinksPage

LineageClient.SearchLinksPagedResponse

LineageEvent

A lineage event represents an operation on assets. Within the operation, the data flows from the source to the target defined in the links field.

Protobuf type google.cloud.datacatalog.lineage.v1.LineageEvent

LineageEvent.Builder

A lineage event represents an operation on assets. Within the operation, the data flows from the source to the target defined in the links field.

Protobuf type google.cloud.datacatalog.lineage.v1.LineageEvent

LineageEventName

LineageEventName.Builder

Builder for projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}.

LineageGrpc

Lineage is used to track data flows between assets over time. You can create LineageEvents to record lineage between multiple sources and a single target, for example, when table data is based on data from multiple tables.

LineageGrpc.LineageBlockingStub

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

LineageGrpc.LineageFutureStub

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

LineageGrpc.LineageImplBase

Base class for the server implementation of the service Lineage.

LineageGrpc.LineageStub

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

LineageProto

LineageSettings

Settings class to configure an instance of LineageClient.

The default instance has everything set to sensible defaults:

The default service address (datalineage.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 createProcess 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
 LineageSettings.Builder lineageSettingsBuilder = LineageSettings.newBuilder();
 lineageSettingsBuilder
     .createProcessSettings()
     .setRetrySettings(
         lineageSettingsBuilder
             .createProcessSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 LineageSettings lineageSettings = lineageSettingsBuilder.build();

LineageSettings.Builder

Builder for LineageSettings.

Link

Links represent the data flow between source (upstream) and target (downstream) assets in transformation pipelines.

Links are created when LineageEvents record data transformation between related assets.

Protobuf type google.cloud.datacatalog.lineage.v1.Link

Link.Builder

Links represent the data flow between source (upstream) and target (downstream) assets in transformation pipelines.

Links are created when LineageEvents record data transformation between related assets.

Protobuf type google.cloud.datacatalog.lineage.v1.Link

Package com.google.cloud.datacatalog.lineage.v1 (0.15.0)

LineageClient

Classes

Interfaces

Enums