Class: Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb

Overview

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.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#lineage_event_path, #location_path, #process_path, #run_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new Lineage client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Lineage client.

Yield Parameters:



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 130

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/datacatalog/lineage/v1/lineage_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @lineage_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )
end

Instance Attribute Details

#operations_client ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Operations (readonly)

Get the associated client for long-running operations.

Returns:



182
183
184
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 182

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the Lineage Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all Lineage clients
::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 63

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "DataCatalog", "Lineage", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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.

Examples:

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::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

Overloads:

  • #batch_search_link_processes(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::ProcessLinks>

    Pass arguments to batch_search_link_processes via a request object, either of type BatchSearchLinkProcessesRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #batch_search_link_processes(parent: nil, links: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::ProcessLinks>

    Pass arguments to 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).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The project and location where you want to search.

    • links (::Array<::String>) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 1783

def batch_search_link_processes request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::BatchSearchLinkProcessesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.batch_search_link_processes.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.batch_search_link_processes.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.batch_search_link_processes.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @lineage_stub.call_rpc :batch_search_link_processes, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @lineage_stub, :batch_search_link_processes, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



100
101
102
103
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 100

def configure
  yield @config if block_given?
  @config
end

#create_lineage_event(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent #create_lineage_event(parent: nil, lineage_event: nil, request_id: nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent

Creates a new lineage event.

Examples:

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::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

Overloads:

  • #create_lineage_event(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent

    Pass arguments to create_lineage_event via a request object, either of type CreateLineageEventRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_lineage_event(parent: nil, lineage_event: nil, request_id: nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent

    Pass arguments to 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).

    Parameters:

    • parent (::String) (defaults to: nil) —

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

    • lineage_event (::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent, ::Hash) (defaults to: nil) —

      Required. The lineage event to create.

    • request_id (::String) (defaults to: nil) —

      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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 1269

