google-cloud-dataplex 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb5854f63546ec0a54084d2c020380265a95e888f7e078ddd5937329a0988d90
-  data.tar.gz: a85471fa3200a261d7762f1d5b97ba0953ca3b22e5f714130a0d0493fe4b3dc2
+  metadata.gz: 716acd7954b03685b61ceb0c243a9ac6d10da13b303a3cc78897684884788f75
+  data.tar.gz: 537b0b8fd99f3f62d3663f9d80b05ca4a4be62de7665ebb3af5a52c7d7ae16f5
 SHA512:
-  metadata.gz: eb2e6adc4c7a9e111bf9e35917cd5d501dcfaeda8507c4be37acdc419cd317900a3e4db84411e0969825b00fd6b92887ec4d78467ba62ec8354bd707b194276c
-  data.tar.gz: dd835df6241c0eb1d8d2654b2f3cd6ef0a88ccc121e90c55609625fdff1f3901a5b73391be47d337d21daf1600e6ddd91f24b937838226a8d0707cb8d6b0085e
+  metadata.gz: bec0163fd809a8e44f1a5f96e4f55cd9a78007cc5eb7795ec697d0f172fee7341dbac689713c1bb1dfa851e7e318184f5aec769ec430a132590865c2be1822fe
+  data.tar.gz: ad843efb617e5511ade95f13cca3204707bb0a76963d1241c1992ba55e66c295ca4cdced355104e601736f0aa07636be4855c02fa9e9babf32668fd9622ce21d

data/README.md

@@ -34,9 +34,39 @@ In order to use this library, you first need to go through the following steps:
 1. [Enable the API.](https://console.cloud.google.com/apis/library/dataplex.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
+## 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.
+
+Debug logging also requires that the versioned clients for this service be
+sufficiently recent, released after about Dec 10, 2024. If logging is not
+working, try updating the versioned clients in your bundle or installed gems:
+[google-cloud-dataplex-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-dataplex-v1/latest).
+
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.7+.
+This library is supported on Ruby 3.0+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or

data/lib/google/cloud/dataplex/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module Dataplex
-      VERSION = "1.5.0"
+      VERSION = "1.6.0"
     end
   end
 end

data/lib/google/cloud/dataplex.rb

@@ -58,6 +58,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the DataplexService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Dataplex.dataplex_service_available?}.
+      #
       # ## About DataplexService
       #
       # Dataplex service provides data lakes as a service. The primary resources
@@ -83,6 +88,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the DataplexService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Dataplex.dataplex_service}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the DataplexService service,
+      # or if the versioned client gem needs an update to support the DataplexService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.dataplex_service_available? version: :v1, transport: :grpc
+        require "google/cloud/dataplex/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Dataplex
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Dataplex.const_get package_name
+        return false unless service_module.const_defined? :DataplexService
+        service_module = service_module.const_get :DataplexService
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for CatalogService.
       #
@@ -96,6 +132,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the CatalogService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Dataplex.catalog_service_available?}.
+      #
       # ## About CatalogService
       #
       # The primary resources offered by this service are EntryGroups, EntryTypes,
@@ -121,6 +162,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the CatalogService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Dataplex.catalog_service}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the CatalogService service,
+      # or if the versioned client gem needs an update to support the CatalogService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.catalog_service_available? version: :v1, transport: :grpc
+        require "google/cloud/dataplex/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Dataplex
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Dataplex.const_get package_name
+        return false unless service_module.const_defined? :CatalogService
+        service_module = service_module.const_get :CatalogService
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for ContentService.
       #
@@ -134,6 +206,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the ContentService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Dataplex.content_service_available?}.
+      #
       # ## About ContentService
       #
       # ContentService manages Notebook and SQL Scripts for Dataplex.
@@ -155,6 +232,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the ContentService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Dataplex.content_service}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the ContentService service,
+      # or if the versioned client gem needs an update to support the ContentService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.content_service_available? version: :v1, transport: :grpc
+        require "google/cloud/dataplex/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Dataplex
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Dataplex.const_get package_name
+        return false unless service_module.const_defined? :ContentService
+        service_module = service_module.const_get :ContentService
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for DataTaxonomyService.
       #
@@ -168,6 +276,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the DataTaxonomyService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Dataplex.data_taxonomy_service_available?}.
+      #
       # ## About DataTaxonomyService
       #
       # DataTaxonomyService enables attribute-based governance. The resources
@@ -190,6 +303,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the DataTaxonomyService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Dataplex.data_taxonomy_service}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the DataTaxonomyService service,
+      # or if the versioned client gem needs an update to support the DataTaxonomyService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.data_taxonomy_service_available? version: :v1, transport: :grpc
+        require "google/cloud/dataplex/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Dataplex
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Dataplex.const_get package_name
+        return false unless service_module.const_defined? :DataTaxonomyService
+        service_module = service_module.const_get :DataTaxonomyService
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for DataScanService.
       #
@@ -203,6 +347,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the DataScanService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Dataplex.data_scan_service_available?}.
+      #
       # ## About DataScanService
       #
       # DataScanService manages DataScan resources which can be configured to run
@@ -226,6 +375,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the DataScanService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Dataplex.data_scan_service}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the DataScanService service,
+      # or if the versioned client gem needs an update to support the DataScanService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.data_scan_service_available? version: :v1, transport: :grpc
+        require "google/cloud/dataplex/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Dataplex
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Dataplex.const_get package_name
+        return false unless service_module.const_defined? :DataScanService
+        service_module = service_module.const_get :DataScanService
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for MetadataService.
       #
@@ -239,6 +419,11 @@ module Google
       # You can also specify a different transport by passing `:rest` or `:grpc` in
       # the `transport` parameter.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the MetadataService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Dataplex.metadata_service_available?}.
+      #
       # ## About MetadataService
       #
       # Metadata service manages metadata resources such as tables, filesets and
@@ -261,6 +446,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the MetadataService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Dataplex.metadata_service}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the MetadataService service,
+      # or if the versioned client gem needs an update to support the MetadataService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.metadata_service_available? version: :v1, transport: :grpc
+        require "google/cloud/dataplex/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Dataplex
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Dataplex.const_get package_name
+        return false unless service_module.const_defined? :MetadataService
+        service_module = service_module.const_get :MetadataService
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Configure the google-cloud-dataplex library.
       #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-dataplex
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-04 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -64,7 +63,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -72,15 +70,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: API Client library for the Dataplex API
 test_files: []