google-cloud-batch-v1 0.19.2 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 987b72cf1605fb0c1150f2c3c67fb1bbb4a3fe30f2a21f27400a7c6938d041a0
-  data.tar.gz: 590be726a4b911bf978a1084e9a2afbfeea29654427b130b233e5b5eec99244d
+  metadata.gz: 3295ffb42bc81bdcc492bc4b55a8078aa5c9dffaec542b41ab963dd964eea42c
+  data.tar.gz: e47e5c9047f237a4ae5ca26ee7ff234d43912f31fe73b95901d0e7ff8f4e53f7
 SHA512:
-  metadata.gz: 7cf0d962382d01d297ff67af49670840bae76e58a6a59ea478dd1dd4a60480595fb44387f212104b0e8bd037141cb39867258912b4768b434732053cf21f331b
-  data.tar.gz: ccdbd0a332bbccc8be3d2e3fa95d6d35e61a9f4cf842321b0a385944349b5e74272ea447ce93b424a4273842829a8996a6140350c56bd3ae566b44f290c1e39c
+  metadata.gz: d42a80210f285f76587c68d223406797b8e055a9325ae2cceddb25a3fd9d8cd7f171fb6340ea6bec5f13c7c9ff9acc001bd4703c2015345df97d2b36a1320c7b
+  data.tar.gz: af380b3b61345011d4e5ad2182a0769800b7a52198446bc451aa486ca600e900244bcbb071f11eca8cfbd5cce85850ce9e1dd1ac6a9e5d2c5a1b8b2ca871e3bb

data/README.md

@@ -40,33 +40,43 @@ response = client.create_job request
 View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-batch-v1/latest)
 for class and method documentation.
 
-## 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/batch/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::Batch::V1::BatchService::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/batch/v1/batch_service/client.rb

@@ -191,14 +191,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
               )
 
+              @batch_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 = @batch_service_stub.endpoint
                 config.universe_domain = @batch_service_stub.universe_domain
+                config.logger = @batch_service_stub.logger if config.respond_to? :logger=
               end
             end
 
@@ -216,6 +228,15 @@ module Google
             #
             attr_reader :location_client
 
+            ##
+            # The logger used for request/response debug logging.
+            #
+            # @return [Logger]
+            #
+            def logger
+              @batch_service_stub.logger
+            end
+
             # Service calls
 
             ##
@@ -325,7 +346,6 @@ module Google
 
               @batch_service_stub.call_rpc :create_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)
@@ -411,7 +431,6 @@ module Google
 
               @batch_service_stub.call_rpc :get_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)
@@ -521,7 +540,7 @@ module Google
               @batch_service_stub.call_rpc :delete_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)
@@ -621,7 +640,7 @@ module Google
               @batch_service_stub.call_rpc :list_jobs, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @batch_service_stub, :list_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)
@@ -707,7 +726,6 @@ module Google
 
               @batch_service_stub.call_rpc :get_task, 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)
@@ -808,7 +826,7 @@ module Google
               @batch_service_stub.call_rpc :list_tasks, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @batch_service_stub, :list_tasks, 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)
@@ -897,6 +915,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
@@ -921,6 +944,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/batch/v1/batch_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

data/lib/google/cloud/batch/v1/batch_service/rest/client.rb

@@ -184,15 +184,27 @@ module Google
                   endpoint: @config.endpoint,
                   endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
                   universe_domain: @config.universe_domain,
-                  credentials: credentials
+                  credentials: credentials,
+                  logger: @config.logger
                 )
 
+                @batch_service_stub.logger(stub: true)&.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::Rest::Client.new do |config|
                   config.credentials = credentials
                   config.quota_project = @quota_project_id
                   config.endpoint = @batch_service_stub.endpoint
                   config.universe_domain = @batch_service_stub.universe_domain
                   config.bindings_override = @config.bindings_override
+                  config.logger = @batch_service_stub.logger if config.respond_to? :logger=
                 end
               end
 
@@ -210,6 +222,15 @@ module Google
               #
               attr_reader :location_client
 
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger
+                @batch_service_stub.logger
+              end
+
               # Service calls
 
               ##
@@ -312,7 +333,6 @@ module Google
 
                 @batch_service_stub.create_job request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -391,7 +411,6 @@ module Google
 
                 @batch_service_stub.get_job request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -494,7 +513,7 @@ module Google
                 @batch_service_stub.delete_job request, options do |result, operation|
                   result = ::Gapic::Operation.new result, @operations_client, options: options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -586,7 +605,6 @@ module Google
 
                 @batch_service_stub.list_jobs request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -665,7 +683,6 @@ module Google
 
                 @batch_service_stub.get_task request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -758,7 +775,6 @@ module Google
 
                 @batch_service_stub.list_tasks request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -838,6 +854,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