def create_lineage_event request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::CreateLineageEventRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_lineage_event.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_lineage_event.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_lineage_event.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @lineage_stub.call_rpc :create_lineage_event, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_process(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Process #create_process(parent: nil, process: nil, request_id: nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Process

Creates a new process.

Examples:

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::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

Overloads:

  • #create_process(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Process

    Pass arguments to create_process via a request object, either of type CreateProcessRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_process(parent: nil, process: nil, request_id: nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Process

    Pass arguments to 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).

    Parameters:

    • parent (::String) (defaults to: nil) —

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

    • process (::Google::Cloud::DataCatalog::Lineage::V1::Process, ::Hash) (defaults to: nil) —

      Required. The process to create.

    • request_id (::String) (defaults to: nil) —

      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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 333

def create_process request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::CreateProcessRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_process.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_process.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_process.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @lineage_stub.call_rpc :create_process, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_run(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Run #create_run(parent: nil, run: nil, request_id: nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Run

Creates a new run.

Examples:

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::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

Overloads:

  • #create_run(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Run

    Pass arguments to create_run via a request object, either of type CreateRunRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_run(parent: nil, run: nil, request_id: nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Run

    Pass arguments to 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).

    Parameters:

    • parent (::String) (defaults to: nil) —

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

    • run (::Google::Cloud::DataCatalog::Lineage::V1::Run, ::Hash) (defaults to: nil) —

      Required. The run to create.

    • request_id (::String) (defaults to: nil) —

      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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 800

def create_run request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::CreateRunRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_run.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_run.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_run.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @lineage_stub.call_rpc :create_run, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_lineage_event(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_lineage_event(name: nil, allow_missing: nil) ⇒ ::Google::Protobuf::Empty

Deletes the lineage event with the specified name.

Examples:

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::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

Overloads:

  • #delete_lineage_event(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_lineage_event via a request object, either of type DeleteLineageEventRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_lineage_event(name: nil, allow_missing: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to 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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the lineage event to delete.

    • allow_missing (::Boolean) (defaults to: nil) —

      If set to true and the lineage event is not found, the request succeeds but the server doesn't perform any actions.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 1546

def delete_lineage_event request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::DeleteLineageEventRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_lineage_event.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_lineage_event.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_lineage_event.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @lineage_stub.call_rpc :delete_lineage_event, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_process(request, options = nil) ⇒ ::Gapic::Operation #delete_process(name: nil, allow_missing: nil) ⇒ ::Gapic::Operation

Deletes the process with the specified name.

Examples:

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::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

Overloads:

  • #delete_process(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_process via a request object, either of type DeleteProcessRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_process(name: nil, allow_missing: nil) ⇒ ::Gapic::Operation

    Pass arguments to 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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the process to delete.

    • allow_missing (::Boolean) (defaults to: nil) —

      If set to true and the process is not found, the request succeeds but the server doesn't perform any actions.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 708

def delete_process request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::DeleteProcessRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_process.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_process.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_process.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @lineage_stub.call_rpc :delete_process, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_run(request, options = nil) ⇒ ::Gapic::Operation #delete_run(name: nil, allow_missing: nil) ⇒ ::Gapic::Operation

Deletes the run with the specified name.

Examples:

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::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

Overloads:

  • #delete_run(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_run via a request object, either of type DeleteRunRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_run(name: nil, allow_missing: nil) ⇒ ::Gapic::Operation

    Pass arguments to 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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the run to delete.

    • allow_missing (::Boolean) (defaults to: nil) —

      If set to true and the run is not found, the request succeeds but the server doesn't perform any actions.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 1177

def delete_run request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::DeleteRunRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_run.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_run.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_run.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @lineage_stub.call_rpc :delete_run, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_lineage_event(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent #get_lineage_event(name: nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent

Gets details of a specified lineage event.

Examples:

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::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

Overloads:

  • #get_lineage_event(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent

    Pass arguments to get_lineage_event via a request object, either of type GetLineageEventRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_lineage_event(name: nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent

    Pass arguments to 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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the lineage event to get.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 1354

def get_lineage_event request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::GetLineageEventRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_lineage_event.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_lineage_event.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_lineage_event.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @lineage_stub.call_rpc :get_lineage_event, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_process(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Process #get_process(name: nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Process

Gets the details of the specified process.

Examples:

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::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

Overloads:

  • #get_process(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Process

    Pass arguments to get_process via a request object, either of type GetProcessRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_process(name: nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Process

    Pass arguments to 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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the process to get.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 510

def get_process request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::GetProcessRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_process.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_process.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_process.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @lineage_stub.call_rpc :get_process, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_run(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Run #get_run(name: nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Run

Gets the details of the specified run.

Examples:

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::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

Overloads:

  • #get_run(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Run

    Pass arguments to get_run via a request object, either of type GetRunRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_run(name: nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Run

    Pass arguments to 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).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the run to get.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 980

def get_run request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::GetRunRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_run.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_run.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_run.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @lineage_stub.call_rpc :get_run, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_lineage_events(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent> #list_lineage_events(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent>

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

Examples:

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::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

Overloads:

  • #list_lineage_events(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent>

    Pass arguments to list_lineage_events via a request object, either of type Google::Cloud::DataCatalog::Lineage::V1::ListLineageEventsRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_lineage_events(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::LineageEvent>

    Pass arguments to 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).

    Parameters:

    • parent (::String) (defaults to: nil) —

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

    • page_size (::Integer) (defaults to: nil) —

      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) (defaults to: nil) —

      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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 1457

def list_lineage_events request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::ListLineageEventsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_lineage_events.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_lineage_events.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_lineage_events.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @lineage_stub.call_rpc :list_lineage_events, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @lineage_stub, :list_lineage_events, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_processes(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Process> #list_processes(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Process>

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

Examples:

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::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

Overloads:

  • #list_processes(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Process>

    Pass arguments to list_processes via a request object, either of type Google::Cloud::DataCatalog::Lineage::V1::ListProcessesRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_processes(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Process>

    Pass arguments to 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).

    Parameters:

    • parent (::String) (defaults to: nil) —

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

    • page_size (::Integer) (defaults to: nil) —

      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) (defaults to: nil) —

      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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 612

def list_processes request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::ListProcessesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_processes.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_processes.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_processes.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @lineage_stub.call_rpc :list_processes, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @lineage_stub, :list_processes, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_runs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Run> #list_runs(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Run>

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

Examples:

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::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

Overloads:

  • #list_runs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Run>

    Pass arguments to list_runs via a request object, either of type Google::Cloud::DataCatalog::Lineage::V1::ListRunsRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_runs(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Run>

    Pass arguments to 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).

    Parameters:

    • parent (::String) (defaults to: nil) —

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

    • page_size (::Integer) (defaults to: nil) —

      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) (defaults to: nil) —

      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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 1081

def list_runs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::ListRunsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_runs.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_runs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_runs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @lineage_stub.call_rpc :list_runs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @lineage_stub, :list_runs, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#process_open_lineage_run_event(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::ProcessOpenLineageRunEventResponse #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.

Examples:

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::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

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 241

def process_open_lineage_run_event request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::ProcessOpenLineageRunEventRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.process_open_lineage_run_event.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.process_open_lineage_run_event.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.process_open_lineage_run_event.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @lineage_stub.call_rpc :process_open_lineage_run_event, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#search_links(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Link> #search_links(parent: nil, source: nil, target: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::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.

Examples:

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::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

Overloads:

  • #search_links(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Link>

    Pass arguments to search_links via a request object, either of type SearchLinksRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #search_links(parent: nil, source: nil, target: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::DataCatalog::Lineage::V1::Link>

    Pass arguments to 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).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The project and location you want search in.

    • source (::Google::Cloud::DataCatalog::Lineage::V1::EntityReference, ::Hash) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. Send asset information in the target field to retrieve all links that lead from upstream assets to the specified asset.

    • page_size (::Integer) (defaults to: nil) —

      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) (defaults to: nil) —

      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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 1662

def search_links request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::SearchLinksRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.search_links.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.search_links.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.search_links.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @lineage_stub.call_rpc :search_links, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @lineage_stub, :search_links, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


110
111
112
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 110

def universe_domain
  @lineage_stub.universe_domain
end

#update_process(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Process #update_process(process: nil, update_mask: nil, allow_missing: nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Process

Updates a process.

Examples:

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::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

Overloads:

  • #update_process(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Process

    Pass arguments to update_process via a request object, either of type UpdateProcessRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_process(process: nil, update_mask: nil, allow_missing: nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Process

    Pass arguments to 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).

    Parameters:

    • process (::Google::Cloud::DataCatalog::Lineage::V1::Process, ::Hash) (defaults to: nil) —

      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) (defaults to: nil) —

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

    • allow_missing (::Boolean) (defaults to: nil) —

      If set to true and the process is not found, the request inserts it.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 425

def update_process request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::UpdateProcessRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_process.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.process&.name
    header_params["process.name"] = request.process.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_process.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_process.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @lineage_stub.call_rpc :update_process, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_run(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Run #update_run(run: nil, update_mask: nil, allow_missing: nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Run

Updates a run.

Examples:

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::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

Overloads:

  • #update_run(request, options = nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Run

    Pass arguments to update_run via a request object, either of type UpdateRunRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_run(run: nil, update_mask: nil, allow_missing: nil) ⇒ ::Google::Cloud::DataCatalog::Lineage::V1::Run

    Pass arguments to 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).

    Parameters:

    • run (::Google::Cloud::DataCatalog::Lineage::V1::Run, ::Hash) (defaults to: nil) —

      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) (defaults to: nil) —

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

    • allow_missing (::Boolean) (defaults to: nil) —

      If set to true and the run is not found, the request creates it.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
 
# File 'lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb', line 895

def update_run request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DataCatalog::Lineage::V1::UpdateRunRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_run.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DataCatalog::Lineage::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.run&.name
    header_params["run.name"] = request.run.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_run.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_run.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @lineage_stub.call_rpc :update_run, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end