google-iam-v1beta 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41abc13c2babd9bb190bce9a405515b5ad24f3f75c38599f5695fc0c867554aa
-  data.tar.gz: 2c91f1202fa931e7b4ff7da8534f0e2a994fdce22bae4214d194a426a9ad328f
+  metadata.gz: 021572ccfa238e172b70c41a200711a9a901ba01321d3ed92b67787e9525b67a
+  data.tar.gz: 8cbef9da6112d68ef9f8b0e9afe50d9f4f7462160f6867a64350f33a14ac8554
 SHA512:
-  metadata.gz: 7ddea03926abe793c7b0480d96a9b6d7ed07302b1bb061b3280fb459d8331db5ecc7e7db50e800bb7352b2710bce40c35ead295e8be99b3dbd3fe67a93b24be6
-  data.tar.gz: ad8d3bec9919c1e1aecb0e22f2528c74b6680fc8c90643275bf24ca3ed1f6a9474127d90791863e17350ad39d4f69ba408b96a63f8c8298a5458b1fe432ddb7c
+  metadata.gz: 85a778544400152de6fc8a3dc6ec9235306b06f39223a490f2b4d721deddefffebe3bbc81d441beb00bd60e42755d3d29ae194107aafdeedbc67dde47dbc89d8
+  data.tar.gz: 5cce949b879fd565a9e1b8cf4b66517f62379b6cb1fafb4bfe773d782edf5d7c395aba6e1833ab4bf296ba5679b369d2edd4f33e345202dd08ff9d53eff6bc59

data/README.md

@@ -43,33 +43,43 @@ for class and method documentation.
 See also the [Product Documentation](https://cloud.google.com/iam/docs/manage-workload-identity-pools-providers)
 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/iam/v1beta"
 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::Iam::V1beta::WorkloadIdentityPools::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/iam/v1beta/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Iam
     module V1beta
-      VERSION = "0.8.2"
+      VERSION = "0.9.0"
     end
   end
 end

data/lib/google/iam/v1beta/workload_identity_pools/client.rb

@@ -223,8 +223,19 @@ 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
             )
+
+            @workload_identity_pools_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
           end
 
           ##
@@ -234,6 +245,15 @@ module Google
           #
           attr_reader :operations_client
 
+          ##
+          # The logger used for request/response debug logging.
+          #
+          # @return [Logger]
+          #
+          def logger
+            @workload_identity_pools_stub.logger
+          end
+
           # Service calls
 
           ##
@@ -333,7 +353,7 @@ module Google
             @workload_identity_pools_stub.call_rpc :list_workload_identity_pools, request, options: options do |response, operation|
               response = ::Gapic::PagedEnumerable.new @workload_identity_pools_stub, :list_workload_identity_pools, 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)
@@ -420,7 +440,6 @@ module Google
 
             @workload_identity_pools_stub.call_rpc :get_workload_identity_pool, 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)
@@ -525,7 +544,7 @@ module Google
             @workload_identity_pools_stub.call_rpc :create_workload_identity_pool, 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)
@@ -622,7 +641,7 @@ module Google
             @workload_identity_pools_stub.call_rpc :update_workload_identity_pool, 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)
@@ -727,7 +746,7 @@ module Google
             @workload_identity_pools_stub.call_rpc :delete_workload_identity_pool, 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)
@@ -822,7 +841,7 @@ module Google
             @workload_identity_pools_stub.call_rpc :undelete_workload_identity_pool, 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)
@@ -926,7 +945,7 @@ module Google
             @workload_identity_pools_stub.call_rpc :list_workload_identity_pool_providers, request, options: options do |response, operation|
               response = ::Gapic::PagedEnumerable.new @workload_identity_pools_stub, :list_workload_identity_pool_providers, 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)
@@ -1013,7 +1032,6 @@ module Google
 
             @workload_identity_pools_stub.call_rpc :get_workload_identity_pool_provider, 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)
@@ -1119,7 +1137,7 @@ module Google
             @workload_identity_pools_stub.call_rpc :create_workload_identity_pool_provider, 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)
@@ -1216,7 +1234,7 @@ module Google
             @workload_identity_pools_stub.call_rpc :update_workload_identity_pool_provider, 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)
@@ -1316,7 +1334,7 @@ module Google
             @workload_identity_pools_stub.call_rpc :delete_workload_identity_pool_provider, 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)
@@ -1412,7 +1430,7 @@ module Google
             @workload_identity_pools_stub.call_rpc :undelete_workload_identity_pool_provider, 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)
@@ -1501,6 +1519,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
@@ -1525,6 +1548,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/iam/v1beta/workload_identity_pools/operations.rb

@@ -212,7 +212,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)
@@ -308,7 +308,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)
@@ -397,7 +397,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)
@@ -493,7 +492,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)
@@ -591,7 +589,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)
@@ -680,6 +678,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
@@ -704,6 +707,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-iam-v1beta
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-05 00:00:00.000000000 Z
+date: 2024-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.24.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.24.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a