google-cloud-data_catalog-lineage-v1 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6731f748576acef54cf6d3d7b6c04e6af47f0fdaf3ac46d6f52fe57763cc1a3d
-  data.tar.gz: e6673bda380d6cfc0a9ec12ee7617142a9bf22b7347f5eeb8176005b001f31b9
+  metadata.gz: 680f57dd5d9d3b576e45e0a08ab1e964b84ddb02559afcf943242a36326d912c
+  data.tar.gz: 111cf762ac6a37e5a812f0c2a17b073dafdc8d0e19e2cc56f017ac9e546fc573
 SHA512:
-  metadata.gz: f03a8b05a357264478239cb7f192479320fd01102c7d99ed555e26e01154c3f730667d879d8561ccf7d386f4e0ccfbbf198de58fa87c57b34f7935ffa76c3610
-  data.tar.gz: '078f672c14961918f2a2d0d259f6648f690adefeb495257ca08fb386a7a2f78e44ef8ef72040baaa40af830f8c9da9d5e14bca284ac2a07f4cc2f10a3007d7af'
+  metadata.gz: 7ca8b4fbb1f8c90ac7ad6e3307096244155fefec08148b248d50b18973420e9db369681588f4635f1178cab130e3b0330708c74e14cc12f5e9cfd7fd755d9fb6
+  data.tar.gz: f71eaeb6f492f9abc266bcbd86bf480c72bdeb75daf5866df835ef1112f76121a0043765b877f532e074da633d54528f90d7bdd01c1a9f19c3e38c630c28b111

data/README.md

@@ -33,8 +33,8 @@ In order to use this library, you first need to go through the following steps:
 require "google/cloud/data_catalog/lineage/v1"
 
 client = ::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new
-request = ::Google::Cloud::DataCatalog::Lineage::V1::CreateProcessRequest.new # (request fields as keyword arguments...)
-response = client.create_process request
+request = ::Google::Cloud::DataCatalog::Lineage::V1::ProcessOpenLineageRunEventRequest.new # (request fields as keyword arguments...)
+response = client.process_open_lineage_run_event request
 ```
 
 View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-data_catalog-lineage-v1/latest)

data/lib/google/cloud/data_catalog/lineage/v1/lineage/client.rb

@@ -153,7 +153,8 @@ module Google
                   credentials:  credentials,
                   endpoint:     @config.endpoint,
                   channel_args: @config.channel_args,
-                  interceptors: @config.interceptors
+                  interceptors: @config.interceptors,
+                  channel_pool_config: @config.channel_pool
                 )
               end
 
@@ -166,6 +167,102 @@ module Google
 
               # Service calls
 
+              ##
+              # 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.
+              #
+              # @overload process_open_lineage_run_event(request, options = nil)
+              #   Pass arguments to `process_open_lineage_run_event` via a request object, either of type
+              #   {::Google::Cloud::DataCatalog::Lineage::V1::ProcessOpenLineageRunEventRequest} or an equivalent Hash.
+              #
+              #   @param 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.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+              #
+              # @overload process_open_lineage_run_event(parent: nil, open_lineage: nil, request_id: nil)
+              #   Pass arguments to `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).
+              #
+              #   @param parent [::String]
+              #     Required. The name of the project and its location that should own the
+              #     process, run, and lineage event.
+              #   @param open_lineage [::Google::Protobuf::Struct, ::Hash]
+              #     Required. OpenLineage message following OpenLineage format:
+              #     https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json
+              #   @param 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.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Cloud::DataCatalog::Lineage::V1::ProcessOpenLineageRunEventResponse]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Cloud::DataCatalog::Lineage::V1::ProcessOpenLineageRunEventResponse]
+              #
+              # @raise [::Google::Cloud::Error] if the RPC is aborted.
+              #
+              # @example 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
+              #
+              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
+
               ##
               # Creates a new process.
               #
