google-cloud-scheduler-v1 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3178873197895614553a4d03a1aecbd2c52f30dcf23c1d9ec59dc960eb326d93
-  data.tar.gz: f3ac838ee9f50e89a0dae687797deabfe35afdb8897846d316ae7bf7b00e3818
+  metadata.gz: 2b1c2599a11676d19ac74931fee00758a692066ac0042eced26159b6fa363b4f
+  data.tar.gz: 142c0534085682ecc7a420b9a4649cd636653985a3b17ff911aea29ffedef283
 SHA512:
-  metadata.gz: 278e6ef9d07f63d727ecf71dc31955732e1388525328b294299d7947b108fff6236495288a230d0e210432c7aa2c8bb073779eff9fa8f02a189c82cf1bbf43b1
-  data.tar.gz: 1cd0dc222a39343edfd6e709aceecf867e71fc412d0293365b15c401578d65899a9a56bb05f6033dc86309d8bc60ad51e095e4d9fe0cc1c6acb4045648b28e5a
+  metadata.gz: 565ff637c708186726ab95c4a6df4642769b1612431265b5701449a372f58add48e0832769acd6814190cc3ecf01cc05f8305a70a22b37aacdcfc0743c14e261
+  data.tar.gz: 67b0a339c2084a5b5ee3c12e89915941dc133b2e2309c4bb3ad067896aa6c9596b8bc264938a988d4e266c44c9c1cc60095e1a9078d834c5e3e226b4b91e5072

data/README.md

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

@@ -184,14 +184,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
               )
 
+              @cloud_scheduler_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 = @cloud_scheduler_stub.endpoint
                 config.universe_domain = @cloud_scheduler_stub.universe_domain
+                config.logger = @cloud_scheduler_stub.logger if config.respond_to? :logger=
               end
             end
 
@@ -202,6 +214,15 @@ module Google
             #
             attr_reader :location_client
 
+            ##
+            # The logger used for request/response debug logging.
+            #
+            # @return [Logger]
+            #
+            def logger
+              @cloud_scheduler_stub.logger
+            end
+
             # Service calls
 
             ##
@@ -238,11 +259,7 @@ module Google
             #     request the next page of results, page_token must be the value of
             #     {::Google::Cloud::Scheduler::V1::ListJobsResponse#next_page_token next_page_token}
             #     returned from the previous call to
-            #     {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#list_jobs ListJobs}. It is an
-            #     error to switch the value of
-            #     [filter][google.cloud.scheduler.v1.ListJobsRequest.filter] or
-            #     [order_by][google.cloud.scheduler.v1.ListJobsRequest.order_by] while
-            #     iterating through pages.
+            #     {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#list_jobs ListJobs}.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Scheduler::V1::Job>]
@@ -308,7 +325,7 @@ module Google
               @cloud_scheduler_stub.call_rpc :list_jobs, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @cloud_scheduler_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)
@@ -395,7 +412,6 @@ module Google
 
               @cloud_scheduler_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)
@@ -489,7 +505,6 @@ module Google
 
               @cloud_scheduler_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)
@@ -590,7 +605,6 @@ module Google
 
               @cloud_scheduler_stub.call_rpc :update_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)
@@ -677,7 +691,6 @@ module Google
 
               @cloud_scheduler_stub.call_rpc :delete_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)
@@ -773,7 +786,6 @@ module Google
 
               @cloud_scheduler_stub.call_rpc :pause_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)
@@ -868,7 +880,6 @@ module Google
 
               @cloud_scheduler_stub.call_rpc :resume_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)
@@ -958,7 +969,6 @@ module Google
 
               @cloud_scheduler_stub.call_rpc :run_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)
@@ -1008,6 +1018,13 @@ module Google
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials
+            #
+            #   Warning: If you accept a credential configuration (JSON file or Hash) from an
+            #   external source for authentication to Google Cloud, you must validate it before
+            #   providing it to a Google API client library. Providing an unvalidated credential
+            #   configuration to Google APIs can compromise the security of your systems and data.
+            #   For more information, refer to [Validate credential configurations from external
+            #   sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
             #   @return [::Object]
             # @!attribute [rw] scope
             #   The OAuth scopes
@@ -1047,6 +1064,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
@@ -1071,6 +1093,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/scheduler/v1/cloud_scheduler/rest/client.rb

