Class LineageClient (2.28.0)

Lineage is used to track data flows between assets over time.

You can create LineageEvents to record lineage between multiple sources and a single target, for example, when table data is based on data from multiple tables.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

LineageClient(LineageClient const &)

Copy and move support

Parameter
Name Description
LineageClient const &

LineageClient(LineageClient &&)

Copy and move support

Parameter
Name Description
LineageClient &&

LineageClient(std::shared_ptr< LineageConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< LineageConnection >
opts Options

Operators

operator=(LineageClient const &)

Copy and move support

Parameter
Name Description
LineageClient const &
Returns
Type Description
LineageClient &

operator=(LineageClient &&)

Copy and move support

Parameter
Name Description
LineageClient &&
Returns
Type Description
LineageClient &

Functions

ProcessOpenLineageRunEvent(std::string const &, google::protobuf::Struct const &, 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
parent std::string const &

Required. The name of the project and its location that should own the process, run, and lineage event.

open_lineage google::protobuf::Struct const &

Required. OpenLineage message following OpenLineage format: https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::datacatalog::lineage::v1::ProcessOpenLineageRunEventResponse >

the result of the RPC. The response message type (google.cloud.datacatalog.lineage.v1.ProcessOpenLineageRunEventResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ProcessOpenLineageRunEvent(google::cloud::datacatalog::lineage::v1::ProcessOpenLineageRunEventRequest const &, 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 google::cloud::datacatalog::lineage::v1::ProcessOpenLineageRunEventRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.lineage.v1.ProcessOpenLineageRunEventRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::datacatalog::lineage::v1::ProcessOpenLineageRunEventResponse >

the result of the RPC. The response message type (google.cloud.datacatalog.lineage.v1.ProcessOpenLineageRunEventResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateProcess(std::string const &, google::cloud::datacatalog::lineage::v1::Process const &, Options)

Creates a new process.

Parameters
Name Description
parent std::string const &

Required. The name of the project and its location that should own the process.

process google::cloud::datacatalog::lineage::v1::Process const &

Required. The process to create.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::datacatalog::lineage::v1::Process >

the result of the RPC. The response message type (google.cloud.datacatalog.lineage.v1.Process) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateProcess(google::cloud::datacatalog::lineage::v1::CreateProcessRequest const &, Options)

Creates a new process.

Parameters
Name Description
request google::cloud::datacatalog::lineage::v1::CreateProcessRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.lineage.v1.CreateProcessRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::datacatalog::lineage::v1::Process >

the result of the RPC. The response message type (google.cloud.datacatalog.lineage.v1.Process) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateProcess(google::cloud::datacatalog::lineage::v1::Process const &, google::protobuf::FieldMask const &, Options)

Updates a process.

Parameters
Name Description
process google::cloud::datacatalog::lineage::v1::Process const &

Required. The lineage process to update.
The process's name field is used to identify the process to update.

update_mask google::protobuf::FieldMask const &

The list of fields to update. Currently not used. The whole message is updated.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::datacatalog::lineage::v1::Process >

the result of the RPC. The response message type (google.cloud.datacatalog.lineage.v1.Process) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateProcess(google::cloud::datacatalog::lineage::v1::UpdateProcessRequest const &, Options)

Updates a process.

Parameters
Name Description
request google::cloud::datacatalog::lineage::v1::UpdateProcessRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.lineage.v1.UpdateProcessRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::datacatalog::lineage::v1::Process >

the result of the RPC. The response message type (google.cloud.datacatalog.lineage.v1.Process) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetProcess(std::string const &, Options)

Gets the details of the specified process.

Parameters
Name Description
name std::string const &

Required. The name of the process to get.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::datacatalog::lineage::v1::Process >

the result of the RPC. The response message type (google.cloud.datacatalog.lineage.v1.Process) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetProcess(google::cloud::datacatalog::lineage::v1::GetProcessRequest const &, Options)

Gets the details of the specified process.

Parameters
Name Description
request google::cloud::datacatalog::lineage::v1::GetProcessRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.lineage.v1.GetProcessRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::datacatalog::lineage::v1::Process >

the result of the RPC. The response message type (google.cloud.datacatalog.lineage.v1.Process) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListProcesses(std::string const &, Options)

List processes in the given project and location.

List order is descending by insertion time.

Parameters
Name Description
parent std::string const &

Required. The name of the project and its location that owns this collection of processes.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::datacatalog::lineage::v1::Process >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.datacatalog.lineage.v1.Process, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListProcesses(google::cloud::datacatalog::lineage::v1::ListProcessesRequest, Options)

List processes in the given project and location.

List order is descending by insertion time.

Parameters
Name Description
request google::cloud::datacatalog::lineage::v1::ListProcessesRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.lineage.v1.ListProcessesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::datacatalog::lineage::v1::Process >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.datacatalog.lineage.v1.Process, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteProcess(std::string const &, Options)

Deletes the process with the specified name.

Parameters
Name Description
name std::string const &

Required. The name of the process to delete.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::datacatalog::lineage::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.datacatalog.lineage.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteProcess(NoAwaitTag, std::string const &, Options)

Deletes the process with the specified name.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteProcess(google::cloud::datacatalog::lineage::v1::DeleteProcessRequest const &, Options)

Deletes the process with the specified name.

Parameters
Name Description
request google::cloud::datacatalog::lineage::v1::DeleteProcessRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.lineage.v1.DeleteProcessRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::datacatalog::lineage::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.datacatalog.lineage.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteProcess(NoAwaitTag, google::cloud::datacatalog::lineage::v1::DeleteProcessRequest const &, Options)

Deletes the process with the specified name.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::datacatalog::lineage::v1::DeleteProcessRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteProcess(google::longrunning::Operation const &, Options)

Deletes the process with the specified name.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::datacatalog::lineage::v1::OperationMetadata > >

CreateRun(std::string const &, google::cloud::datacatalog::lineage::v1::Run const &, Options)

Creates a new run.

Parameters
Name Description
parent std::string const &

Required. The name of the process that should own the run.

run google::cloud::datacatalog::lineage::v1::Run const &

Required. The run to create.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::datacatalog::lineage::v1::Run >

the result of the RPC. The response message type (google.cloud.datacatalog.lineage.v1.Run) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateRun(google::cloud::datacatalog::lineage::v1::CreateRunRequest const &, Options)

Creates a new run.

Parameters
Name Description
request google::cloud::datacatalog::lineage::v1::CreateRunRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.lineage.v1.CreateRunRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::datacatalog::lineage::v1::Run >

the result of the RPC. The response message type (google.cloud.datacatalog.lineage.v1.Run) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateRun(google::cloud::datacatalog::lineage::v1::Run const &, google::protobuf::FieldMask const &, Options)

Updates a run.

Parameters
Name Description
run google::cloud::datacatalog::lineage::v1::Run const &

Required. The lineage run to update.
The run's name field is used to identify the run to update.
Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}.

update_mask google::protobuf::FieldMask const &

The list of fields to update. Currently not used. The whole message is updated.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::datacatalog::lineage::v1::Run >

the result of the RPC. The response message type (google.cloud.datacatalog.lineage.v1.Run) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateRun(google::cloud::datacatalog::lineage::v1::UpdateRunRequest const &, Options)

Updates a run.

Parameters
Name Description
request google::cloud::datacatalog::lineage::v1::UpdateRunRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.lineage.v1.UpdateRunRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::datacatalog::lineage::v1::Run >

the result of the RPC. The response message type (google.cloud.datacatalog.lineage.v1.Run) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetRun(std::string const &, Options)

Gets the details of the specified run.

Parameters
Name Description
name std::string const &

Required. The name of the run to get.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::datacatalog::lineage::v1::Run >

the result of the RPC. The response message type (google.cloud.datacatalog.lineage.v1.Run) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetRun(google::cloud::datacatalog::lineage::v1::GetRunRequest const &, Options)

Gets the details of the specified run.

Parameters
Name Description
request google::cloud::datacatalog::lineage::v1::GetRunRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.lineage.v1.GetRunRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::datacatalog::lineage::v1::Run >

the result of the RPC. The response message type (google.cloud.datacatalog.lineage.v1.Run) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListRuns(std::string const &, Options)

Lists runs in the given project and location.

List order is descending by start_time.

Parameters
Name Description
parent std::string const &

Required. The name of process that owns this collection of runs.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::datacatalog::lineage::v1::Run >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.datacatalog.lineage.v1.Run, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListRuns(google::cloud::datacatalog::lineage::v1::ListRunsRequest, Options)

Lists runs in the given project and location.

List order is descending by start_time.

Parameters
Name Description
request google::cloud::datacatalog::lineage::v1::ListRunsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.lineage.v1.ListRunsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::datacatalog::lineage::v1::Run >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.datacatalog.lineage.v1.Run, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteRun(std::string const &, Options)

Deletes the run with the specified name.

Parameters
Name Description
name std::string const &

Required. The name of the run to delete.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::datacatalog::lineage::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.datacatalog.lineage.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteRun(NoAwaitTag, std::string const &, Options)

Deletes the run with the specified name.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
name std::string const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteRun(google::cloud::datacatalog::lineage::v1::DeleteRunRequest const &, Options)

Deletes the run with the specified name.

Parameters
Name Description
request google::cloud::datacatalog::lineage::v1::DeleteRunRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.lineage.v1.DeleteRunRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::datacatalog::lineage::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.datacatalog.lineage.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteRun(NoAwaitTag, google::cloud::datacatalog::lineage::v1::DeleteRunRequest const &, Options)

Deletes the run with the specified name.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name Description
NoAwaitTag
request google::cloud::datacatalog::lineage::v1::DeleteRunRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

DeleteRun(google::longrunning::Operation const &, Options)

Deletes the run with the specified name.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name Description
operation google::longrunning::Operation const &
opts Options
Returns
Type Description
future< StatusOr< google::cloud::datacatalog::lineage::v1::OperationMetadata > >

CreateLineageEvent(std::string const &, google::cloud::datacatalog::lineage::v1::LineageEvent const &, Options)

Creates a new lineage event.

Parameters
Name Description
parent std::string const &

Required. The name of the run that should own the lineage event.

lineage_event google::cloud::datacatalog::lineage::v1::LineageEvent const &

Required. The lineage event to create.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::datacatalog::lineage::v1::LineageEvent >

the result of the RPC. The response message type (google.cloud.datacatalog.lineage.v1.LineageEvent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateLineageEvent(google::cloud::datacatalog::lineage::v1::CreateLineageEventRequest const &, Options)

Creates a new lineage event.

Parameters
Name Description
request google::cloud::datacatalog::lineage::v1::CreateLineageEventRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.lineage.v1.CreateLineageEventRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::datacatalog::lineage::v1::LineageEvent >

the result of the RPC. The response message type (google.cloud.datacatalog.lineage.v1.LineageEvent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetLineageEvent(std::string const &, Options)

Gets details of a specified lineage event.

Parameters
Name Description
name std::string const &

Required. The name of the lineage event to get.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::datacatalog::lineage::v1::LineageEvent >

the result of the RPC. The response message type (google.cloud.datacatalog.lineage.v1.LineageEvent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetLineageEvent(google::cloud::datacatalog::lineage::v1::GetLineageEventRequest const &, Options)

Gets details of a specified lineage event.

Parameters
Name Description
request google::cloud::datacatalog::lineage::v1::GetLineageEventRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.lineage.v1.GetLineageEventRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::datacatalog::lineage::v1::LineageEvent >

the result of the RPC. The response message type (google.cloud.datacatalog.lineage.v1.LineageEvent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListLineageEvents(std::string const &, Options)

Lists lineage events in the given project and location.

The list order is not defined.

Parameters
Name Description
parent std::string const &

Required. The name of the run that owns the collection of lineage events to get.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::datacatalog::lineage::v1::LineageEvent >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.datacatalog.lineage.v1.LineageEvent, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListLineageEvents(google::cloud::datacatalog::lineage::v1::ListLineageEventsRequest, Options)

Lists lineage events in the given project and location.

The list order is not defined.

Parameters
Name Description
request google::cloud::datacatalog::lineage::v1::ListLineageEventsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.lineage.v1.ListLineageEventsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::datacatalog::lineage::v1::LineageEvent >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.datacatalog.lineage.v1.LineageEvent, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeleteLineageEvent(std::string const &, Options)

Deletes the lineage event with the specified name.

Parameters
Name Description
name std::string const &

Required. The name of the lineage event to delete.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteLineageEvent(google::cloud::datacatalog::lineage::v1::DeleteLineageEventRequest const &, Options)

Deletes the lineage event with the specified name.

Parameters
Name Description
request google::cloud::datacatalog::lineage::v1::DeleteLineageEventRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.lineage.v1.DeleteLineageEventRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

SearchLinks(google::cloud::datacatalog::lineage::v1::SearchLinksRequest, 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 google::cloud::datacatalog::lineage::v1::SearchLinksRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.lineage.v1.SearchLinksRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::datacatalog::lineage::v1::Link >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.datacatalog.lineage.v1.Link, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

BatchSearchLinkProcesses(google::cloud::datacatalog::lineage::v1::BatchSearchLinkProcessesRequest, 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 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 google::cloud::datacatalog::lineage::v1::BatchSearchLinkProcessesRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.datacatalog.lineage.v1.BatchSearchLinkProcessesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::datacatalog::lineage::v1::ProcessLinks >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.datacatalog.lineage.v1.ProcessLinks, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.