Data Lineage v1 API - Class LineageClientImpl (1.3.0) 

public sealed class LineageClientImpl : LineageClient

Reference documentation and code samples for the Data Lineage v1 API class LineageClientImpl.

Lineage client wrapper implementation, for convenient use.

Inheritance

object > LineageClient > LineageClientImpl

Namespace

Google.Cloud.DataCatalog.Lineage.V1

Assembly

Google.Cloud.DataCatalog.Lineage.V1.dll

Remarks

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

Constructors

LineageClientImpl(LineageClient, LineageSettings, ILogger)

public LineageClientImpl(Lineage.LineageClient grpcClient, LineageSettings settings, ILogger logger)

Constructs a client wrapper for the Lineage service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient LineageLineageClient

The underlying gRPC client.
settings LineageSettings

The base LineageSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

DeleteProcessOperationsClient

public override OperationsClient DeleteProcessOperationsClient { get; }

The long-running operations client for DeleteProcess.

Property Value
Type Description
OperationsClient
Overrides

DeleteRunOperationsClient

public override OperationsClient DeleteRunOperationsClient { get; }

The long-running operations client for DeleteRun.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override Lineage.LineageClient GrpcClient { get; }

The underlying gRPC Lineage client

Property Value
Type Description
LineageLineageClient
Overrides

Methods

BatchSearchLinkProcesses(BatchSearchLinkProcessesRequest, CallSettings)

public override PagedEnumerable<BatchSearchLinkProcessesResponse, ProcessLinks> BatchSearchLinkProcesses(BatchSearchLinkProcessesRequest request, CallSettings callSettings = null)

Retrieve information about LineageProcesses associated with specific links. LineageProcesses are transformation pipelines that result in data flowing from source to target assets. Links between assets represent this operation.

If you have specific link names, you can use this method to verify which LineageProcesses contribute to creating those links. See the [SearchLinks][google.cloud.datacatalog.lineage.v1.Lineage.SearchLinks] method for more information on how to retrieve link name.

You can retrieve the LineageProcess information in every project where you have the datalineage.events.get permission. The project provided in the URL is used for Billing and Quota.

Parameters
Name Description
request BatchSearchLinkProcessesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableBatchSearchLinkProcessesResponseProcessLinks

A pageable sequence of ProcessLinks resources.
Overrides

BatchSearchLinkProcessesAsync(BatchSearchLinkProcessesRequest, CallSettings)

public override PagedAsyncEnumerable<BatchSearchLinkProcessesResponse, ProcessLinks> BatchSearchLinkProcessesAsync(BatchSearchLinkProcessesRequest request, CallSettings callSettings = null)

Retrieve information about LineageProcesses associated with specific links. LineageProcesses are transformation pipelines that result in data flowing from source to target assets. Links between assets represent this operation.

If you have specific link names, you can use this method to verify which LineageProcesses contribute to creating those links. See the [SearchLinks][google.cloud.datacatalog.lineage.v1.Lineage.SearchLinks] method for more information on how to retrieve link name.

You can retrieve the LineageProcess information in every project where you have the datalineage.events.get permission. The project provided in the URL is used for Billing and Quota.

Parameters
Name Description
request BatchSearchLinkProcessesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableBatchSearchLinkProcessesResponseProcessLinks

A pageable asynchronous sequence of ProcessLinks resources.
Overrides

CreateLineageEvent(CreateLineageEventRequest, CallSettings)

public override LineageEvent CreateLineageEvent(CreateLineageEventRequest request, CallSettings callSettings = null)

Creates a new lineage event.

Parameters
Name Description
request CreateLineageEventRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
LineageEvent

The RPC response.
Overrides

CreateLineageEventAsync(CreateLineageEventRequest, CallSettings)

public override Task<LineageEvent> CreateLineageEventAsync(CreateLineageEventRequest request, CallSettings callSettings = null)

Creates a new lineage event.

Parameters
Name Description
request CreateLineageEventRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskLineageEvent

A Task containing the RPC response.
Overrides

CreateProcess(CreateProcessRequest, CallSettings)

public override Process CreateProcess(CreateProcessRequest request, CallSettings callSettings = null)

Creates a new process.

Parameters
Name Description
request CreateProcessRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Process

The RPC response.
Overrides

CreateProcessAsync(CreateProcessRequest, CallSettings)

public override Task<Process> CreateProcessAsync(CreateProcessRequest request, CallSettings callSettings = null)

Creates a new process.

Parameters
Name Description
request CreateProcessRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskProcess

A Task containing the RPC response.
Overrides

CreateRun(CreateRunRequest, CallSettings)

public override Run CreateRun(CreateRunRequest request, CallSettings callSettings = null)

Creates a new run.

