google-apis-cloudscheduler_v1 0.40.0 → 0.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ce848a7000e62214892708a31d4ba4cb1acd9a471b4500a1ac270deafe7f633
-  data.tar.gz: '0177940868e9c0950c668dc5bd279edd7eaa3438230a32b4c87d2785b0424754'
+  metadata.gz: fb9e415b1f1b1efa8daf6b3019def90e25cb8c5a813f7bbe56dbdd3a621178df
+  data.tar.gz: 377f8862451173f673dc7b2960fbb3573252a1689d0545b835c6fd962f59b8ef
 SHA512:
-  metadata.gz: c143b04971811cc14e589e9352cc7953edfa308c9d38f476f18b6f4fc63891396677c1bffba9a61cb7721b360ea26626e6ce4db772bb7f1a7a7908ffd9f0acbb
-  data.tar.gz: bf11e853a48aff73e667fbd82918aa94ed662588e52d7ced26304a6fb82cee9fd21a8f2ab73e1461d87c82560829bcb42ab0401eee8a695a4f7cf089754f8f09
+  metadata.gz: a4050bb363f673c85cd615ce1349331408b4f120fcb5401d6f0b9ea904f3956f19aad57ae612e67d2af09588e0d813392b4124fee209cd075152a32a233f2f34
+  data.tar.gz: df6c7e8839cafec633c2f3403c0b9e5f405eb74f6c986f0f60ab27b1d80bb687dddd5aa1e295806828049e7d7ac2d5234c25effdc1800a65e81aec6b2455cebc

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-cloudscheduler_v1
 
+### v0.42.0 (2025-11-02)
+
+* Regenerated from discovery document revision 20251022
+
+### v0.41.0 (2025-10-05)
+
+* Regenerated from discovery document revision 20250925
+
 ### v0.40.0 (2025-09-28)
 
 * Regenerated from discovery document revision 20250917

data/lib/google/apis/cloudscheduler_v1/classes.rb

@@ -190,6 +190,36 @@ module Google
         end
       end
       
+      # Describes the project/location configuration of Cloud Scheduler Resources.
+      class CmekConfig
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/
+        # locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be
+        # used to encrypt Jobs in the region. Setting this as blank will turn off CMEK
+        # encryption.
+        # Corresponds to the JSON property `kmsKeyName`
+        # @return [String]
+        attr_accessor :kms_key_name
+      
+        # Identifier. The config resource name which includes the project and location
+        # and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/
+        # LOCATION_ID/cmekConfig`
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
+          @name = args[:name] if args.key?(:name)
+        end
+      end
+      
       # A generic empty message that you can re-use to avoid defining duplicated empty
       # messages in your APIs. A typical example is to use it as the request or the
       # response type of an API method. For instance: service Foo ` rpc Bar(google.
@@ -344,12 +374,13 @@ module Google
         # The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/
         # JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
         # hyphens (-), colons (:), or periods (.). For more information, see [
-        # Identifying projects](https://cloud.google.com/resource-manager/docs/creating-
-        # managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID
-        # for the job's location. The list of available locations can be obtained by
-        # calling ListLocations. For more information, see https://cloud.google.com/
-        # about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-
-        # 9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+        # Identifying projects](/resource-manager/docs/creating-managing-projects#
+        # identifying_projects) * `LOCATION_ID` is the canonical ID for the job's
+        # location. The list of available locations can be obtained by calling [
+        # locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list).
+        # For more information, see [Cloud Scheduler locations](/scheduler/docs/
+        # locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+        # hyphens (-), or underscores (_). The maximum length is 500 characters.
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
@@ -361,10 +392,10 @@ module Google
         attr_accessor :pubsub_target
       
         # Settings that determine the retry behavior. For more information, see [Retry
-        # jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By
-        # default, if a job does not complete successfully (meaning that an
-        # acknowledgement is not received from the handler, then it will be retried with
-        # exponential backoff according to the settings in RetryConfig.
+        # jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not
+        # complete successfully (meaning that an acknowledgement is not received from
+        # the handler, then it will be retried with exponential backoff according to the
+        # settings in RetryConfig.
         # Corresponds to the JSON property `retryConfig`
         # @return [Google::Apis::CloudschedulerV1::RetryConfig]
         attr_accessor :retry_config
@@ -379,19 +410,19 @@ module Google
         # Required, except when used with UpdateJob. Describes the schedule on which the
         # job will be executed. The schedule can be either of the following types: * [
         # Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule]
