com.databricks.sdk.service.catalog

Class ExternalLineageAPI

java.lang.Object

com.databricks.sdk.service.catalog.ExternalLineageAPI

@Generated
public class ExternalLineageAPI
extends Object

External Lineage APIs enable defining and managing lineage relationships between Databricks objects and external systems. These APIs allow users to capture data flows connecting Databricks tables, models, and file paths with external metadata objects.

With these APIs, users can create, update, delete, and list lineage relationships with support for column-level mappings and custom properties.

Constructor Summary

Constructors

Constructor and Description
ExternalLineageAPI(ApiClient apiClient) Regular-use constructor
ExternalLineageAPI(ExternalLineageService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
ExternalLineageRelationship	createExternalLineageRelationship(CreateExternalLineageRelationshipRequest request) Creates an external lineage relationship between a Databricks or external metadata object and another external metadata object.
ExternalLineageRelationship	createExternalLineageRelationship(CreateRequestExternalLineage externalLineageRelationship)
void	deleteExternalLineageRelationship(DeleteExternalLineageRelationshipRequest request) Deletes an external lineage relationship between a Databricks or external metadata object and another external metadata object.
void	deleteExternalLineageRelationship(DeleteRequestExternalLineage externalLineageRelationship)
ExternalLineageService	impl()
Iterable<ExternalLineageInfo>	listExternalLineageRelationships(ExternalLineageObject objectInfo, LineageDirection lineageDirection)
Iterable<ExternalLineageInfo>	listExternalLineageRelationships(ListExternalLineageRelationshipsRequest request) Lists external lineage relationships of a Databricks object or external metadata given a supplied direction.
ExternalLineageRelationship	updateExternalLineageRelationship(UpdateExternalLineageRelationshipRequest request) Updates an external lineage relationship between a Databricks or external metadata object and another external metadata object.
ExternalLineageRelationship	updateExternalLineageRelationship(UpdateRequestExternalLineage externalLineageRelationship, String updateMask)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExternalLineageAPI

public ExternalLineageAPI(ApiClient apiClient)

Regular-use constructor

ExternalLineageAPI

public ExternalLineageAPI(ExternalLineageService mock)

Constructor for mocks

Method Detail

createExternalLineageRelationship

public ExternalLineageRelationship createExternalLineageRelationship(CreateRequestExternalLineage externalLineageRelationship)

createExternalLineageRelationship

public ExternalLineageRelationship createExternalLineageRelationship(CreateExternalLineageRelationshipRequest request)

Creates an external lineage relationship between a Databricks or external metadata object and another external metadata object.

deleteExternalLineageRelationship

public void deleteExternalLineageRelationship(DeleteRequestExternalLineage externalLineageRelationship)

deleteExternalLineageRelationship

public void deleteExternalLineageRelationship(DeleteExternalLineageRelationshipRequest request)

Deletes an external lineage relationship between a Databricks or external metadata object and another external metadata object.

listExternalLineageRelationships

public Iterable<ExternalLineageInfo> listExternalLineageRelationships(ExternalLineageObject objectInfo,
                                                                      LineageDirection lineageDirection)

listExternalLineageRelationships

public Iterable<ExternalLineageInfo> listExternalLineageRelationships(ListExternalLineageRelationshipsRequest request)

Lists external lineage relationships of a Databricks object or external metadata given a supplied direction.

updateExternalLineageRelationship

public ExternalLineageRelationship updateExternalLineageRelationship(UpdateRequestExternalLineage externalLineageRelationship,
                                                                     String updateMask)

updateExternalLineageRelationship

public ExternalLineageRelationship updateExternalLineageRelationship(UpdateExternalLineageRelationshipRequest request)

Updates an external lineage relationship between a Databricks or external metadata object and another external metadata object.

impl

public ExternalLineageService impl()