Reference documentation and code samples for the Data Lineage V1 API class Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.
REST client for the Lineage service.
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.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the Lineage Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all Lineage clients ::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.configure do |config| config.timeout = 10.0 end
#batch_search_link_processes
def batch_search_link_processes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::ProcessLinks>
def batch_search_link_processes(parent: nil, links: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::ProcessLinks>
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.
def batch_search_link_processes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::ProcessLinks>
batch_search_link_processes
via a request object, either of type
BatchSearchLinkProcessesRequest or an equivalent Hash.
- request (::Google::Cloud::DataCatalog::Lineage::V1::BatchSearchLinkProcessesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def batch_search_link_processes(parent: nil, links: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::ProcessLinks>
batch_search_link_processes
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- parent (::String) — Required. The project and location where you want to search.
-
links (::Array<::String>) — Required. An array of links to check for their associated LineageProcesses.
The maximum number of items in this array is 100. If the request contains more than 100 links, it returns the
INVALID_ARGUMENT
error.Format:
projects/{project}/locations/{location}/links/{link}
. - page_size (::Integer) — The maximum number of processes to return in a single page of the response. A page may contain fewer results than this value.
-
page_token (::String) — The page token received from a previous
BatchSearchLinkProcesses
call. Use it to get the next page.When requesting subsequent pages of a response, remember that all parameters must match the values you provided in the original request.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::ProcessLinks>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::ProcessLinks>)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/data_catalog/lineage/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DataCatalog::Lineage::V1::BatchSearchLinkProcessesRequest.new # Call the batch_search_link_processes method. result = client.batch_search_link_processes request # The returned object is of type Gapic::PagedEnumerable. You can iterate # over elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Cloud::DataCatalog::Lineage::V1::ProcessLinks. p item end
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the Lineage Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#create_lineage_event
def create_lineage_event(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent
def create_lineage_event(parent: nil, lineage_event: nil, request_id: nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent
Creates a new lineage event.
def create_lineage_event(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent
create_lineage_event
via a request object, either of type
CreateLineageEventRequest or an equivalent Hash.
- request (::Google::Cloud::DataCatalog::Lineage::V1::CreateLineageEventRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def create_lineage_event(parent: nil, lineage_event: nil, request_id: nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent
create_lineage_event
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- parent (::String) — Required. The name of the run that should own the lineage event.
- lineage_event (::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent, ::Hash) — Required. The lineage event to create.
-
request_id (::String) — A unique identifier for this request. Restricted to 36 ASCII characters.
A random UUID is recommended. This request is idempotent only if a
request_id
is provided.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/data_catalog/lineage/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DataCatalog::Lineage::V1::CreateLineageEventRequest.new # Call the create_lineage_event method. result = client.create_lineage_event request # The returned object is of type Google::Cloud::DataCatalog::Lineage::V1::LineageEvent. p result
#create_process
def create_process(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Process
def create_process(parent: nil, process: nil, request_id: nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Process
Creates a new process.
def create_process(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Process
create_process
via a request object, either of type
CreateProcessRequest or an equivalent Hash.
- request (::Google::Cloud::DataCatalog::Lineage::V1::CreateProcessRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def create_process(parent: nil, process: nil, request_id: nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Process
create_process
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- parent (::String) — Required. The name of the project and its location that should own the process.
- process (::Google::Cloud::DataCatalog::Lineage::V1::Process, ::Hash) — Required. The process to create.
-
request_id (::String) — A unique identifier for this request. Restricted to 36 ASCII characters.
A random UUID is recommended. This request is idempotent only if a
request_id
is provided.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DataCatalog::Lineage::V1::Process)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/data_catalog/lineage/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DataCatalog::Lineage::V1::CreateProcessRequest.new # Call the create_process method. result = client.create_process request # The returned object is of type Google::Cloud::DataCatalog::Lineage::V1::Process. p result
#create_run
def create_run(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Run
def create_run(parent: nil, run: nil, request_id: nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Run
Creates a new run.
def create_run(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Run
create_run
via a request object, either of type
CreateRunRequest or an equivalent Hash.
- request (::Google::Cloud::DataCatalog::Lineage::V1::CreateRunRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def create_run(parent: nil, run: nil, request_id: nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Run
create_run
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- parent (::String) — Required. The name of the process that should own the run.
- run (::Google::Cloud::DataCatalog::Lineage::V1::Run, ::Hash) — Required. The run to create.
-
request_id (::String) — A unique identifier for this request. Restricted to 36 ASCII characters.
A random UUID is recommended. This request is idempotent only if a
request_id
is provided.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DataCatalog::Lineage::V1::Run)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/data_catalog/lineage/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DataCatalog::Lineage::V1::CreateRunRequest.new # Call the create_run method. result = client.create_run request # The returned object is of type Google::Cloud::DataCatalog::Lineage::V1::Run. p result
#delete_lineage_event
def delete_lineage_event(request, options = nil) -> ::Google::Protobuf::Empty
def delete_lineage_event(name: nil, allow_missing: nil) -> ::Google::Protobuf::Empty
Deletes the lineage event with the specified name.
def delete_lineage_event(request, options = nil) -> ::Google::Protobuf::Empty
delete_lineage_event
via a request object, either of type
DeleteLineageEventRequest or an equivalent Hash.
- request (::Google::Cloud::DataCatalog::Lineage::V1::DeleteLineageEventRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def delete_lineage_event(name: nil, allow_missing: nil) -> ::Google::Protobuf::Empty
delete_lineage_event
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- name (::String) — Required. The name of the lineage event to delete.
- allow_missing (::Boolean) — If set to true and the lineage event is not found, the request succeeds but the server doesn't perform any actions.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Protobuf::Empty)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/data_catalog/lineage/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DataCatalog::Lineage::V1::DeleteLineageEventRequest.new # Call the delete_lineage_event method. result = client.delete_lineage_event request # The returned object is of type Google::Protobuf::Empty. p result
#delete_process
def delete_process(request, options = nil) -> ::Gapic::Operation
def delete_process(name: nil, allow_missing: nil) -> ::Gapic::Operation
Deletes the process with the specified name.
def delete_process(request, options = nil) -> ::Gapic::Operation
delete_process
via a request object, either of type
DeleteProcessRequest or an equivalent Hash.
- request (::Google::Cloud::DataCatalog::Lineage::V1::DeleteProcessRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def delete_process(name: nil, allow_missing: nil) -> ::Gapic::Operation
delete_process
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- name (::String) — Required. The name of the process to delete.
- allow_missing (::Boolean) — If set to true and the process is not found, the request succeeds but the server doesn't perform any actions.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/data_catalog/lineage/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DataCatalog::Lineage::V1::DeleteProcessRequest.new # Call the delete_process method. result = client.delete_process request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#delete_run
def delete_run(request, options = nil) -> ::Gapic::Operation
def delete_run(name: nil, allow_missing: nil) -> ::Gapic::Operation
Deletes the run with the specified name.
def delete_run(request, options = nil) -> ::Gapic::Operation
delete_run
via a request object, either of type
DeleteRunRequest or an equivalent Hash.
- request (::Google::Cloud::DataCatalog::Lineage::V1::DeleteRunRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def delete_run(name: nil, allow_missing: nil) -> ::Gapic::Operation
delete_run
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- name (::String) — Required. The name of the run to delete.
- allow_missing (::Boolean) — If set to true and the run is not found, the request succeeds but the server doesn't perform any actions.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/data_catalog/lineage/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DataCatalog::Lineage::V1::DeleteRunRequest.new # Call the delete_run method. result = client.delete_run request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#get_lineage_event
def get_lineage_event(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent
def get_lineage_event(name: nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent
Gets details of a specified lineage event.
def get_lineage_event(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent
get_lineage_event
via a request object, either of type
GetLineageEventRequest or an equivalent Hash.
- request (::Google::Cloud::DataCatalog::Lineage::V1::GetLineageEventRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get_lineage_event(name: nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent
get_lineage_event
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- name (::String) — Required. The name of the lineage event to get.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/data_catalog/lineage/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DataCatalog::Lineage::V1::GetLineageEventRequest.new # Call the get_lineage_event method. result = client.get_lineage_event request # The returned object is of type Google::Cloud::DataCatalog::Lineage::V1::LineageEvent. p result
#get_process
def get_process(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Process
def get_process(name: nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Process
Gets the details of the specified process.
def get_process(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Process
get_process
via a request object, either of type
GetProcessRequest or an equivalent Hash.
- request (::Google::Cloud::DataCatalog::Lineage::V1::GetProcessRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get_process(name: nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Process
get_process
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- name (::String) — Required. The name of the process to get.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DataCatalog::Lineage::V1::Process)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/data_catalog/lineage/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DataCatalog::Lineage::V1::GetProcessRequest.new # Call the get_process method. result = client.get_process request # The returned object is of type Google::Cloud::DataCatalog::Lineage::V1::Process. p result
#get_run
def get_run(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Run
def get_run(name: nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Run
Gets the details of the specified run.
def get_run(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Run
get_run
via a request object, either of type
GetRunRequest or an equivalent Hash.
- request (::Google::Cloud::DataCatalog::Lineage::V1::GetRunRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def get_run(name: nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Run
get_run
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- name (::String) — Required. The name of the run to get.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DataCatalog::Lineage::V1::Run)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/data_catalog/lineage/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DataCatalog::Lineage::V1::GetRunRequest.new # Call the get_run method. result = client.get_run request # The returned object is of type Google::Cloud::DataCatalog::Lineage::V1::Run. p result
#initialize
def initialize() { |config| ... } -> Client
Create a new Lineage REST client object.
- (config) — Configure the Lineage client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.new # Create a client using a custom configuration client = ::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.new do |config| config.timeout = 10.0 end
#list_lineage_events
def list_lineage_events(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent>
def list_lineage_events(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent>
Lists lineage events in the given project and location. The list order is not defined.
def list_lineage_events(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent>
list_lineage_events
via a request object, either of type
Google::Cloud::DataCatalog::Lineage::V1::ListLineageEventsRequest or an equivalent Hash.
- request (::Google::Cloud::DataCatalog::Lineage::V1::ListLineageEventsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def list_lineage_events(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent>
list_lineage_events
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- parent (::String) — Required. The name of the run that owns the collection of lineage events to get.
-
page_size (::Integer) — The maximum number of lineage events to return.
The service may return fewer events than this value. If unspecified, at most 50 events are returned. The maximum value is 100; values greater than 100 are cut to 100.
-
page_token (::String) — The page token received from a previous
ListLineageEvents
call. Specify it to get the next page.When paginating, all other parameters specified in this call must match the parameters of the call that provided the page token.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent>)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/data_catalog/lineage/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DataCatalog::Lineage::V1::ListLineageEventsRequest.new # Call the list_lineage_events method. result = client.list_lineage_events request # The returned object is of type Gapic::PagedEnumerable. You can iterate # over elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent. p item end
#list_processes
def list_processes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Process>
def list_processes(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Process>
List processes in the given project and location. List order is descending by insertion time.
def list_processes(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Process>
list_processes
via a request object, either of type
Google::Cloud::DataCatalog::Lineage::V1::ListProcessesRequest or an equivalent Hash.
- request (::Google::Cloud::DataCatalog::Lineage::V1::ListProcessesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def list_processes(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Process>
list_processes
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- parent (::String) — Required. The name of the project and its location that owns this collection of processes.
- page_size (::Integer) — The maximum number of processes to return. The service may return fewer than this value. If unspecified, at most 50 processes are returned. The maximum value is 100; values greater than 100 are cut to 100.
-
page_token (::String) — The page token received from a previous
ListProcesses
call. Specify it to get the next page.When paginating, all other parameters specified in this call must match the parameters of the call that provided the page token.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Process>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Process>)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/data_catalog/lineage/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DataCatalog::Lineage::V1::ListProcessesRequest.new # Call the list_processes method. result = client.list_processes request # The returned object is of type Gapic::PagedEnumerable. You can iterate # over elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Cloud::DataCatalog::Lineage::V1::Process. p item end
#list_runs
def list_runs(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Run>
def list_runs(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Run>
Lists runs in the given project and location. List order is descending by
start_time
.
def list_runs(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Run>
list_runs
via a request object, either of type
Google::Cloud::DataCatalog::Lineage::V1::ListRunsRequest or an equivalent Hash.
- request (::Google::Cloud::DataCatalog::Lineage::V1::ListRunsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def list_runs(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Run>
list_runs
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- parent (::String) — Required. The name of process that owns this collection of runs.
- page_size (::Integer) — The maximum number of runs to return. The service may return fewer than this value. If unspecified, at most 50 runs are returned. The maximum value is 100; values greater than 100 are cut to 100.
-
page_token (::String) — The page token received from a previous
ListRuns
call. Specify it to get the next page.When paginating, all other parameters specified in this call must match the parameters of the call that provided the page token.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Run>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Run>)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/data_catalog/lineage/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DataCatalog::Lineage::V1::ListRunsRequest.new # Call the list_runs method. result = client.list_runs request # The returned object is of type Gapic::PagedEnumerable. You can iterate # over elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Cloud::DataCatalog::Lineage::V1::Run. p item end
#operations_client
def operations_client() -> ::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Operations
Get the associated client for long-running operations.
#process_open_lineage_run_event
def process_open_lineage_run_event(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::ProcessOpenLineageRunEventResponse
def process_open_lineage_run_event(parent: nil, open_lineage: nil, request_id: nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::ProcessOpenLineageRunEventResponse
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.
def process_open_lineage_run_event(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::ProcessOpenLineageRunEventResponse
process_open_lineage_run_event
via a request object, either of type
ProcessOpenLineageRunEventRequest or an equivalent Hash.
- request (::Google::Cloud::DataCatalog::Lineage::V1::ProcessOpenLineageRunEventRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def process_open_lineage_run_event(parent: nil, open_lineage: nil, request_id: nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::ProcessOpenLineageRunEventResponse
process_open_lineage_run_event
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- parent (::String) — Required. The name of the project and its location that should own the process, run, and lineage event.
- open_lineage (::Google::Protobuf::Struct, ::Hash) — Required. OpenLineage message following OpenLineage format: https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json
-
request_id (::String) — A unique identifier for this request. Restricted to 36 ASCII characters.
A random UUID is recommended. This request is idempotent only if a
request_id
is provided.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DataCatalog::Lineage::V1::ProcessOpenLineageRunEventResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/data_catalog/lineage/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DataCatalog::Lineage::V1::ProcessOpenLineageRunEventRequest.new # Call the process_open_lineage_run_event method. result = client.process_open_lineage_run_event request # The returned object is of type Google::Cloud::DataCatalog::Lineage::V1::ProcessOpenLineageRunEventResponse. p result
#search_links
def search_links(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Link>
def search_links(parent: nil, source: nil, target: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Link>
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.
def search_links(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Link>
search_links
via a request object, either of type
SearchLinksRequest or an equivalent Hash.
- request (::Google::Cloud::DataCatalog::Lineage::V1::SearchLinksRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def search_links(parent: nil, source: nil, target: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Link>
search_links
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
- parent (::String) — Required. The project and location you want search in.
- source (::Google::Cloud::DataCatalog::Lineage::V1::EntityReference, ::Hash) — Optional. Send asset information in the source field to retrieve all links that lead from the specified asset to downstream assets.
- target (::Google::Cloud::DataCatalog::Lineage::V1::EntityReference, ::Hash) — Optional. Send asset information in the target field to retrieve all links that lead from upstream assets to the specified asset.
-
page_size (::Integer) — Optional. The maximum number of links to return in a single page of the
response. A page may contain fewer links than this value. If unspecified,
at most 10 links are returned.
Maximum value is 100; values greater than 100 are reduced to 100.
-
page_token (::String) — Optional. The page token received from a previous
SearchLinksRequest
call. Use it to get the next page.When requesting subsequent pages of a response, remember that all parameters must match the values you provided in the original request.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Link>)
- operation (::Gapic::Rest::TransportOperation)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Link>)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/data_catalog/lineage/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DataCatalog::Lineage::V1::SearchLinksRequest.new # Call the search_links method. result = client.search_links request # The returned object is of type Gapic::PagedEnumerable. You can iterate # over elements, and API calls will be issued to fetch pages as needed. result.each do |item| # Each element is of type ::Google::Cloud::DataCatalog::Lineage::V1::Link. p item end
#update_process
def update_process(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Process
def update_process(process: nil, update_mask: nil, allow_missing: nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Process
Updates a process.
def update_process(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Process
update_process
via a request object, either of type
UpdateProcessRequest or an equivalent Hash.
- request (::Google::Cloud::DataCatalog::Lineage::V1::UpdateProcessRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def update_process(process: nil, update_mask: nil, allow_missing: nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Process
update_process
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
process (::Google::Cloud::DataCatalog::Lineage::V1::Process, ::Hash) — Required. The lineage process to update.
The process's
name
field is used to identify the process to update. - update_mask (::Google::Protobuf::FieldMask, ::Hash) — The list of fields to update. Currently not used. The whole message is updated.
- allow_missing (::Boolean) — If set to true and the process is not found, the request inserts it.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DataCatalog::Lineage::V1::Process)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/data_catalog/lineage/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DataCatalog::Lineage::V1::UpdateProcessRequest.new # Call the update_process method. result = client.update_process request # The returned object is of type Google::Cloud::DataCatalog::Lineage::V1::Process. p result
#update_run
def update_run(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Run
def update_run(run: nil, update_mask: nil, allow_missing: nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Run
Updates a run.
def update_run(request, options = nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Run
update_run
via a request object, either of type
UpdateRunRequest or an equivalent Hash.
- request (::Google::Cloud::DataCatalog::Lineage::V1::UpdateRunRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
def update_run(run: nil, update_mask: nil, allow_missing: nil) -> ::Google::Cloud::DataCatalog::Lineage::V1::Run
update_run
via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).
-
run (::Google::Cloud::DataCatalog::Lineage::V1::Run, ::Hash) — 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, ::Hash) — The list of fields to update. Currently not used. The whole message is updated.
- allow_missing (::Boolean) — If set to true and the run is not found, the request creates it.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::DataCatalog::Lineage::V1::Run)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
Basic example
require "google/cloud/data_catalog/lineage/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DataCatalog::Lineage::V1::Lineage::Rest::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DataCatalog::Lineage::V1::UpdateRunRequest.new # Call the update_run method. result = client.update_run request # The returned object is of type Google::Cloud::DataCatalog::Lineage::V1::Run. p result