@@ -177,15 +177,27 @@ module Google
                   endpoint: @config.endpoint,
                   endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
                   universe_domain: @config.universe_domain,
-                  credentials: credentials
+                  credentials: credentials,
+                  logger: @config.logger
                 )
 
+                @cloud_scheduler_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 = @cloud_scheduler_stub.endpoint
                   config.universe_domain = @cloud_scheduler_stub.universe_domain
                   config.bindings_override = @config.bindings_override
+                  config.logger = @cloud_scheduler_stub.logger if config.respond_to? :logger=
                 end
               end
 
@@ -196,6 +208,15 @@ module Google
               #
               attr_reader :location_client
 
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger
+                @cloud_scheduler_stub.logger
+              end
+
               # Service calls
 
               ##
@@ -232,11 +253,7 @@ module Google
               #     request the next page of results, page_token must be the value of
               #     {::Google::Cloud::Scheduler::V1::ListJobsResponse#next_page_token next_page_token}
               #     returned from the previous call to
-              #     {::Google::Cloud::Scheduler::V1::CloudScheduler::Rest::Client#list_jobs ListJobs}. It is an
-              #     error to switch the value of
-              #     [filter][google.cloud.scheduler.v1.ListJobsRequest.filter] or
-              #     [order_by][google.cloud.scheduler.v1.ListJobsRequest.order_by] while
-              #     iterating through pages.
+              #     {::Google::Cloud::Scheduler::V1::CloudScheduler::Rest::Client#list_jobs ListJobs}.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Scheduler::V1::Job>]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -295,7 +312,7 @@ module Google
                 @cloud_scheduler_stub.list_jobs request, options do |result, operation|
                   result = ::Gapic::Rest::PagedEnumerable.new @cloud_scheduler_stub, :list_jobs, "jobs", 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)
@@ -375,7 +392,6 @@ module Google
 
                 @cloud_scheduler_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)
@@ -462,7 +478,6 @@ module Google
 
                 @cloud_scheduler_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)
@@ -556,7 +571,6 @@ module Google
 
                 @cloud_scheduler_stub.update_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)
@@ -636,7 +650,6 @@ module Google
 
                 @cloud_scheduler_stub.delete_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)
@@ -725,7 +738,6 @@ module Google
 
                 @cloud_scheduler_stub.pause_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)
@@ -813,7 +825,6 @@ module Google
 
                 @cloud_scheduler_stub.resume_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)
@@ -896,7 +907,6 @@ module Google
 
                 @cloud_scheduler_stub.run_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)
@@ -944,6 +954,13 @@ module Google
               #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
               #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
               #    *  (`nil`) indicating no credentials
+              #
+              #   Warning: If you accept a credential configuration (JSON file or Hash) from an
+              #   external source for authentication to Google Cloud, you must validate it before
+              #   providing it to a Google API client library. Providing an unvalidated credential
+              #   configuration to Google APIs can compromise the security of your systems and data.
+              #   For more information, refer to [Validate credential configurations from external
+              #   sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
               #   @return [::Object]
               # @!attribute [rw] scope
               #   The OAuth scopes
@@ -976,6 +993,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
@@ -1004,6 +1026,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/scheduler/v1/cloud_scheduler/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 list_jobs 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: "list_jobs",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::Scheduler::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
 
               ##
@@ -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::Scheduler::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: "create_job",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::Scheduler::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
 
               ##
@@ -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: "update_job",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::Scheduler::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
 
               ##
@@ -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: "delete_job",
                   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
 
               ##
@@ -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: "pause_job",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::Scheduler::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
 
               ##
@@ -315,16 +339,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: "resume_job",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::Scheduler::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
 
               ##
@@ -353,16 +379,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: "run_job",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::Scheduler::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
 
               ##

data/lib/google/cloud/scheduler/v1/job_pb.rb

@@ -4,6 +4,7 @@
 
 require 'google/protobuf'
 
+require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/scheduler/v1/target_pb'
 require 'google/protobuf/duration_pb'
@@ -11,7 +12,7 @@ require 'google/protobuf/timestamp_pb'
 require 'google/rpc/status_pb'
 
 
