Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Data Lineage v1 API - Class Lineage.LineageBase (1.6.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

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

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
Name	Description
`request`	`BatchSearchLinkProcessesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`CreateLineageEventRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`CreateProcessRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`CreateRunRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`DeleteLineageEventRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`DeleteProcessRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`DeleteRunRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`GetLineageEventRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`GetProcessRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`GetRunRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`ListLineageEventsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`ListProcessesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`ListRunsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`ProcessOpenLineageRunEventRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskProcessOpenLineageRunEventResponse`	The response to send back to the client (wrapped by a task).

SearchLineageStreaming(SearchLineageStreamingRequest, IServerStreamWriter<SearchLineageStreamingResponse>, ServerCallContext)

public virtual Task SearchLineageStreaming(SearchLineageStreamingRequest request, IServerStreamWriter<SearchLineageStreamingResponse> responseStream, ServerCallContext context)

Retrieves a streaming response of lineage links connected to the requested assets by performing a breadth-first search in the given direction. 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. This method retrieves links from all valid locations provided in the request. This method supports Column-Level Lineage (CLL) along with wildcard support to retrieve all CLL for an Entity FQN.

Following permissions are required to retrieve links:

datalineage.events.get permission for the project where the link is stored for entity-level lineage.
datalineage.events.getFields permission for the project where the link is stored for column-level lineage.

This method also returns processes that created the links if explicitly requested by setting max_process_per_link is non-zero and full process details are requested via links.processes.process in the FieldMask.

Permission required to retrieve processes:

datalineage.processes.get permission for the project where the process is stored.

Parameters
Name	Description
`request`	`SearchLineageStreamingRequest` The request received from the client.
`responseStream`	`IServerStreamWriterSearchLineageStreamingResponse` Used for sending responses back to the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task`	A task indicating completion of the handler.

SearchLinks(SearchLinksRequest, ServerCallContext)

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
Name	Description
`request`	`SearchLinksRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`UpdateProcessRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`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
Name	Description
`request`	`UpdateRunRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskRun`	The response to send back to the client (wrapped by a task).