google-cloud-dataplex-v1 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8199b32999dc9749b2eff414aa2f18ba50e84f121ad117b66b4de7d916d20611
-  data.tar.gz: c717930fdcc0f434cb9f194f6f0485d9b86fa2ac42acb653410e2bb5c6605e90
+  metadata.gz: 820a8268e10f1193e2396817ac7dfed8e49d47bdd0f974903ea47503dc03ceed
+  data.tar.gz: 22e258cd85ab9f78ad19bda33b36981a8366489967dd7a4a8f52e49a7be0b1e4
 SHA512:
-  metadata.gz: 8453db4104f819fb2b52b1f1b354686455fcfc111ba1f4ca702687e3d5625432d949f65a7bd755cd4c78c9fa28199865cb307af7972d0d7a76bf49a6ce6802bb
-  data.tar.gz: 30e2446fbd0308d955c6a090bed0fd22b0dd8cb2b2ee0e6539dfde200071d6b2f4ca189cd3b534cb63a189b523e3a616fef6471d55a0dd6bc8b65df09e59bf01
+  metadata.gz: 6a8e595b2ce16afb663014617d2afb74cbd892a9386f93bd4cc64e9a1e2bf8909d1a98b05238ab106777f7b99d99790f862f7d0dd9e74e9f1bef536e9064dee0
+  data.tar.gz: 047edde70f8afeaa2fbcd15d0a8a7e5d6526e3fd2b50d21da35166349ceff5159d8c35e6fa86de7b445f29ab825037fa0614aa56c4460e91ac7e722388c8a0d8

data/README.md

@@ -43,33 +43,43 @@ for class and method documentation.
 See also the [Product Documentation](https://cloud.google.com/dataplex/)
 for general usage information.
 
-## Enabling Logging
-
-To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
-that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-
-Configuring a Ruby stdlib logger:
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+You can customize logging by modifying the `logger` configuration when
+constructing a client object. For example:
 
 ```ruby
+require "google/cloud/dataplex/v1"
 require "logger"
 
-module MyLogger
-  LOGGER = Logger.new $stderr, level: Logger::WARN
-  def logger
-    LOGGER
-  end
-end
-
-# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-module GRPC
-  extend MyLogger
+client = ::Google::Cloud::Dataplex::V1::DataplexService::Client.new do |config|
+  config.logger = Logger.new "my-app.log"
 end
 ```
 
-
 ## Google Cloud Samples
 
 To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).

data/lib/google/cloud/dataplex/v1/catalog_service/client.rb

@@ -247,14 +247,26 @@ module Google
                 universe_domain: @config.universe_domain,
                 channel_args: @config.channel_args,
                 interceptors: @config.interceptors,
-                channel_pool_config: @config.channel_pool
+                channel_pool_config: @config.channel_pool,
+                logger: @config.logger
               )
 
+              @catalog_service_stub.stub_logger&.info do |entry|
+                entry.set_system_name
+                entry.set_service
+                entry.message = "Created client for #{entry.service}"
+                entry.set_credentials_fields credentials
+                entry.set "customEndpoint", @config.endpoint if @config.endpoint
+                entry.set "defaultTimeout", @config.timeout if @config.timeout
+                entry.set "quotaProject", @quota_project_id if @quota_project_id
+              end
+
               @location_client = Google::Cloud::Location::Locations::Client.new do |config|
                 config.credentials = credentials
                 config.quota_project = @quota_project_id
                 config.endpoint = @catalog_service_stub.endpoint
                 config.universe_domain = @catalog_service_stub.universe_domain
+                config.logger = @catalog_service_stub.logger if config.respond_to? :logger=
               end
 
               @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
@@ -262,6 +274,7 @@ module Google
                 config.quota_project = @quota_project_id
                 config.endpoint = @catalog_service_stub.endpoint
                 config.universe_domain = @catalog_service_stub.universe_domain
+                config.logger = @catalog_service_stub.logger if config.respond_to? :logger=
               end
             end
 
@@ -286,6 +299,15 @@ module Google
             #
             attr_reader :iam_policy_client
 
+            ##
+            # The logger used for request/response debug logging.
+            #
+            # @return [Logger]
+            #
+            def logger
+              @catalog_service_stub.logger
+            end
+
             # Service calls
 
             ##
@@ -385,7 +407,7 @@ module Google
               @catalog_service_stub.call_rpc :create_entry_type, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -484,7 +506,7 @@ module Google
               @catalog_service_stub.call_rpc :update_entry_type, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -582,7 +604,7 @@ module Google
               @catalog_service_stub.call_rpc :delete_entry_type, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -697,7 +719,7 @@ module Google
               @catalog_service_stub.call_rpc :list_entry_types, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @catalog_service_stub, :list_entry_types, request, response, operation, options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -784,7 +806,6 @@ module Google
 
               @catalog_service_stub.call_rpc :get_entry_type, 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)
@@ -887,7 +908,7 @@ module Google
               @catalog_service_stub.call_rpc :create_aspect_type, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -986,7 +1007,7 @@ module Google
               @catalog_service_stub.call_rpc :update_aspect_type, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1085,7 +1106,7 @@ module Google
               @catalog_service_stub.call_rpc :delete_aspect_type, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1200,7 +1221,7 @@ module Google
               @catalog_service_stub.call_rpc :list_aspect_types, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @catalog_service_stub, :list_aspect_types, request, response, operation, options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1287,7 +1308,6 @@ module Google
 
               @catalog_service_stub.call_rpc :get_aspect_type, 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)
