Data Lineage v1 API - Class Lineage.LineageClient (1.3.0)

public class Lineage.LineageClient : ClientBase<Lineage.LineageClient>

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

Client for Lineage

Inheritance

object > ClientBase > ClientBaseLineageLineageClient > Lineage.LineageClient

Namespace

Google.Cloud.DataCatalog.Lineage.V1

Assembly

Google.Cloud.DataCatalog.Lineage.V1.dll

Constructors

LineageClient()

protected LineageClient()

Protected parameterless constructor to allow creation of test doubles.

LineageClient(CallInvoker)

public LineageClient(CallInvoker callInvoker)

Creates a new client for Lineage that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

LineageClient(ChannelBase)

public LineageClient(ChannelBase channel)

Creates a new client for Lineage

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

LineageClient(ClientBaseConfiguration)

protected LineageClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

BatchSearchLinkProcesses(BatchSearchLinkProcessesRequest, CallOptions)

public virtual BatchSearchLinkProcessesResponse BatchSearchLinkProcesses(BatchSearchLinkProcessesRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
BatchSearchLinkProcessesResponse

The response received from the server.

BatchSearchLinkProcesses(BatchSearchLinkProcessesRequest, Metadata, DateTime?, CancellationToken)

public virtual BatchSearchLinkProcessesResponse BatchSearchLinkProcesses(BatchSearchLinkProcessesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
BatchSearchLinkProcessesResponse

The response received from the server.

BatchSearchLinkProcessesAsync(BatchSearchLinkProcessesRequest, CallOptions)

public virtual AsyncUnaryCall<BatchSearchLinkProcessesResponse> BatchSearchLinkProcessesAsync(BatchSearchLinkProcessesRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallBatchSearchLinkProcessesResponse

The call object.

BatchSearchLinkProcessesAsync(BatchSearchLinkProcessesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BatchSearchLinkProcessesResponse> BatchSearchLinkProcessesAsync(BatchSearchLinkProcessesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallBatchSearchLinkProcessesResponse

The call object.

CreateLineageEvent(CreateLineageEventRequest, CallOptions)

public virtual LineageEvent CreateLineageEvent(CreateLineageEventRequest request, CallOptions options)

Creates a new lineage event.

Parameters
Name Description
request CreateLineageEventRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
LineageEvent

The response received from the server.

CreateLineageEvent(CreateLineageEventRequest, Metadata, DateTime?, CancellationToken)

public virtual LineageEvent CreateLineageEvent(CreateLineageEventRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new lineage event.

Parameters
Name Description
request CreateLineageEventRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
LineageEvent

The response received from the server.

CreateLineageEventAsync(CreateLineageEventRequest, CallOptions)

public virtual AsyncUnaryCall<LineageEvent> CreateLineageEventAsync(CreateLineageEventRequest request, CallOptions options)

Creates a new lineage event.

Parameters
Name Description
request CreateLineageEventRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallLineageEvent

The call object.

CreateLineageEventAsync(CreateLineageEventRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<LineageEvent> CreateLineageEventAsync(CreateLineageEventRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new lineage event.

Parameters
Name Description
request CreateLineageEventRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallLineageEvent

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

CreateProcess(CreateProcessRequest, CallOptions)

public virtual Process CreateProcess(CreateProcessRequest request, CallOptions options)

Creates a new process.

Parameters
Name Description
request CreateProcessRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Process

The response received from the server.

CreateProcess(CreateProcessRequest, Metadata, DateTime?, CancellationToken)

public virtual Process CreateProcess(CreateProcessRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new process.

Parameters
Name Description
request CreateProcessRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Process

The response received from the server.

CreateProcessAsync(CreateProcessRequest, CallOptions)

public virtual AsyncUnaryCall<Process> CreateProcessAsync(CreateProcessRequest request, CallOptions options)

Creates a new process.

Parameters
Name Description
request CreateProcessRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallProcess

The call object.

CreateProcessAsync(CreateProcessRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Process> CreateProcessAsync(CreateProcessRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new process.

Parameters
Name Description
request CreateProcessRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallProcess

The call object.

CreateRun(CreateRunRequest, CallOptions)

public virtual Run CreateRun(CreateRunRequest request, CallOptions options)

Creates a new run.

Parameters
Name Description
request CreateRunRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Run

The response received from the server.

CreateRun(CreateRunRequest, Metadata, DateTime?, CancellationToken)

public virtual Run CreateRun(CreateRunRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new run.

Parameters
Name Description
request CreateRunRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Run

The response received from the server.

CreateRunAsync(CreateRunRequest, CallOptions)

public virtual AsyncUnaryCall<Run> CreateRunAsync(CreateRunRequest request, CallOptions options)

Creates a new run.

Parameters
Name Description
request CreateRunRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallRun

The call object.

CreateRunAsync(CreateRunRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Run> CreateRunAsync(CreateRunRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new run.

Parameters
Name Description
request CreateRunRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallRun

The call object.

DeleteLineageEvent(DeleteLineageEventRequest, CallOptions)

public virtual Empty DeleteLineageEvent(DeleteLineageEventRequest request, CallOptions options)

Deletes the lineage event with the specified name.

Parameters
Name Description
request DeleteLineageEventRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeleteLineageEvent(DeleteLineageEventRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteLineageEvent(DeleteLineageEventRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the lineage event with the specified name.

Parameters
Name Description
request DeleteLineageEventRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Empty

The response received from the server.

DeleteLineageEventAsync(DeleteLineageEventRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteLineageEventAsync(DeleteLineageEventRequest request, CallOptions options)

Deletes the lineage event with the specified name.

Parameters
Name Description
request DeleteLineageEventRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteLineageEventAsync(DeleteLineageEventRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteLineageEventAsync(DeleteLineageEventRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the lineage event with the specified name.

Parameters
Name Description
request DeleteLineageEventRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteProcess(DeleteProcessRequest, CallOptions)

public virtual Operation DeleteProcess(DeleteProcessRequest request, CallOptions options)

Deletes the process with the specified name.

Parameters
Name Description
request DeleteProcessRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteProcess(DeleteProcessRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteProcess(DeleteProcessRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the process with the specified name.

Parameters
Name Description
request DeleteProcessRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeleteProcessAsync(DeleteProcessRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteProcessAsync(DeleteProcessRequest request, CallOptions options)

Deletes the process with the specified name.

Parameters
Name Description
request DeleteProcessRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteProcessAsync(DeleteProcessRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteProcessAsync(DeleteProcessRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the process with the specified name.

Parameters
Name Description
request DeleteProcessRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteRun(DeleteRunRequest, CallOptions)

public virtual Operation DeleteRun(DeleteRunRequest request, CallOptions options)

Deletes the run with the specified name.

Parameters
Name Description
request DeleteRunRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteRun(DeleteRunRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteRun(DeleteRunRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the run with the specified name.

Parameters
Name Description
request DeleteRunRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeleteRunAsync(DeleteRunRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteRunAsync(DeleteRunRequest request, CallOptions options)

Deletes the run with the specified name.

Parameters
Name Description
request DeleteRunRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteRunAsync(DeleteRunRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteRunAsync(DeleteRunRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the run with the specified name.

Parameters
Name Description
request DeleteRunRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

GetLineageEvent(GetLineageEventRequest, CallOptions)

public virtual LineageEvent GetLineageEvent(GetLineageEventRequest request, CallOptions options)

Gets details of a specified lineage event.

Parameters
Name Description
request GetLineageEventRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
LineageEvent

The response received from the server.

GetLineageEvent(GetLineageEventRequest, Metadata, DateTime?, CancellationToken)

public virtual LineageEvent GetLineageEvent(GetLineageEventRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a specified lineage event.

Parameters
Name Description
request GetLineageEventRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
LineageEvent

The response received from the server.

GetLineageEventAsync(GetLineageEventRequest, CallOptions)

public virtual AsyncUnaryCall<LineageEvent> GetLineageEventAsync(GetLineageEventRequest request, CallOptions options)

Gets details of a specified lineage event.

Parameters
Name Description
request GetLineageEventRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallLineageEvent

The call object.

GetLineageEventAsync(GetLineageEventRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<LineageEvent> GetLineageEventAsync(GetLineageEventRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a specified lineage event.

Parameters
Name Description
request GetLineageEventRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallLineageEvent

The call object.

GetProcess(GetProcessRequest, CallOptions)

public virtual Process GetProcess(GetProcessRequest request, CallOptions options)

Gets the details of the specified process.

Parameters
Name Description
request GetProcessRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Process

The response received from the server.

GetProcess(GetProcessRequest, Metadata, DateTime?, CancellationToken)

public virtual Process GetProcess(GetProcessRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the details of the specified process.

Parameters
Name Description
request GetProcessRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Process

The response received from the server.

GetProcessAsync(GetProcessRequest, CallOptions)

public virtual AsyncUnaryCall<Process> GetProcessAsync(GetProcessRequest request, CallOptions options)

Gets the details of the specified process.

Parameters
Name Description
request GetProcessRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallProcess

The call object.

GetProcessAsync(GetProcessRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Process> GetProcessAsync(GetProcessRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the details of the specified process.

Parameters
Name Description
request GetProcessRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallProcess

The call object.

GetRun(GetRunRequest, CallOptions)

public virtual Run GetRun(GetRunRequest request, CallOptions options)

Gets the details of the specified run.

Parameters
Name Description
request GetRunRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Run

The response received from the server.

GetRun(GetRunRequest, Metadata, DateTime?, CancellationToken)

public virtual Run GetRun(GetRunRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the details of the specified run.

Parameters
Name Description
request GetRunRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Run

The response received from the server.

GetRunAsync(GetRunRequest, CallOptions)

public virtual AsyncUnaryCall<Run> GetRunAsync(GetRunRequest request, CallOptions options)

Gets the details of the specified run.

Parameters
Name Description
request GetRunRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallRun

The call object.

GetRunAsync(GetRunRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Run> GetRunAsync(GetRunRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the details of the specified run.

Parameters
Name Description
request GetRunRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallRun

The call object.

ListLineageEvents(ListLineageEventsRequest, CallOptions)

public virtual ListLineageEventsResponse ListLineageEvents(ListLineageEventsRequest request, CallOptions options)

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

Parameters
Name Description
request ListLineageEventsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListLineageEventsResponse

The response received from the server.

ListLineageEvents(ListLineageEventsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListLineageEventsResponse ListLineageEvents(ListLineageEventsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListLineageEventsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListLineageEventsResponse

The response received from the server.

ListLineageEventsAsync(ListLineageEventsRequest, CallOptions)

public virtual AsyncUnaryCall<ListLineageEventsResponse> ListLineageEventsAsync(ListLineageEventsRequest request, CallOptions options)

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

Parameters
Name Description
request ListLineageEventsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListLineageEventsResponse

The call object.

ListLineageEventsAsync(ListLineageEventsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListLineageEventsResponse> ListLineageEventsAsync(ListLineageEventsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListLineageEventsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListLineageEventsResponse

The call object.

ListProcesses(ListProcessesRequest, CallOptions)

public virtual ListProcessesResponse ListProcesses(ListProcessesRequest request, CallOptions options)

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

Parameters
Name Description
request ListProcessesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListProcessesResponse

The response received from the server.

ListProcesses(ListProcessesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListProcessesResponse ListProcesses(ListProcessesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListProcessesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListProcessesResponse

The response received from the server.

ListProcessesAsync(ListProcessesRequest, CallOptions)

public virtual AsyncUnaryCall<ListProcessesResponse> ListProcessesAsync(ListProcessesRequest request, CallOptions options)

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

Parameters
Name Description
request ListProcessesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListProcessesResponse

The call object.

ListProcessesAsync(ListProcessesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListProcessesResponse> ListProcessesAsync(ListProcessesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListProcessesRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListProcessesResponse

The call object.

ListRuns(ListRunsRequest, CallOptions)

public virtual ListRunsResponse ListRuns(ListRunsRequest request, CallOptions options)

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

Parameters
Name Description
request ListRunsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListRunsResponse

The response received from the server.

ListRuns(ListRunsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListRunsResponse ListRuns(ListRunsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListRunsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListRunsResponse

The response received from the server.

ListRunsAsync(ListRunsRequest, CallOptions)

public virtual AsyncUnaryCall<ListRunsResponse> ListRunsAsync(ListRunsRequest request, CallOptions options)

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

Parameters
Name Description
request ListRunsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListRunsResponse

The call object.

ListRunsAsync(ListRunsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListRunsResponse> ListRunsAsync(ListRunsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListRunsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListRunsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override Lineage.LineageClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
LineageLineageClient
Overrides

ProcessOpenLineageRunEvent(ProcessOpenLineageRunEventRequest, CallOptions)

public virtual ProcessOpenLineageRunEventResponse ProcessOpenLineageRunEvent(ProcessOpenLineageRunEventRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ProcessOpenLineageRunEventResponse

The response received from the server.

ProcessOpenLineageRunEvent(ProcessOpenLineageRunEventRequest, Metadata, DateTime?, CancellationToken)

public virtual ProcessOpenLineageRunEventResponse ProcessOpenLineageRunEvent(ProcessOpenLineageRunEventRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ProcessOpenLineageRunEventResponse

The response received from the server.

ProcessOpenLineageRunEventAsync(ProcessOpenLineageRunEventRequest, CallOptions)

public virtual AsyncUnaryCall<ProcessOpenLineageRunEventResponse> ProcessOpenLineageRunEventAsync(ProcessOpenLineageRunEventRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallProcessOpenLineageRunEventResponse

The call object.

ProcessOpenLineageRunEventAsync(ProcessOpenLineageRunEventRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ProcessOpenLineageRunEventResponse> ProcessOpenLineageRunEventAsync(ProcessOpenLineageRunEventRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallProcessOpenLineageRunEventResponse

The call object.

public virtual SearchLinksResponse SearchLinks(SearchLinksRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
SearchLinksResponse

The response received from the server.

public virtual SearchLinksResponse SearchLinks(SearchLinksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
SearchLinksResponse

The response received from the server.

SearchLinksAsync(SearchLinksRequest, CallOptions)

public virtual AsyncUnaryCall<SearchLinksResponse> SearchLinksAsync(SearchLinksRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallSearchLinksResponse

The call object.

SearchLinksAsync(SearchLinksRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SearchLinksResponse> SearchLinksAsync(SearchLinksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallSearchLinksResponse

The call object.

UpdateProcess(UpdateProcessRequest, CallOptions)

public virtual Process UpdateProcess(UpdateProcessRequest request, CallOptions options)

Updates a process.

Parameters
Name Description
request UpdateProcessRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Process

The response received from the server.

UpdateProcess(UpdateProcessRequest, Metadata, DateTime?, CancellationToken)

public virtual Process UpdateProcess(UpdateProcessRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a process.

Parameters
Name Description
request UpdateProcessRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Process

The response received from the server.

UpdateProcessAsync(UpdateProcessRequest, CallOptions)

public virtual AsyncUnaryCall<Process> UpdateProcessAsync(UpdateProcessRequest request, CallOptions options)

Updates a process.

Parameters
Name Description
request UpdateProcessRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallProcess

The call object.

UpdateProcessAsync(UpdateProcessRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Process> UpdateProcessAsync(UpdateProcessRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a process.

Parameters
Name Description
request UpdateProcessRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallProcess

The call object.

UpdateRun(UpdateRunRequest, CallOptions)

public virtual Run UpdateRun(UpdateRunRequest request, CallOptions options)

Updates a run.

Parameters
Name Description
request UpdateRunRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Run

The response received from the server.

UpdateRun(UpdateRunRequest, Metadata, DateTime?, CancellationToken)

public virtual Run UpdateRun(UpdateRunRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a run.

Parameters
Name Description
request UpdateRunRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Run

The response received from the server.

UpdateRunAsync(UpdateRunRequest, CallOptions)

public virtual AsyncUnaryCall<Run> UpdateRunAsync(UpdateRunRequest request, CallOptions options)

Updates a run.

Parameters
Name Description
request UpdateRunRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallRun

The call object.

UpdateRunAsync(UpdateRunRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Run> UpdateRunAsync(UpdateRunRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a run.

Parameters
Name Description
request UpdateRunRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallRun

The call object.