-descriptor_data = "\n#google/cloud/scheduler/v1/job.proto\x12\x19google.cloud.scheduler.v1\x1a\x19google/api/resource.proto\x1a&google/cloud/scheduler/v1/target.proto\x1a\x1egoogle/protobuf/duration.proto\x1a\x1fgoogle/protobuf/timestamp.proto\x1a\x17google/rpc/status.proto\"\xcb\x06\n\x03Job\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x02 \x01(\t\x12@\n\rpubsub_target\x18\x04 \x01(\x0b\x32\'.google.cloud.scheduler.v1.PubsubTargetH\x00\x12P\n\x16\x61pp_engine_http_target\x18\x05 \x01(\x0b\x32..google.cloud.scheduler.v1.AppEngineHttpTargetH\x00\x12<\n\x0bhttp_target\x18\x06 \x01(\x0b\x32%.google.cloud.scheduler.v1.HttpTargetH\x00\x12\x10\n\x08schedule\x18\x14 \x01(\t\x12\x11\n\ttime_zone\x18\x15 \x01(\t\x12\x34\n\x10user_update_time\x18\t \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x33\n\x05state\x18\n \x01(\x0e\x32$.google.cloud.scheduler.v1.Job.State\x12\"\n\x06status\x18\x0b \x01(\x0b\x32\x12.google.rpc.Status\x12\x31\n\rschedule_time\x18\x11 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x35\n\x11last_attempt_time\x18\x12 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12<\n\x0cretry_config\x18\x13 \x01(\x0b\x32&.google.cloud.scheduler.v1.RetryConfig\x12\x33\n\x10\x61ttempt_deadline\x18\x16 \x01(\x0b\x32\x19.google.protobuf.Duration\"X\n\x05State\x12\x15\n\x11STATE_UNSPECIFIED\x10\x00\x12\x0b\n\x07\x45NABLED\x10\x01\x12\n\n\x06PAUSED\x10\x02\x12\x0c\n\x08\x44ISABLED\x10\x03\x12\x11\n\rUPDATE_FAILED\x10\x04:Z\xea\x41W\n!cloudscheduler.googleapis.com/Job\x12\x32projects/{project}/locations/{location}/jobs/{job}B\x08\n\x06target\"\xe2\x01\n\x0bRetryConfig\x12\x13\n\x0bretry_count\x18\x01 \x01(\x05\x12\x35\n\x12max_retry_duration\x18\x02 \x01(\x0b\x32\x19.google.protobuf.Duration\x12\x37\n\x14min_backoff_duration\x18\x03 \x01(\x0b\x32\x19.google.protobuf.Duration\x12\x37\n\x14max_backoff_duration\x18\x04 \x01(\x0b\x32\x19.google.protobuf.Duration\x12\x15\n\rmax_doublings\x18\x05 \x01(\x05\x42h\n\x1d\x63om.google.cloud.scheduler.v1B\x08JobProtoP\x01Z;cloud.google.com/go/scheduler/apiv1/schedulerpb;schedulerpbb\x06proto3"
+descriptor_data = "\n#google/cloud/scheduler/v1/job.proto\x12\x19google.cloud.scheduler.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a&google/cloud/scheduler/v1/target.proto\x1a\x1egoogle/protobuf/duration.proto\x1a\x1fgoogle/protobuf/timestamp.proto\x1a\x17google/rpc/status.proto\"\xef\x06\n\x03Job\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x13\n\x0b\x64\x65scription\x18\x02 \x01(\t\x12@\n\rpubsub_target\x18\x04 \x01(\x0b\x32\'.google.cloud.scheduler.v1.PubsubTargetH\x00\x12P\n\x16\x61pp_engine_http_target\x18\x05 \x01(\x0b\x32..google.cloud.scheduler.v1.AppEngineHttpTargetH\x00\x12<\n\x0bhttp_target\x18\x06 \x01(\x0b\x32%.google.cloud.scheduler.v1.HttpTargetH\x00\x12\x10\n\x08schedule\x18\x14 \x01(\t\x12\x11\n\ttime_zone\x18\x15 \x01(\t\x12\x39\n\x10user_update_time\x18\t \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12\x38\n\x05state\x18\n \x01(\x0e\x32$.google.cloud.scheduler.v1.Job.StateB\x03\xe0\x41\x03\x12\'\n\x06status\x18\x0b \x01(\x0b\x32\x12.google.rpc.StatusB\x03\xe0\x41\x03\x12\x36\n\rschedule_time\x18\x11 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12:\n\x11last_attempt_time\x18\x12 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12<\n\x0cretry_config\x18\x13 \x01(\x0b\x32&.google.cloud.scheduler.v1.RetryConfig\x12\x33\n\x10\x61ttempt_deadline\x18\x16 \x01(\x0b\x32\x19.google.protobuf.Duration\"X\n\x05State\x12\x15\n\x11STATE_UNSPECIFIED\x10\x00\x12\x0b\n\x07\x45NABLED\x10\x01\x12\n\n\x06PAUSED\x10\x02\x12\x0c\n\x08\x44ISABLED\x10\x03\x12\x11\n\rUPDATE_FAILED\x10\x04:e\xea\x41\x62\n!cloudscheduler.googleapis.com/Job\x12\x32projects/{project}/locations/{location}/jobs/{job}*\x04jobs2\x03jobB\x08\n\x06target\"\xe2\x01\n\x0bRetryConfig\x12\x13\n\x0bretry_count\x18\x01 \x01(\x05\x12\x35\n\x12max_retry_duration\x18\x02 \x01(\x0b\x32\x19.google.protobuf.Duration\x12\x37\n\x14min_backoff_duration\x18\x03 \x01(\x0b\x32\x19.google.protobuf.Duration\x12\x37\n\x14max_backoff_duration\x18\x04 \x01(\x0b\x32\x19.google.protobuf.Duration\x12\x15\n\rmax_doublings\x18\x05 \x01(\x05\x42h\n\x1d\x63om.google.cloud.scheduler.v1B\x08JobProtoP\x01Z;cloud.google.com/go/scheduler/apiv1/schedulerpb;schedulerpbb\x06proto3"
 
 pool = Google::Protobuf::DescriptorPool.generated_pool
 

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Scheduler
       module V1
-        VERSION = "1.0.1"
+        VERSION = "1.2.0"
       end
     end
   end

data/proto_docs/google/api/client.rb

@@ -28,6 +28,9 @@ module Google
     # @!attribute [rw] destinations
     #   @return [::Array<::Google::Api::ClientLibraryDestination>]
     #     The destination where API teams want this client library to be published.
+    # @!attribute [rw] selective_gapic_generation
+    #   @return [::Google::Api::SelectiveGapicGeneration]
+    #     Configuration for which RPCs should be generated in the GAPIC client.
     class CommonLanguageSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -212,6 +215,12 @@ module Google
       #     enabled. By default, asynchronous REST clients will not be generated.
       #     This feature will be enabled by default 1 month after launching the
       #     feature in preview packages.
+      # @!attribute [rw] protobuf_pythonic_types_enabled
+      #   @return [::Boolean]
+      #     Enables generation of protobuf code using new types that are more
+      #     Pythonic which are included in `protobuf>=5.29.x`. This feature will be
+      #     enabled by default 1 month after launching the feature in preview
+      #     packages.
       class ExperimentalFeatures
         include ::Google::Protobuf::MessageExts
         extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -297,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.
@@ -375,6 +403,17 @@ module Google
       end
     end
 
+    # This message is used to configure the generation of a subset of the RPCs in
+    # a service for client libraries.
+    # @!attribute [rw] methods
+    #   @return [::Array<::String>]
+    #     An allowlist of the fully qualified names of RPCs that should be included
+    #     on public client surfaces.
+    class SelectiveGapicGeneration
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
     # The organization for which the client libraries are being published.
     # Affects the url where generated docs are published, etc.
     module ClientLibraryOrganization

data/proto_docs/google/cloud/scheduler/v1/cloudscheduler.rb

@@ -42,11 +42,7 @@ module Google
         #     request the next page of results, page_token must be the value of
         #     {::Google::Cloud::Scheduler::V1::ListJobsResponse#next_page_token next_page_token}
         #     returned from the previous call to
-        #     {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#list_jobs ListJobs}. It is an
-        #     error to switch the value of
-        #     [filter][google.cloud.scheduler.v1.ListJobsRequest.filter] or
-        #     [order_by][google.cloud.scheduler.v1.ListJobsRequest.order_by] while
-        #     iterating through pages.
+        #     {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#list_jobs ListJobs}.
         class ListJobsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -54,12 +54,18 @@ module Google
         # @!attribute [rw] pubsub_target
         #   @return [::Google::Cloud::Scheduler::V1::PubsubTarget]
         #     Pub/Sub target.
+        #
+        #     Note: The following fields are mutually exclusive: `pubsub_target`, `app_engine_http_target`, `http_target`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] app_engine_http_target
         #   @return [::Google::Cloud::Scheduler::V1::AppEngineHttpTarget]
         #     App Engine HTTP target.
+        #
+        #     Note: The following fields are mutually exclusive: `app_engine_http_target`, `pubsub_target`, `http_target`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] http_target
         #   @return [::Google::Cloud::Scheduler::V1::HttpTarget]
         #     HTTP target.
+        #
+        #     Note: The following fields are mutually exclusive: `http_target`, `pubsub_target`, `app_engine_http_target`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] schedule
         #   @return [::String]
         #     Required, except when used with
@@ -85,7 +91,11 @@ module Google
         #     If {::Google::Cloud::Scheduler::V1::RetryConfig#retry_count retry_count} > 0 and
         #     a job attempt fails, the job will be tried a total of
         #     {::Google::Cloud::Scheduler::V1::RetryConfig#retry_count retry_count} times,
-        #     with exponential backoff, until the next scheduled start time.
+        #     with exponential backoff, until the next scheduled start time. If
+        #     retry_count is 0, a job attempt will not be retried if it fails. Instead
+        #     the Cloud Scheduler system will wait for the next scheduled execution time.
+        #     Setting retry_count to 0 does not prevent failed jobs from running
+        #     according to schedule after the failure.
         # @!attribute [rw] time_zone
         #   @return [::String]
         #     Specifies the time zone to be used in interpreting
@@ -98,21 +108,21 @@ module Google
         #     determined by the chosen tz. For UTC use the string "utc". If a
         #     time zone is not specified, the default will be in UTC (also known
         #     as GMT).
-        # @!attribute [rw] user_update_time
+        # @!attribute [r] user_update_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. The creation time of the job.
-        # @!attribute [rw] state
+        # @!attribute [r] state
         #   @return [::Google::Cloud::Scheduler::V1::Job::State]
         #     Output only. State of the job.
-        # @!attribute [rw] status
+        # @!attribute [r] status
         #   @return [::Google::Rpc::Status]
         #     Output only. The response from the target for the last attempted execution.
-        # @!attribute [rw] schedule_time
+        # @!attribute [r] schedule_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. The next time the job is scheduled. Note that this may be a
         #     retry of a previously failed attempt or the next execution time
         #     according to the schedule.
-        # @!attribute [rw] last_attempt_time
+        # @!attribute [r] last_attempt_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. The time the last job attempt started.
         # @!attribute [rw] retry_config
@@ -186,9 +196,10 @@ module Google
         #
         #     The default value of retry_count is zero.
         #
-        #     If retry_count is zero, a job attempt will *not* be retried if
+        #     If retry_count is 0, a job attempt will not be retried if
         #     it fails. Instead the Cloud Scheduler system will wait for the
-        #     next scheduled execution time.
+        #     next scheduled execution time. Setting retry_count to 0 does not prevent
+        #     failed jobs from running according to schedule after the failure.
         #
         #     If retry_count is set to a non-zero number then Cloud Scheduler
         #     will retry failed attempts, using exponential backoff,
@@ -233,7 +244,7 @@ module Google
         #     {::Google::Cloud::Scheduler::V1::RetryConfig#min_backoff_duration min_backoff_duration}
         #     is 10s,
         #     {::Google::Cloud::Scheduler::V1::RetryConfig#max_backoff_duration max_backoff_duration}
-        #     is 300s, and `max_doublings` is 3, then the a job will first be retried in
+        #     is 300s, and `max_doublings` is 3, then the job will first be retried in
         #     10s. The retry interval will double three times, and then increase linearly
         #     by 2^3 * 10s.  Finally, the job will retry at intervals of
         #     {::Google::Cloud::Scheduler::V1::RetryConfig#max_backoff_duration max_backoff_duration}

data/proto_docs/google/cloud/scheduler/v1/target.rb

@@ -41,14 +41,20 @@ module Google
         #     Which HTTP method to use for the request.
         # @!attribute [rw] headers
         #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     HTTP request headers.
+        #
+        #     This map contains the header field names and values.
+        #
         #     The user can specify HTTP request headers to send with the job's
-        #     HTTP request. This map contains the header field names and
-        #     values. Repeated headers are not supported, but a header value can
-        #     contain commas. These headers represent a subset of the headers
-        #     that will accompany the job's HTTP request. Some HTTP request
-        #     headers will be ignored or replaced. A partial list of headers that
-        #     will be ignored or replaced is below:
-        #     - Host: This will be computed by Cloud Scheduler and derived from
+        #     HTTP request. Repeated headers are not supported, but a header value can
+        #     contain commas.
+        #
+        #     The following headers represent a subset of the headers
+        #     that accompany the job's HTTP request. Some HTTP request
+        #     headers are ignored or replaced. A partial list of headers that
+        #     are ignored or replaced is below:
+        #
+        #     * Host: This will be computed by Cloud Scheduler and derived from
         #     {::Google::Cloud::Scheduler::V1::HttpTarget#uri uri}.
         #     * `Content-Length`: This will be computed by Cloud Scheduler.
         #     * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.
@@ -60,6 +66,15 @@ module Google
         #     the unix-cron format, this header will contain the job schedule as an
         #     offset of UTC parsed according to RFC3339.
         #
+        #     If the job has a {::Google::Cloud::Scheduler::V1::HttpTarget#body body} and the
+        #     following headers are not set by the user, Cloud Scheduler sets default
+        #     values:
+        #
+        #     * `Content-Type`: This will be set to `"application/octet-stream"`. You
+        #       can override this default by explicitly setting `Content-Type` to a
+        #       particular media type when creating the job. For example, you can set
+        #       `Content-Type` to `"application/json"`.
+        #
         #     The total size of headers must be less than 80KB.
         # @!attribute [rw] body
         #   @return [::String]
@@ -75,6 +90,8 @@ module Google
         #
         #     This type of authorization should generally only be used when calling
         #     Google APIs hosted on *.googleapis.com.
+        #
+        #     Note: The following fields are mutually exclusive: `oauth_token`, `oidc_token`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] oidc_token
         #   @return [::Google::Cloud::Scheduler::V1::OidcToken]
         #     If specified, an
@@ -85,6 +102,8 @@ module Google
         #     This type of authorization can be used for many scenarios, including
         #     calling Cloud Run, or endpoints where you intend to validate the token
         #     yourself.
+        #
+        #     Note: The following fields are mutually exclusive: `oidc_token`, `oauth_token`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class HttpTarget
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -144,20 +163,18 @@ module Google
         #     the unix-cron format, this header will contain the job schedule as an
         #     offset of UTC parsed according to RFC3339.
         #
-        #     If the job has an
-        #     {::Google::Cloud::Scheduler::V1::AppEngineHttpTarget#body body}, Cloud Scheduler
-        #     sets the following headers:
+        #     If the job has a {::Google::Cloud::Scheduler::V1::AppEngineHttpTarget#body body}
+        #     and the following headers are not set by the user, Cloud Scheduler sets
+        #     default values:
         #
-        #     * `Content-Type`: By default, the `Content-Type` header is set to
-        #       `"application/octet-stream"`. The default can be overridden by explictly
-        #       setting `Content-Type` to a particular media type when the job is
-        #       created.
-        #       For example, `Content-Type` can be set to `"application/json"`.
-        #     * `Content-Length`: This is computed by Cloud Scheduler. This value is
-        #       output only. It cannot be changed.
+        #     * `Content-Type`: This will be set to `"application/octet-stream"`. You
+        #       can override this default by explicitly setting `Content-Type` to a
+        #       particular media type when creating the job. For example, you can set
+        #       `Content-Type` to `"application/json"`.
         #
         #     The headers below are output only. They cannot be set or overridden:
         #
+        #     * `Content-Length`: This is computed by Cloud Scheduler.
         #     * `X-Google-*`: For Google internal use only.
         #     * `X-AppEngine-*`: For Google internal use only.
         #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-scheduler-v1
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-30 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +15,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.25.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +25,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.25.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -115,7 +114,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -123,15 +121,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: Creates and manages jobs run on a regular recurring schedule.
 test_files: []