@@ -866,6 +887,7 @@ module Google
                 # by the host service.
                 # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
                 config_attr :bindings_override, {}, ::Hash, nil
+                config_attr :logger, :default, ::Logger, nil, :default
 
                 # @private
                 def initialize parent_config = nil

data/lib/google/cloud/batch/v1/batch_service/rest/operations.rb

@@ -196,7 +196,7 @@ module Google
                 @operations_stub.list_operations request, options do |result, operation|
                   result = ::Gapic::Rest::PagedEnumerable.new @operations_stub, :list_operations, "operations", request, result, options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -285,7 +285,7 @@ module Google
                 @operations_stub.get_operation request, options do |result, operation|
                   result = ::Gapic::Operation.new result, @operations_client, options: options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -367,7 +367,6 @@ module Google
 
                 @operations_stub.delete_operation request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -456,7 +455,6 @@ module Google
 
                 @operations_stub.cancel_operation request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -536,6 +534,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
@@ -557,6 +560,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
@@ -676,16 +680,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "list_operations",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Longrunning::ListOperationsResponse.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -714,16 +720,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "get_operation",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -752,16 +760,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "delete_operation",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -790,16 +800,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "cancel_operation",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##

data/lib/google/cloud/batch/v1/batch_service/rest/service_stub.rb

@@ -30,7 +30,8 @@ module Google
             # including transcoding, making the REST call, and deserialing the response.
             #
             class ServiceStub
-              def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
+              # @private
+              def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
                 # These require statements are intentionally placed here to initialize
                 # the REST modules only when it's required.
                 require "gapic/rest"
@@ -40,7 +41,9 @@ module Google
                                                              universe_domain: universe_domain,
                                                              credentials: credentials,
                                                              numeric_enums: true,
-                                                             raise_faraday_errors: false
+                                                             service_name: self.class,
+                                                             raise_faraday_errors: false,
+                                                             logger: logger
               end
 
               ##
@@ -61,6 +64,15 @@ module Google
                 @client_stub.endpoint
               end
 
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger stub: false
+                stub ? @client_stub.stub_logger : @client_stub.logger
+              end
+
               ##
               # Baseline implementation for the create_job REST call
               #
@@ -87,16 +99,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "create_job",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::Batch::V1::Job.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -125,16 +139,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "get_job",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::Batch::V1::Job.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -163,16 +179,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "delete_job",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -201,16 +219,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "list_jobs",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::Batch::V1::ListJobsResponse.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -239,16 +259,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "get_task",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::Batch::V1::Task.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -277,16 +299,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "list_tasks",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::Batch::V1::ListTasksResponse.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##

data/lib/google/cloud/batch/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Batch
       module V1
-        VERSION = "0.19.2"
+        VERSION = "0.20.0"
       end
     end
   end

data/lib/google/iam/v1/iam_policy/client.rb

@@ -179,14 +179,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
             )
 
+            @iam_policy_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 = @iam_policy_stub.endpoint
               config.universe_domain = @iam_policy_stub.universe_domain
+              config.logger = @iam_policy_stub.logger if config.respond_to? :logger=
             end
           end
 
@@ -197,6 +209,15 @@ module Google
           #
           attr_reader :location_client
 
+          ##
+          # The logger used for request/response debug logging.
+          #
+          # @return [Logger]
+          #
+          def logger
+            @iam_policy_stub.logger
+          end
+
           # Service calls
 
           ##
@@ -294,7 +315,6 @@ module Google
 
             @iam_policy_stub.call_rpc :set_iam_policy, 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)
@@ -386,7 +406,6 @@ module Google
 
             @iam_policy_stub.call_rpc :get_iam_policy, 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)
@@ -484,7 +503,6 @@ module Google
 
             @iam_policy_stub.call_rpc :test_iam_permissions, 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)
@@ -573,6 +591,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
@@ -597,6 +620,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/v1/iam_policy/rest/client.rb

@@ -172,15 +172,27 @@ module Google
                 endpoint: @config.endpoint,
                 endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
                 universe_domain: @config.universe_domain,
-                credentials: credentials
+                credentials: credentials,
+                logger: @config.logger
               )
 