@@ -738,7 +835,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
               #
-              # @overload update_run(run: nil, update_mask: nil)
+              # @overload update_run(run: nil, update_mask: nil, allow_missing: nil)
               #   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).
@@ -753,6 +850,8 @@ module Google
               #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
               #     The list of fields to update. Currently not used. The whole message is
               #     updated.
+              #   @param allow_missing [::Boolean]
+              #     If set to true and the run is not found, the request creates it.
               #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [::Google::Cloud::DataCatalog::Lineage::V1::Run]
@@ -1496,7 +1595,7 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param parent [::String]
-              #     Required. The project and location you want search in the format `projects/*/locations/*`
+              #     Required. The project and location you want search in.
               #   @param 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.
@@ -1618,7 +1717,7 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param parent [::String]
-              #     Required. The project and location you want search in the format `projects/*/locations/*`
+              #     Required. The project and location where you want to search.
               #   @param links [::Array<::String>]
               #     Required. An array of links to check for their associated LineageProcesses.
               #
@@ -1723,17 +1822,17 @@ module Google
               # @example
               #
               #   # Modify the global config, setting the timeout for
-              #   # create_process to 20 seconds,
+              #   # process_open_lineage_run_event to 20 seconds,
               #   # and all remaining timeouts to 10 seconds.
               #   ::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.configure do |config|
               #     config.timeout = 10.0
-              #     config.rpcs.create_process.timeout = 20.0
+              #     config.rpcs.process_open_lineage_run_event.timeout = 20.0
               #   end
               #
               #   # Apply the above configuration only to a new client.
               #   client = ::Google::Cloud::DataCatalog::Lineage::V1::Lineage::Client.new do |config|
               #     config.timeout = 10.0
-              #     config.rpcs.create_process.timeout = 20.0
+              #     config.rpcs.process_open_lineage_run_event.timeout = 20.0
               #   end
               #
               # @!attribute [rw] endpoint
@@ -1826,6 +1925,14 @@ module Google
                   end
                 end
 
+                ##
+                # Configuration for the channel pool
+                # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+                #
+                def channel_pool
+                  @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+                end
+
                 ##
                 # Configuration RPC class for the Lineage API.
                 #
@@ -1844,6 +1951,11 @@ module Google
                 #         trigger a retry.
                 #
                 class Rpcs
+                  ##
+                  # RPC-specific configuration for `process_open_lineage_run_event`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :process_open_lineage_run_event
                   ##
                   # RPC-specific configuration for `create_process`
                   # @return [::Gapic::Config::Method]
@@ -1927,6 +2039,8 @@ module Google
 
                   # @private
                   def initialize parent_rpcs = nil
+                    process_open_lineage_run_event_config = parent_rpcs.process_open_lineage_run_event if parent_rpcs.respond_to? :process_open_lineage_run_event
+                    @process_open_lineage_run_event = ::Gapic::Config::Method.new process_open_lineage_run_event_config
                     create_process_config = parent_rpcs.create_process if parent_rpcs.respond_to? :create_process
                     @create_process = ::Gapic::Config::Method.new create_process_config
                     update_process_config = parent_rpcs.update_process if parent_rpcs.respond_to? :update_process

data/lib/google/cloud/data_catalog/lineage/v1/lineage/operations.rb

@@ -94,7 +94,8 @@ module Google
                   credentials:  credentials,
                   endpoint:     @config.endpoint,
                   channel_args: @config.channel_args,
-                  interceptors: @config.interceptors
+                  interceptors: @config.interceptors,
+                  channel_pool_config: @config.channel_pool
                 )
 
                 # Used by an LRO wrapper for some methods of this service
@@ -702,6 +703,14 @@ module Google
                   end
                 end
 
+                ##
+                # Configuration for the channel pool
+                # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+                #
+                def channel_pool
+                  @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+                end
+
                 ##
                 # Configuration RPC class for the Operations API.
                 #