google-cloud-os_config 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f493b34dea87c863c4ff9227b12e22084369f4b935a837e13d6900f6a6a52150
-  data.tar.gz: bb7b76ef486da782303e2c040f911980e891196f1e6d7ee83c6bdd8a8bcaa96e
+  metadata.gz: b9c216243bfef75a90c3aa33a9d9f56781836baed0d5955d19525c0dd182214f
+  data.tar.gz: d7b08fec99ad08f390240d1dd88e7c76fb76d126a5c8d8e56f1070b512e46bac
 SHA512:
-  metadata.gz: cdf5c4242b085b8f084e5fc698d08bfb413a0459ec664feae677024d79a5e467e831b46c8d469b7f551a56980fe5e330bf1494834a41ef41a6c670d382bb6512
-  data.tar.gz: 2feb705d1e3b4d0ee9284232e00c7a975c4ff7c5165b24a8069bc4626b2d4bbf503f67af53ce0a697433bf62ce5bef9709b9df0c006c5354171e132b273ff067
+  metadata.gz: 90a187399181f6ceb4b96a20c0268e9a05c071b66e8dd76b5ef1bca792afa700e68f9942c2f423d1b292571076139ece448e2e521db73e313611d3464a3fbc8e
+  data.tar.gz: 7f6be57c35b37eadf835ef682fdcc3ddff6b997f426dc842635bfe75b9d92dacd3c322d341461d4a0e1fcc07539a9f69c86cd2c8fd1f59d4961c31c2661e0353

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/osconfig.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-os_config-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-os_config-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/os_config/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module OsConfig
-      VERSION = "1.6.1"
+      VERSION = "1.7.0"
     end
   end
 end

data/lib/google/cloud/os_config.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 OsConfigService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::OsConfig.os_config_service_available?}.
+      #
       # ## About OsConfigService
       #
       # OS Config API
@@ -82,6 +87,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the OsConfigService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::OsConfig.os_config_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 OsConfigService service,
+      # or if the versioned client gem needs an update to support the OsConfigService 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.os_config_service_available? version: :v1, transport: :grpc
+        require "google/cloud/os_config/#{version.to_s.downcase}"
+        package_name = Google::Cloud::OsConfig
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::OsConfig.const_get package_name
+        return false unless service_module.const_defined? :OsConfigService
+        service_module = service_module.const_get :OsConfigService
+        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 OsConfigZonalService.
       #
@@ -95,6 +131,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 OsConfigZonalService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::OsConfig.os_config_zonal_service_available?}.
+      #
       # ## About OsConfigZonalService
       #
       # Zonal OS Config API
@@ -119,6 +160,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the OsConfigZonalService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::OsConfig.os_config_zonal_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 OsConfigZonalService service,
+      # or if the versioned client gem needs an update to support the OsConfigZonalService 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.os_config_zonal_service_available? version: :v1, transport: :grpc
+        require "google/cloud/os_config/#{version.to_s.downcase}"
+        package_name = Google::Cloud::OsConfig
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::OsConfig.const_get package_name
+        return false unless service_module.const_defined? :OsConfigZonalService
+        service_module = service_module.const_get :OsConfigZonalService
+        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-os_config library.
       #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-os_config
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -62,7 +61,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -70,15 +68,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.6
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: API Client library for the Cloud OS Config API
 test_files: []