@@ -1390,7 +1410,7 @@ module Google
               @catalog_service_stub.call_rpc :create_entry_group, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1489,7 +1509,7 @@ module Google
               @catalog_service_stub.call_rpc :update_entry_group, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1588,7 +1608,7 @@ module Google
               @catalog_service_stub.call_rpc :delete_entry_group, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1695,7 +1715,7 @@ module Google
               @catalog_service_stub.call_rpc :list_entry_groups, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @catalog_service_stub, :list_entry_groups, request, response, operation, options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1782,7 +1802,6 @@ module Google
 
               @catalog_service_stub.call_rpc :get_entry_group, 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)
@@ -1892,7 +1911,6 @@ module Google
 
               @catalog_service_stub.call_rpc :create_entry, 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)
@@ -1941,7 +1959,7 @@ module Google
             #     specified path. For example, to attach an aspect to a field that is
             #     specified by the `schema` aspect, the path should have the format
             #     `Schema.<field_name>`.
-            #     * `<aspect_type_reference>*` - matches aspects of the given type for all
+            #     * `<aspect_type_reference>@*` - matches aspects of the given type for all
             #     paths.
             #     * `*@path` - matches aspects of all types on the given path.
             #
@@ -2010,7 +2028,6 @@ module Google
 
               @catalog_service_stub.call_rpc :update_entry, 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)
@@ -2097,7 +2114,6 @@ module Google
 
               @catalog_service_stub.call_rpc :delete_entry, 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)
@@ -2219,7 +2235,7 @@ module Google
               @catalog_service_stub.call_rpc :list_entries, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @catalog_service_stub, :list_entries, request, response, operation, options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -2320,7 +2336,6 @@ module Google
 
               @catalog_service_stub.call_rpc :get_entry, 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)
@@ -2424,7 +2439,6 @@ module Google
 
               @catalog_service_stub.call_rpc :lookup_entry, 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)
@@ -2453,6 +2467,8 @@ module Google
             #     following form: `projects/{project}/locations/{location}`.
             #   @param query [::String]
             #     Required. The query against which entries in scope should be matched.
+            #     The query syntax is defined in [Search syntax for Dataplex
+            #     Catalog](https://cloud.google.com/dataplex/docs/search-syntax).
             #   @param page_size [::Integer]
             #     Optional. Number of results in the search page. If <=0, then defaults
             #     to 10. Max limit for page_size is 1000. Throws an invalid argument for
@@ -2462,6 +2478,10 @@ module Google
             #     this to retrieve the subsequent page.
             #   @param order_by [::String]
             #     Optional. Specifies the ordering of results.
+            #     Supported values are:
+            #     * `relevance` (default)
+            #     * `last_modified_timestamp`
+            #     * `last_modified_timestamp asc`
             #   @param scope [::String]
             #     Optional. The scope under which the search should be operating. It must
             #     either be `organizations/<org_id>` or `projects/<project_ref>`. If it is
@@ -2532,7 +2552,7 @@ module Google
               @catalog_service_stub.call_rpc :search_entries, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @catalog_service_stub, :search_entries, request, response, operation, options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -2636,7 +2656,7 @@ module Google
               @catalog_service_stub.call_rpc :create_metadata_job, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -2723,7 +2743,6 @@ module Google
 
               @catalog_service_stub.call_rpc :get_metadata_job, 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)
@@ -2837,7 +2856,7 @@ module Google
               @catalog_service_stub.call_rpc :list_metadata_jobs, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @catalog_service_stub, :list_metadata_jobs, request, response, operation, options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -2929,7 +2948,6 @@ module Google
 
               @catalog_service_stub.call_rpc :cancel_metadata_job, 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)
@@ -3018,6 +3036,11 @@ module Google
             #   default endpoint URL. The default value of nil uses the environment
             #   universe (usually the default "googleapis.com" universe).
             #   @return [::String,nil]
+            # @!attribute [rw] logger
+            #   A custom logger to use for request/response debug logging, or the value
+            #   `:default` (the default) to construct a default logger, or `nil` to
+            #   explicitly disable logging.
+            #   @return [::Logger,:default,nil]
             #
             class Configuration
               extend ::Gapic::Config
@@ -3042,6 +3065,7 @@ module Google
               config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
               config_attr :quota_project, nil, ::String, nil
               config_attr :universe_domain, nil, ::String, nil
+              config_attr :logger, :default, ::Logger, nil, :default
 
               # @private
               def initialize parent_config = nil

data/lib/google/cloud/dataplex/v1/catalog_service/operations.rb

@@ -213,7 +213,7 @@ module Google
                 wrap_lro_operation = ->(op_response) { ::Gapic::Operation.new op_response, @operations_client }
                 response = ::Gapic::PagedEnumerable.new @operations_stub, :list_operations, request, response, operation, options, format_resource: wrap_lro_operation
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -309,7 +309,7 @@ module Google
               @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -398,7 +398,6 @@ module Google
 
               @operations_stub.call_rpc :delete_operation, 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)
@@ -494,7 +493,6 @@ module Google
 
               @operations_stub.call_rpc :cancel_operation, 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)
@@ -592,7 +590,7 @@ module Google
               @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -681,6 +679,11 @@ module Google
             #   default endpoint URL. The default value of nil uses the environment
             #   universe (usually the default "googleapis.com" universe).
             #   @return [::String,nil]
+            # @!attribute [rw] logger
+            #   A custom logger to use for request/response debug logging, or the value
+            #   `:default` (the default) to construct a default logger, or `nil` to
+            #   explicitly disable logging.
+            #   @return [::Logger,:default,nil]
             #
             class Configuration
               extend ::Gapic::Config
@@ -705,6 +708,7 @@ module Google
               config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
               config_attr :quota_project, nil, ::String, nil
               config_attr :universe_domain, nil, ::String, nil
+              config_attr :logger, :default, ::Logger, nil, :default
 
               # @private
               def initialize parent_config = nil