Parameters
Name Description
request CreateRunRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Run

The RPC response.
Overrides

CreateRunAsync(CreateRunRequest, CallSettings)

public override Task<Run> CreateRunAsync(CreateRunRequest request, CallSettings callSettings = null)

Creates a new run.

Parameters
Name Description
request CreateRunRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRun

A Task containing the RPC response.
Overrides

DeleteLineageEvent(DeleteLineageEventRequest, CallSettings)

public override void DeleteLineageEvent(DeleteLineageEventRequest request, CallSettings callSettings = null)

Deletes the lineage event with the specified name.

Parameters
Name Description
request DeleteLineageEventRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteLineageEventAsync(DeleteLineageEventRequest, CallSettings)

public override Task DeleteLineageEventAsync(DeleteLineageEventRequest request, CallSettings callSettings = null)

Deletes the lineage event with the specified name.

Parameters
Name Description
request DeleteLineageEventRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

DeleteProcess(DeleteProcessRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteProcess(DeleteProcessRequest request, CallSettings callSettings = null)

Deletes the process with the specified name.

Parameters
Name Description
request DeleteProcessRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteProcessAsync(DeleteProcessRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteProcessAsync(DeleteProcessRequest request, CallSettings callSettings = null)

Deletes the process with the specified name.

Parameters
Name Description
request DeleteProcessRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteRun(DeleteRunRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteRun(DeleteRunRequest request, CallSettings callSettings = null)

Deletes the run with the specified name.

Parameters
Name Description
request DeleteRunRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteRunAsync(DeleteRunRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteRunAsync(DeleteRunRequest request, CallSettings callSettings = null)

Deletes the run with the specified name.

Parameters
Name Description
request DeleteRunRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

GetLineageEvent(GetLineageEventRequest, CallSettings)

public override LineageEvent GetLineageEvent(GetLineageEventRequest request, CallSettings callSettings = null)

Gets details of a specified lineage event.

Parameters
Name Description
request GetLineageEventRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
LineageEvent

The RPC response.
Overrides

GetLineageEventAsync(GetLineageEventRequest, CallSettings)

public override Task<LineageEvent> GetLineageEventAsync(GetLineageEventRequest request, CallSettings callSettings = null)

Gets details of a specified lineage event.

Parameters
Name Description
request GetLineageEventRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskLineageEvent

A Task containing the RPC response.
Overrides

GetProcess(GetProcessRequest, CallSettings)

public override Process GetProcess(GetProcessRequest request, CallSettings callSettings = null)

Gets the details of the specified process.

Parameters
Name Description
request GetProcessRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Process

The RPC response.
Overrides

GetProcessAsync(GetProcessRequest, CallSettings)

public override Task<Process> GetProcessAsync(GetProcessRequest request, CallSettings callSettings = null)

Gets the details of the specified process.

Parameters
Name Description
request GetProcessRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskProcess

A Task containing the RPC response.
Overrides

GetRun(GetRunRequest, CallSettings)

public override Run GetRun(GetRunRequest request, CallSettings callSettings = null)

Gets the details of the specified run.

Parameters
Name Description
request GetRunRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Run

The RPC response.
Overrides

GetRunAsync(GetRunRequest, CallSettings)

public override Task<Run> GetRunAsync(GetRunRequest request, CallSettings callSettings = null)

Gets the details of the specified run.

Parameters
Name Description
request GetRunRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRun

A Task containing the RPC response.
Overrides

ListLineageEvents(ListLineageEventsRequest, CallSettings)

public override PagedEnumerable<ListLineageEventsResponse, LineageEvent> ListLineageEvents(ListLineageEventsRequest request, CallSettings callSettings = null)

Lists lineage events in the given project and location. The list order is not defined.

Parameters
Name Description
request ListLineageEventsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListLineageEventsResponseLineageEvent

A pageable sequence of LineageEvent resources.
Overrides

ListLineageEventsAsync(ListLineageEventsRequest, CallSettings)

public override PagedAsyncEnumerable<ListLineageEventsResponse, LineageEvent> ListLineageEventsAsync(ListLineageEventsRequest request, CallSettings callSettings = null)

Lists lineage events in the given project and location. The list order is not defined.

Parameters
Name Description
request ListLineageEventsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListLineageEventsResponseLineageEvent

A pageable asynchronous sequence of LineageEvent resources.
Overrides

ListProcesses(ListProcessesRequest, CallSettings)

public override PagedEnumerable<ListProcessesResponse, Process> ListProcesses(ListProcessesRequest request, CallSettings callSettings = null)

List processes in the given project and location. List order is descending by insertion time.

Parameters
Name Description
request ListProcessesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListProcessesResponseProcess

A pageable sequence of Process resources.
Overrides

ListProcessesAsync(ListProcessesRequest, CallSettings)

public override PagedAsyncEnumerable<ListProcessesResponse, Process> ListProcessesAsync(ListProcessesRequest request, CallSettings callSettings = null)

List processes in the given project and location. List order is descending by insertion time.

Parameters
Name Description
request ListProcessesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListProcessesResponseProcess

A pageable asynchronous sequence of Process resources.
Overrides

ListRuns(ListRunsRequest, CallSettings)

public override PagedEnumerable<ListRunsResponse, Run> ListRuns(ListRunsRequest request, CallSettings callSettings = null)

Lists runs in the given project and location. List order is descending by start_time.

Parameters
Name Description
request ListRunsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListRunsResponseRun

A pageable sequence of Run resources.
Overrides

ListRunsAsync(ListRunsRequest, CallSettings)

public override PagedAsyncEnumerable<ListRunsResponse, Run> ListRunsAsync(ListRunsRequest request, CallSettings callSettings = null)

Lists runs in the given project and location. List order is descending by start_time.

Parameters
Name Description
request ListRunsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListRunsResponseRun

A pageable asynchronous sequence of Run resources.
Overrides

ProcessOpenLineageRunEvent(ProcessOpenLineageRunEventRequest, CallSettings)

public override ProcessOpenLineageRunEventResponse ProcessOpenLineageRunEvent(ProcessOpenLineageRunEventRequest request, CallSettings callSettings = null)

Creates new lineage events together with their parents: process and run. Updates the process and run if they already exist. Mapped from Open Lineage specification: https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json.

Parameters
Name Description
request ProcessOpenLineageRunEventRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ProcessOpenLineageRunEventResponse

The RPC response.
Overrides

ProcessOpenLineageRunEventAsync(ProcessOpenLineageRunEventRequest, CallSettings)

public override Task<ProcessOpenLineageRunEventResponse> ProcessOpenLineageRunEventAsync(ProcessOpenLineageRunEventRequest request, CallSettings callSettings = null)

Creates new lineage events together with their parents: process and run. Updates the process and run if they already exist. Mapped from Open Lineage specification: https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json.

Parameters
Name Description
request ProcessOpenLineageRunEventRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskProcessOpenLineageRunEventResponse

A Task containing the RPC response.
Overrides

SearchLinks(SearchLinksRequest, CallSettings)

public override PagedEnumerable<SearchLinksResponse, Link> SearchLinks(SearchLinksRequest request, CallSettings callSettings = null)

Retrieve a list of links connected to a specific asset. Links represent the data flow between source (upstream) and target (downstream) assets in transformation pipelines. Links are stored in the same project as the Lineage Events that create them.

You can retrieve links in every project where you have the datalineage.events.get permission. The project provided in the URL is used for Billing and Quota.

Parameters
Name Description
request SearchLinksRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableSearchLinksResponseLink

A pageable sequence of Link resources.
Overrides

SearchLinksAsync(SearchLinksRequest, CallSettings)

public override PagedAsyncEnumerable<SearchLinksResponse, Link> SearchLinksAsync(SearchLinksRequest request, CallSettings callSettings = null)

Retrieve a list of links connected to a specific asset. Links represent the data flow between source (upstream) and target (downstream) assets in transformation pipelines. Links are stored in the same project as the Lineage Events that create them.

You can retrieve links in every project where you have the datalineage.events.get permission. The project provided in the URL is used for Billing and Quota.

Parameters
Name Description
request SearchLinksRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableSearchLinksResponseLink

A pageable asynchronous sequence of Link resources.
Overrides

UpdateProcess(UpdateProcessRequest, CallSettings)

public override Process UpdateProcess(UpdateProcessRequest request, CallSettings callSettings = null)

Updates a process.

Parameters
Name Description
request UpdateProcessRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Process

The RPC response.
Overrides

UpdateProcessAsync(UpdateProcessRequest, CallSettings)

public override Task<Process> UpdateProcessAsync(UpdateProcessRequest request, CallSettings callSettings = null)

Updates a process.

Parameters
Name Description
request UpdateProcessRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskProcess

A Task containing the RPC response.
Overrides

UpdateRun(UpdateRunRequest, CallSettings)

public override Run UpdateRun(UpdateRunRequest request, CallSettings callSettings = null)

Updates a run.

Parameters
Name Description
request UpdateRunRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Run

The RPC response.
Overrides

UpdateRunAsync(UpdateRunRequest, CallSettings)

public override Task<Run> UpdateRunAsync(UpdateRunRequest request, CallSettings callSettings = null)

Updates a run.

Parameters
Name Description
request UpdateRunRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRun

A Task containing the RPC response.
Overrides