+              @iam_policy_stub.logger(stub: true)&.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::Rest::Client.new do |config|
                 config.credentials = credentials
                 config.quota_project = @quota_project_id
                 config.endpoint = @iam_policy_stub.endpoint
                 config.universe_domain = @iam_policy_stub.universe_domain
                 config.bindings_override = @config.bindings_override
+                config.logger = @iam_policy_stub.logger if config.respond_to? :logger=
               end
             end
 
@@ -191,6 +203,15 @@ module Google
             #
             attr_reader :location_client
 
+            ##
+            # The logger used for request/response debug logging.
+            #
+            # @return [Logger]
+            #
+            def logger
+              @iam_policy_stub.logger
+            end
+
             # Service calls
 
             ##
@@ -281,7 +302,6 @@ module Google
 
               @iam_policy_stub.set_iam_policy request, options do |result, operation|
                 yield result, operation if block_given?
-                return result
               end
             rescue ::Gapic::Rest::Error => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -366,7 +386,6 @@ module Google
 
               @iam_policy_stub.get_iam_policy request, options do |result, operation|
                 yield result, operation if block_given?
-                return result
               end
             rescue ::Gapic::Rest::Error => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -457,7 +476,6 @@ module Google
 
               @iam_policy_stub.test_iam_permissions request, options do |result, operation|
                 yield result, operation if block_given?
-                return result
               end
             rescue ::Gapic::Rest::Error => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -537,6 +555,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
@@ -565,6 +588,7 @@ module Google
               # by the host service.
               # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
               config_attr :bindings_override, {}, ::Hash, nil
+              config_attr :logger, :default, ::Logger, nil, :default
 
               # @private
               def initialize parent_config = nil

data/lib/google/iam/v1/iam_policy/rest/service_stub.rb

@@ -29,7 +29,8 @@ module Google
           # including transcoding, making the REST call, and deserialing the response.
           #
           class ServiceStub
-            def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
+            # @private
+            def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
               # These require statements are intentionally placed here to initialize
               # the REST modules only when it's required.
               require "gapic/rest"
@@ -39,7 +40,9 @@ module Google
                                                            universe_domain: universe_domain,
                                                            credentials: credentials,
                                                            numeric_enums: true,
-                                                           raise_faraday_errors: false
+                                                           service_name: self.class,
+                                                           raise_faraday_errors: false,
+                                                           logger: logger
             end
 
             ##
@@ -60,6 +63,15 @@ module Google
               @client_stub.endpoint
             end
 
+            ##
+            # The logger used for request/response debug logging.
+            #
+            # @return [Logger]
+            #
+            def logger stub: false
+              stub ? @client_stub.stub_logger : @client_stub.logger
+            end
+
             ##
             # Baseline implementation for the set_iam_policy REST call
             #
@@ -86,16 +98,18 @@ module Google
 
               response = @client_stub.make_http_request(
                 verb,
-                uri:     uri,
-                body:    body || "",
-                params:  query_string_params,
+                uri: uri,
+                body: body || "",
+                params: query_string_params,
+                method_name: "set_iam_policy",
                 options: options
               )
               operation = ::Gapic::Rest::TransportOperation.new response
               result = ::Google::Iam::V1::Policy.decode_json response.body, ignore_unknown_fields: true
-
-              yield result, operation if block_given?
-              result
+              catch :response do
+                yield result, operation if block_given?
+                result
+              end
             end
 
             ##
@@ -124,16 +138,18 @@ module Google
 
               response = @client_stub.make_http_request(
                 verb,
-                uri:     uri,
-                body:    body || "",
-                params:  query_string_params,
+                uri: uri,
+                body: body || "",
+                params: query_string_params,
+                method_name: "get_iam_policy",
                 options: options
               )
               operation = ::Gapic::Rest::TransportOperation.new response
               result = ::Google::Iam::V1::Policy.decode_json response.body, ignore_unknown_fields: true
-
-              yield result, operation if block_given?
-              result
+              catch :response do
+                yield result, operation if block_given?
+                result
+              end
             end
 
             ##
@@ -162,16 +178,18 @@ module Google
 
               response = @client_stub.make_http_request(
                 verb,
-                uri:     uri,
-                body:    body || "",
-                params:  query_string_params,
+                uri: uri,
+                body: body || "",
+                params: query_string_params,
+                method_name: "test_iam_permissions",
                 options: options
               )
               operation = ::Gapic::Rest::TransportOperation.new response
               result = ::Google::Iam::V1::TestIamPermissionsResponse.decode_json response.body, ignore_unknown_fields: true
