Data Lineage v1 API - Class Lineage.LineageBase (1.1.0)

[BindServiceMethod(typeof(Lineage), "BindService")]
public abstract class Lineage.LineageBase

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

Base class for server-side implementations of Lineage

Inheritance

object > Lineage.LineageBase

Namespace

Google.Cloud.DataCatalog.Lineage.V1

Assembly

Google.Cloud.DataCatalog.Lineage.V1.dll

Methods

BatchSearchLinkProcesses(BatchSearchLinkProcessesRequest, ServerCallContext)

public virtual Task<BatchSearchLinkProcessesResponse> BatchSearchLinkProcesses(BatchSearchLinkProcessesRequest request, ServerCallContext context)

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
NameDescription
requestBatchSearchLinkProcessesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskBatchSearchLinkProcessesResponse

The response to send back to the client (wrapped by a task).

CreateLineageEvent(CreateLineageEventRequest, ServerCallContext)

public virtual Task<LineageEvent> CreateLineageEvent(CreateLineageEventRequest request, ServerCallContext context)

Creates a new lineage event.

Parameters
NameDescription
requestCreateLineageEventRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskLineageEvent

The response to send back to the client (wrapped by a task).

CreateProcess(CreateProcessRequest, ServerCallContext)

public virtual Task<Process> CreateProcess(CreateProcessRequest request, ServerCallContext context)

Creates a new process.

Parameters
NameDescription
requestCreateProcessRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskProcess

The response to send back to the client (wrapped by a task).

CreateRun(CreateRunRequest, ServerCallContext)

public virtual Task<Run> CreateRun(CreateRunRequest request, ServerCallContext context)

Creates a new run.

Parameters
NameDescription
requestCreateRunRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskRun

The response to send back to the client (wrapped by a task).

DeleteLineageEvent(DeleteLineageEventRequest, ServerCallContext)

public virtual Task<Empty> DeleteLineageEvent(DeleteLineageEventRequest request, ServerCallContext context)

Deletes the lineage event with the specified name.

Parameters
NameDescription
requestDeleteLineageEventRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskEmpty

The response to send back to the client (wrapped by a task).

DeleteProcess(DeleteProcessRequest, ServerCallContext)

public virtual Task<Operation> DeleteProcess(DeleteProcessRequest request, ServerCallContext context)

Deletes the process with the specified name.

Parameters
NameDescription
requestDeleteProcessRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteRun(DeleteRunRequest, ServerCallContext)

public virtual Task<Operation> DeleteRun(DeleteRunRequest request, ServerCallContext context)

Deletes the run with the specified name.

Parameters
NameDescription
requestDeleteRunRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

GetLineageEvent(GetLineageEventRequest, ServerCallContext)

public virtual Task<LineageEvent> GetLineageEvent(GetLineageEventRequest request, ServerCallContext context)

Gets details of a specified lineage event.

Parameters
NameDescription
requestGetLineageEventRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskLineageEvent

The response to send back to the client (wrapped by a task).

GetProcess(GetProcessRequest, ServerCallContext)

public virtual Task<Process> GetProcess(GetProcessRequest request, ServerCallContext context)

Gets the details of the specified process.

Parameters
NameDescription
requestGetProcessRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskProcess

The response to send back to the client (wrapped by a task).

GetRun(GetRunRequest, ServerCallContext)

public virtual Task<Run> GetRun(GetRunRequest request, ServerCallContext context)

Gets the details of the specified run.

Parameters
NameDescription
requestGetRunRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskRun

The response to send back to the client (wrapped by a task).

ListLineageEvents(ListLineageEventsRequest, ServerCallContext)

public virtual Task<ListLineageEventsResponse> ListLineageEvents(ListLineageEventsRequest request, ServerCallContext context)

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

Parameters
NameDescription
requestListLineageEventsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListLineageEventsResponse

The response to send back to the client (wrapped by a task).

ListProcesses(ListProcessesRequest, ServerCallContext)

public virtual Task<ListProcessesResponse> ListProcesses(ListProcessesRequest request, ServerCallContext context)

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

Parameters
NameDescription
requestListProcessesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListProcessesResponse

The response to send back to the client (wrapped by a task).

ListRuns(ListRunsRequest, ServerCallContext)

public virtual Task<ListRunsResponse> ListRuns(ListRunsRequest request, ServerCallContext context)

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

Parameters
NameDescription
requestListRunsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListRunsResponse

The response to send back to the client (wrapped by a task).

ProcessOpenLineageRunEvent(ProcessOpenLineageRunEventRequest, ServerCallContext)

public virtual Task<ProcessOpenLineageRunEventResponse> ProcessOpenLineageRunEvent(ProcessOpenLineageRunEventRequest request, ServerCallContext context)

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
NameDescription
requestProcessOpenLineageRunEventRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskProcessOpenLineageRunEventResponse

The response to send back to the client (wrapped by a task).

public virtual Task<SearchLinksResponse> SearchLinks(SearchLinksRequest request, ServerCallContext context)

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
NameDescription
requestSearchLinksRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskSearchLinksResponse

The response to send back to the client (wrapped by a task).

UpdateProcess(UpdateProcessRequest, ServerCallContext)

public virtual Task<Process> UpdateProcess(UpdateProcessRequest request, ServerCallContext context)

Updates a process.

Parameters
NameDescription
requestUpdateProcessRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskProcess

The response to send back to the client (wrapped by a task).

UpdateRun(UpdateRunRequest, ServerCallContext)

public virtual Task<Run> UpdateRun(UpdateRunRequest request, ServerCallContext context)

Updates a run.

Parameters
NameDescription
requestUpdateRunRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskRun

The response to send back to the client (wrapped by a task).