-        # (https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a
-        # general rule, execution `n + 1` of a job will not begin until execution `n`
-        # has finished. Cloud Scheduler will never allow two simultaneously outstanding
-        # executions. For example, this implies that if the `n+1`th execution is
-        # scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`
-        # th execution will not start until `16:15`. A scheduled start time will be
-        # delayed if the previous execution has not ended when its scheduled time occurs.
-        # If retry_count > 0 and a job attempt fails, the job will be tried a total of
-        # retry_count times, 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.
+        # (/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `
+        # n + 1` of a job will not begin until execution `n` has finished. Cloud
+        # Scheduler will never allow two simultaneously outstanding executions. For
+        # example, this implies that if the `n+1`th execution is scheduled to run at 16:
+        # 00 but the `n`th execution takes until 16:15, the `n+1`th execution will not
+        # start until `16:15`. A scheduled start time will be delayed if the previous
+        # execution has not ended when its scheduled time occurs. If retry_count > 0 and
+        # a job attempt fails, the job will be tried a total of retry_count times, 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.
         # Corresponds to the JSON property `schedule`
         # @return [String]
         attr_accessor :schedule
@@ -524,6 +555,13 @@ module Google
         # @return [Array<Google::Apis::CloudschedulerV1::Operation>]
         attr_accessor :operations
       
+        # Unordered list. Unreachable resources. Populated when the request sets `
+        # ListOperationsRequest.return_partial_success` and reads across collections e.g.
+        # when attempting to list all resources across all supported locations.
+        # Corresponds to the JSON property `unreachable`
+        # @return [Array<String>]
+        attr_accessor :unreachable
+      
         def initialize(**args)
            update!(**args)
         end
@@ -532,6 +570,7 @@ module Google
         def update!(**args)
           @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
           @operations = args[:operations] if args.key?(:operations)
+          @unreachable = args[:unreachable] if args.key?(:unreachable)
         end
       end
       
@@ -897,10 +936,10 @@ module Google
       end
       
       # Settings that determine the retry behavior. For more information, see [Retry
-      # jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By
-      # default, if a job does not complete successfully (meaning that an
-      # acknowledgement is not received from the handler, then it will be retried with
-      # exponential backoff according to the settings in RetryConfig.
+      # jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not
+      # complete successfully (meaning that an acknowledgement is not received from
+      # the handler, then it will be retried with exponential backoff according to the
+      # settings in RetryConfig.
       class RetryConfig
         include Google::Apis::Core::Hashable
       
@@ -913,9 +952,9 @@ module Google
         # The time between retries will double `max_doublings` times. A job's retry
         # interval starts at min_backoff_duration, then doubles `max_doublings` times,
         # then increases linearly, and finally retries at intervals of
-        # max_backoff_duration up to retry_count times. For examples, see [Retry jobs](
-        # https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings).
-        # The default value of this field is 5.
+        # max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/
+        # scheduler/docs/configuring/retry-jobs#max-doublings). The default value of
+        # this field is 5.
         # Corresponds to the JSON property `maxDoublings`
         # @return [Fixnum]
         attr_accessor :max_doublings

data/lib/google/apis/cloudscheduler_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module CloudschedulerV1
       # Version of the google-apis-cloudscheduler_v1 gem
-      GEM_VERSION = "0.40.0"
+      GEM_VERSION = "0.42.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.18.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20250917"
+      REVISION = "20251022"
     end
   end
 end

data/lib/google/apis/cloudscheduler_v1/representations.rb

@@ -40,6 +40,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class CmekConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Empty
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -176,6 +182,14 @@ module Google
         end
       end
       
+      class CmekConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :kms_key_name, as: 'kmsKeyName'
+          property :name, as: 'name'
+        end
+      end
+      
       class Empty
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -246,6 +260,7 @@ module Google
           property :next_page_token, as: 'nextPageToken'
           collection :operations, as: 'operations', class: Google::Apis::CloudschedulerV1::Operation, decorator: Google::Apis::CloudschedulerV1::Operation::Representation
       
+          collection :unreachable, as: 'unreachable'
         end
       end
       

data/lib/google/apis/cloudscheduler_v1/service.rb