-
-              yield result, operation if block_given?
-              result
+              catch :response do
+                yield result, operation if block_given?
+                result
+              end
             end
 
             ##

data/proto_docs/google/api/client.rb

@@ -306,9 +306,28 @@ module Google
     # @!attribute [rw] common
     #   @return [::Google::Api::CommonLanguageSettings]
     #     Some settings.
+    # @!attribute [rw] renamed_services
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     Map of service names to renamed services. Keys are the package relative
+    #     service names and values are the name to be used for the service client
+    #     and call options.
+    #
+    #     publishing:
+    #       go_settings:
+    #         renamed_services:
+    #           Publisher: TopicAdmin
     class GoSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # @!attribute [rw] key
+      #   @return [::String]
+      # @!attribute [rw] value
+      #   @return [::String]
+      class RenamedServicesEntry
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
     end
 
     # Describes the generator configuration for a method.

data/proto_docs/google/cloud/batch/v1/job.rb

@@ -85,20 +85,27 @@ module Google
           end
         end
 
-        # LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be
-        # preserved.
+        # LogsPolicy describes if and how a job's logs are preserved. Logs include
+        # information that is automatically written by the Batch service agent and any
+        # information that you configured the job's runnables to write to the `stdout`
+        # or `stderr` streams.
         # @!attribute [rw] destination
         #   @return [::Google::Cloud::Batch::V1::LogsPolicy::Destination]
-        #     Where logs should be saved.
+        #     If and where logs should be saved.
         # @!attribute [rw] logs_path
         #   @return [::String]
-        #     The path to which logs are saved when the destination = PATH. This can be a
-        #     local file path on the VM, or under the mount point of a Persistent Disk or
-        #     Filestore, or a Cloud Storage path.
+        #     When `destination` is set to `PATH`, you must set this field to the path
+        #     where you want logs to be saved. This path can point to a local directory
+        #     on the VM or (if congifured) a directory under the mount path of any
+        #     Cloud Storage bucket, network file system (NFS), or writable persistent
+        #     disk that is mounted to the job. For example, if the job has a bucket with
+        #     `mountPath` set to `/mnt/disks/my-bucket`, you can write logs to the
+        #     root directory of the `remotePath` of that bucket by setting this field to
+        #     `/mnt/disks/my-bucket/`.
         # @!attribute [rw] cloud_logging_option
         #   @return [::Google::Cloud::Batch::V1::LogsPolicy::CloudLoggingOption]
-        #     Optional. Additional settings for Cloud Logging. It will only take effect
-        #     when the destination of `LogsPolicy` is set to `CLOUD_LOGGING`.
+        #     Optional. When `destination` is set to `CLOUD_LOGGING`, you can optionally
+        #     set this field to configure additional settings for Cloud Logging.
         class LogsPolicy
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -107,7 +114,7 @@ module Google
           # generated by Batch job.
           # @!attribute [rw] use_generic_task_monitored_resource
           #   @return [::Boolean]
-          #     Optional. Set this flag to true to change the [monitored resource
+          #     Optional. Set this field to `true` to change the [monitored resource
           #     type](https://cloud.google.com/monitoring/api/resources) for
           #     Cloud Logging logs generated by this Batch job from
           #     the
@@ -122,13 +129,14 @@ module Google
 
           # The destination (if any) for logs.
           module Destination
-            # Logs are not preserved.
+            # (Default) Logs are not preserved.
             DESTINATION_UNSPECIFIED = 0
 
-            # Logs are streamed to Cloud Logging.
+            # Logs are streamed to Cloud Logging. Optionally, you can configure
+            # additional settings in the `cloudLoggingOption` field.
             CLOUD_LOGGING = 1
 
-            # Logs are saved to a file path.
+            # Logs are saved to the file path specified in the `logsPath` field.
             PATH = 2
           end
         end
@@ -525,7 +533,8 @@ module Google
           #     Named the field as 'instance_template' instead of 'template' to avoid
           #     C++ keyword conflict.
           #
-          #     Batch only supports global instance templates.
+          #     Batch only supports global instance templates from the same project as
+          #     the job.
           #     You can specify the global instance template as a full or partial URL.
           # @!attribute [rw] install_gpu_drivers
           #   @return [::Boolean]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-batch-v1
 version: !ruby/object:Gem::Version
-  version: 0.19.2
+  version: 0.20.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-04 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
@@ -162,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.5.23
 signing_key: 
 specification_version: 4
 summary: An API to manage the running of Batch resources on Google Cloud Platform.