@@ -81,12 +81,43 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Gets the Scheduler config in the project/region.
+        # @param [String] name
+        #   Required. The config name. For example: projects/PROJECT_ID/locations/
+        #   LOCATION_ID/cmekConfig
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::CloudschedulerV1::CmekConfig] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::CloudschedulerV1::CmekConfig]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_project_location_cmek_config(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1/{+name}', options)
+          command.response_representation = Google::Apis::CloudschedulerV1::CmekConfig::Representation
+          command.response_class = Google::Apis::CloudschedulerV1::CmekConfig
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Lists information about the supported locations for this service.
         # @param [String] name
         #   The resource that owns the locations collection, if applicable.
         # @param [Array<String>, String] extra_location_types
-        #   Optional. Unless explicitly documented otherwise, don't use this unsupported
-        #   field which is primarily intended for internal usage.
+        #   Optional. Do not use this field. It is unsupported and is ignored unless
+        #   explicitly documented otherwise. This is primarily for internal usage.
         # @param [String] filter
         #   A filter to narrow down results to a preferred subset. The filtering language
         #   accepts strings like `"displayName=tokyo"`, and is documented in more detail
@@ -128,6 +159,44 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Initializes or Updates the a scheduler config.
+        # @param [String] name
+        #   Identifier. The config resource name which includes the project and location
+        #   and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/
+        #   LOCATION_ID/cmekConfig`
+        # @param [Google::Apis::CloudschedulerV1::CmekConfig] cmek_config_object
+        # @param [String] update_mask
+        #   Optional. List of fields to be updated in this request.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::CloudschedulerV1::Operation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::CloudschedulerV1::Operation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def update_project_location_cmek_config(name, cmek_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'v1/{+name}', options)
+          command.request_representation = Google::Apis::CloudschedulerV1::CmekConfig::Representation
+          command.request_object = cmek_config_object
+          command.response_representation = Google::Apis::CloudschedulerV1::Operation::Representation
+          command.response_class = Google::Apis::CloudschedulerV1::Operation
+          command.params['name'] = name unless name.nil?
+          command.query['updateMask'] = update_mask unless update_mask.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Creates a job.
         # @param [String] parent
         #   Required. The location name. For example: `projects/PROJECT_ID/locations/
@@ -276,12 +345,13 @@ module Google
         #   The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/
         #   JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
         #   hyphens (-), colons (:), or periods (.). For more information, see [
-        #   Identifying projects](https://cloud.google.com/resource-manager/docs/creating-
-        #   managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID
-        #   for the job's location. The list of available locations can be obtained by
-        #   calling ListLocations. For more information, see https://cloud.google.com/
-        #   about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-
-        #   9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+        #   Identifying projects](/resource-manager/docs/creating-managing-projects#
+        #   identifying_projects) * `LOCATION_ID` is the canonical ID for the job's
+        #   location. The list of available locations can be obtained by calling [
+        #   locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list).
+        #   For more information, see [Cloud Scheduler locations](/scheduler/docs/
+        #   locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
+        #   hyphens (-), or underscores (_). The maximum length is 500 characters.
         # @param [Google::Apis::CloudschedulerV1::Job] job_object
         # @param [String] update_mask
         #   A mask used to specify which fields of the job are being updated.
@@ -537,6 +607,13 @@ module Google
         #   The standard list page size.
         # @param [String] page_token
         #   The standard list page token.
+        # @param [Boolean] return_partial_success
+        #   When set to `true`, operations that are reachable are returned as normal, and
+        #   those that are unreachable are returned in the [ListOperationsResponse.
+        #   unreachable] field. This can only be `true` when reading across collections e.
+        #   g. when `parent` is set to `"projects/example/locations/-"`. This field is not
+        #   by default supported and will result in an `UNIMPLEMENTED` error if set unless
+        #   explicitly documented otherwise in service or product specific documentation.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -554,7 +631,7 @@ module Google
         # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
         # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
         # @raise [Google::Apis::AuthorizationError] Authorization is required
-        def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+        def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, return_partial_success: nil, fields: nil, quota_user: nil, options: nil, &block)
           command = make_simple_command(:get, 'v1/{+name}/operations', options)
           command.response_representation = Google::Apis::CloudschedulerV1::ListOperationsResponse::Representation
           command.response_class = Google::Apis::CloudschedulerV1::ListOperationsResponse
@@ -562,6 +639,7 @@ module Google
           command.query['filter'] = filter unless filter.nil?
           command.query['pageSize'] = page_size unless page_size.nil?
           command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['returnPartialSuccess'] = return_partial_success unless return_partial_success.nil?
           command.query['fields'] = fields unless fields.nil?
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-cloudscheduler_v1
 version: !ruby/object:Gem::Version
-  version: 0.40.0
+  version: 0.42.0
 platform: ruby
 authors:
 - Google LLC
@@ -57,7 +57,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-cloudscheduler_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-cloudscheduler_v1/v0.40.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-cloudscheduler_v1/v0.42.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-cloudscheduler_v1
 rdoc_options: []
 require_paths: