google-apis-cloudscheduler_v1 0.41.0 → 0.42.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 42f1c32afa1bc53fdb3cc9504e909c86879baa88f9f248621688f9857aaddde3
4
- data.tar.gz: 00752a5234a378fdb274adc84c3a7ce200602351e4710bb063fe3802deaeffe4
3
+ metadata.gz: fb9e415b1f1b1efa8daf6b3019def90e25cb8c5a813f7bbe56dbdd3a621178df
4
+ data.tar.gz: 377f8862451173f673dc7b2960fbb3573252a1689d0545b835c6fd962f59b8ef
5
5
  SHA512:
6
- metadata.gz: ea74ac8dd1aa3249c1602bdc0a300560c73ce347e09c84fff47f819b90d27d1846e94acf44ed7db2862eccb9e34e5c080e8689e0ce48da843193b40eaf6063cc
7
- data.tar.gz: 0dba18a6a9b8db14bf99c6a08d42f5d6a37998067e0bc284016cbe102e1cc45fc6f97c2da7bfc95accda4968f2301fa556fc9241db0ed320f9a08388c4ee8659
6
+ metadata.gz: a4050bb363f673c85cd615ce1349331408b4f120fcb5401d6f0b9ea904f3956f19aad57ae612e67d2af09588e0d813392b4124fee209cd075152a32a233f2f34
7
+ data.tar.gz: df6c7e8839cafec633c2f3403c0b9e5f405eb74f6c986f0f60ab27b1d80bb687dddd5aa1e295806828049e7d7ac2d5234c25effdc1800a65e81aec6b2455cebc
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-cloudscheduler_v1
2
2
 
3
+ ### v0.42.0 (2025-11-02)
4
+
5
+ * Regenerated from discovery document revision 20251022
6
+
3
7
  ### v0.41.0 (2025-10-05)
4
8
 
5
9
  * Regenerated from discovery document revision 20250925
@@ -190,6 +190,36 @@ module Google
190
190
  end
191
191
  end
192
192
 
193
+ # Describes the project/location configuration of Cloud Scheduler Resources.
194
+ class CmekConfig
195
+ include Google::Apis::Core::Hashable
196
+
197
+ # Optional. Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/
198
+ # locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be
199
+ # used to encrypt Jobs in the region. Setting this as blank will turn off CMEK
200
+ # encryption.
201
+ # Corresponds to the JSON property `kmsKeyName`
202
+ # @return [String]
203
+ attr_accessor :kms_key_name
204
+
205
+ # Identifier. The config resource name which includes the project and location
206
+ # and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/
207
+ # LOCATION_ID/cmekConfig`
208
+ # Corresponds to the JSON property `name`
209
+ # @return [String]
210
+ attr_accessor :name
211
+
212
+ def initialize(**args)
213
+ update!(**args)
214
+ end
215
+
216
+ # Update properties of this object
217
+ def update!(**args)
218
+ @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
219
+ @name = args[:name] if args.key?(:name)
220
+ end
221
+ end
222
+
193
223
  # A generic empty message that you can re-use to avoid defining duplicated empty
194
224
  # messages in your APIs. A typical example is to use it as the request or the
195
225
  # response type of an API method. For instance: service Foo ` rpc Bar(google.
@@ -344,12 +374,13 @@ module Google
344
374
  # The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/
345
375
  # JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
346
376
  # hyphens (-), colons (:), or periods (.). For more information, see [
347
- # Identifying projects](https://cloud.google.com/resource-manager/docs/creating-
348
- # managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID
349
- # for the job's location. The list of available locations can be obtained by
350
- # calling ListLocations. For more information, see https://cloud.google.com/
351
- # about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-
352
- # 9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
377
+ # Identifying projects](/resource-manager/docs/creating-managing-projects#
378
+ # identifying_projects) * `LOCATION_ID` is the canonical ID for the job's
379
+ # location. The list of available locations can be obtained by calling [
380
+ # locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list).
381
+ # For more information, see [Cloud Scheduler locations](/scheduler/docs/
382
+ # locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
383
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
353
384
  # Corresponds to the JSON property `name`
354
385
  # @return [String]
355
386
  attr_accessor :name
@@ -361,10 +392,10 @@ module Google
361
392
  attr_accessor :pubsub_target
362
393
 
363
394
  # Settings that determine the retry behavior. For more information, see [Retry
364
- # jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By
365
- # default, if a job does not complete successfully (meaning that an
366
- # acknowledgement is not received from the handler, then it will be retried with
367
- # exponential backoff according to the settings in RetryConfig.
395
+ # jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not
396
+ # complete successfully (meaning that an acknowledgement is not received from
397
+ # the handler, then it will be retried with exponential backoff according to the
398
+ # settings in RetryConfig.
368
399
  # Corresponds to the JSON property `retryConfig`
369
400
  # @return [Google::Apis::CloudschedulerV1::RetryConfig]
370
401
  attr_accessor :retry_config
@@ -379,19 +410,19 @@ module Google
379
410
  # Required, except when used with UpdateJob. Describes the schedule on which the
380
411
  # job will be executed. The schedule can be either of the following types: * [
381
412
  # Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule]
382
- # (https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a
383
- # general rule, execution `n + 1` of a job will not begin until execution `n`
384
- # has finished. Cloud Scheduler will never allow two simultaneously outstanding
385
- # executions. For example, this implies that if the `n+1`th execution is
386
- # scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`
387
- # th execution will not start until `16:15`. A scheduled start time will be
388
- # delayed if the previous execution has not ended when its scheduled time occurs.
389
- # If retry_count > 0 and a job attempt fails, the job will be tried a total of
390
- # retry_count times, with exponential backoff, until the next scheduled start
391
- # time. If retry_count is 0, a job attempt will not be retried if it fails.
392
- # Instead the Cloud Scheduler system will wait for the next scheduled execution
393
- # time. Setting retry_count to 0 does not prevent failed jobs from running
394
- # according to schedule after the failure.
413
+ # (/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `
414
+ # n + 1` of a job will not begin until execution `n` has finished. Cloud
415
+ # Scheduler will never allow two simultaneously outstanding executions. For
416
+ # example, this implies that if the `n+1`th execution is scheduled to run at 16:
417
+ # 00 but the `n`th execution takes until 16:15, the `n+1`th execution will not
418
+ # start until `16:15`. A scheduled start time will be delayed if the previous
419
+ # execution has not ended when its scheduled time occurs. If retry_count > 0 and
420
+ # a job attempt fails, the job will be tried a total of retry_count times, with
421
+ # exponential backoff, until the next scheduled start time. If retry_count is 0,
422
+ # a job attempt will not be retried if it fails. Instead the Cloud Scheduler
423
+ # system will wait for the next scheduled execution time. Setting retry_count to
424
+ # 0 does not prevent failed jobs from running according to schedule after the
425
+ # failure.
395
426
  # Corresponds to the JSON property `schedule`
396
427
  # @return [String]
397
428
  attr_accessor :schedule
@@ -905,10 +936,10 @@ module Google
905
936
  end
906
937
 
907
938
  # Settings that determine the retry behavior. For more information, see [Retry
908
- # jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By
909
- # default, if a job does not complete successfully (meaning that an
910
- # acknowledgement is not received from the handler, then it will be retried with
911
- # exponential backoff according to the settings in RetryConfig.
939
+ # jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not
940
+ # complete successfully (meaning that an acknowledgement is not received from
941
+ # the handler, then it will be retried with exponential backoff according to the
942
+ # settings in RetryConfig.
912
943
  class RetryConfig
913
944
  include Google::Apis::Core::Hashable
914
945
 
@@ -921,9 +952,9 @@ module Google
921
952
  # The time between retries will double `max_doublings` times. A job's retry
922
953
  # interval starts at min_backoff_duration, then doubles `max_doublings` times,
923
954
  # then increases linearly, and finally retries at intervals of
924
- # max_backoff_duration up to retry_count times. For examples, see [Retry jobs](
925
- # https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings).
926
- # The default value of this field is 5.
955
+ # max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/
956
+ # scheduler/docs/configuring/retry-jobs#max-doublings). The default value of
957
+ # this field is 5.
927
958
  # Corresponds to the JSON property `maxDoublings`
928
959
  # @return [Fixnum]
929
960
  attr_accessor :max_doublings
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module CloudschedulerV1
18
18
  # Version of the google-apis-cloudscheduler_v1 gem
19
- GEM_VERSION = "0.41.0"
19
+ GEM_VERSION = "0.42.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.18.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20250925"
25
+ REVISION = "20251022"
26
26
  end
27
27
  end
28
28
  end
@@ -40,6 +40,12 @@ module Google
40
40
  include Google::Apis::Core::JsonObjectSupport
41
41
  end
42
42
 
43
+ class CmekConfig
44
+ class Representation < Google::Apis::Core::JsonRepresentation; end
45
+
46
+ include Google::Apis::Core::JsonObjectSupport
47
+ end
48
+
43
49
  class Empty
44
50
  class Representation < Google::Apis::Core::JsonRepresentation; end
45
51
 
@@ -176,6 +182,14 @@ module Google
176
182
  end
177
183
  end
178
184
 
185
+ class CmekConfig
186
+ # @private
187
+ class Representation < Google::Apis::Core::JsonRepresentation
188
+ property :kms_key_name, as: 'kmsKeyName'
189
+ property :name, as: 'name'
190
+ end
191
+ end
192
+
179
193
  class Empty
180
194
  # @private
181
195
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -81,12 +81,43 @@ module Google
81
81
  execute_or_queue_command(command, &block)
82
82
  end
83
83
 
84
+ # Gets the Scheduler config in the project/region.
85
+ # @param [String] name
86
+ # Required. The config name. For example: projects/PROJECT_ID/locations/
87
+ # LOCATION_ID/cmekConfig
88
+ # @param [String] fields
89
+ # Selector specifying which fields to include in a partial response.
90
+ # @param [String] quota_user
91
+ # Available to use for quota purposes for server-side applications. Can be any
92
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
93
+ # @param [Google::Apis::RequestOptions] options
94
+ # Request-specific options
95
+ #
96
+ # @yield [result, err] Result & error if block supplied
97
+ # @yieldparam result [Google::Apis::CloudschedulerV1::CmekConfig] parsed result object
98
+ # @yieldparam err [StandardError] error object if request failed
99
+ #
100
+ # @return [Google::Apis::CloudschedulerV1::CmekConfig]
101
+ #
102
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
103
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
104
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
105
+ def get_project_location_cmek_config(name, fields: nil, quota_user: nil, options: nil, &block)
106
+ command = make_simple_command(:get, 'v1/{+name}', options)
107
+ command.response_representation = Google::Apis::CloudschedulerV1::CmekConfig::Representation
108
+ command.response_class = Google::Apis::CloudschedulerV1::CmekConfig
109
+ command.params['name'] = name unless name.nil?
110
+ command.query['fields'] = fields unless fields.nil?
111
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
112
+ execute_or_queue_command(command, &block)
113
+ end
114
+
84
115
  # Lists information about the supported locations for this service.
85
116
  # @param [String] name
86
117
  # The resource that owns the locations collection, if applicable.
87
118
  # @param [Array<String>, String] extra_location_types
88
- # Optional. Unless explicitly documented otherwise, don't use this unsupported
89
- # field which is primarily intended for internal usage.
119
+ # Optional. Do not use this field. It is unsupported and is ignored unless
120
+ # explicitly documented otherwise. This is primarily for internal usage.
90
121
  # @param [String] filter
91
122
  # A filter to narrow down results to a preferred subset. The filtering language
92
123
  # accepts strings like `"displayName=tokyo"`, and is documented in more detail
@@ -128,6 +159,44 @@ module Google
128
159
  execute_or_queue_command(command, &block)
129
160
  end
130
161
 
162
+ # Initializes or Updates the a scheduler config.
163
+ # @param [String] name
164
+ # Identifier. The config resource name which includes the project and location
165
+ # and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/
166
+ # LOCATION_ID/cmekConfig`
167
+ # @param [Google::Apis::CloudschedulerV1::CmekConfig] cmek_config_object
168
+ # @param [String] update_mask
169
+ # Optional. List of fields to be updated in this request.
170
+ # @param [String] fields
171
+ # Selector specifying which fields to include in a partial response.
172
+ # @param [String] quota_user
173
+ # Available to use for quota purposes for server-side applications. Can be any
174
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
175
+ # @param [Google::Apis::RequestOptions] options
176
+ # Request-specific options
177
+ #
178
+ # @yield [result, err] Result & error if block supplied
179
+ # @yieldparam result [Google::Apis::CloudschedulerV1::Operation] parsed result object
180
+ # @yieldparam err [StandardError] error object if request failed
181
+ #
182
+ # @return [Google::Apis::CloudschedulerV1::Operation]
183
+ #
184
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
185
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
186
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
187
+ def update_project_location_cmek_config(name, cmek_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
188
+ command = make_simple_command(:patch, 'v1/{+name}', options)
189
+ command.request_representation = Google::Apis::CloudschedulerV1::CmekConfig::Representation
190
+ command.request_object = cmek_config_object
191
+ command.response_representation = Google::Apis::CloudschedulerV1::Operation::Representation
192
+ command.response_class = Google::Apis::CloudschedulerV1::Operation
193
+ command.params['name'] = name unless name.nil?
194
+ command.query['updateMask'] = update_mask unless update_mask.nil?
195
+ command.query['fields'] = fields unless fields.nil?
196
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
197
+ execute_or_queue_command(command, &block)
198
+ end
199
+
131
200
  # Creates a job.
132
201
  # @param [String] parent
133
202
  # Required. The location name. For example: `projects/PROJECT_ID/locations/
@@ -276,12 +345,13 @@ module Google
276
345
  # The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/
277
346
  # JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
278
347
  # hyphens (-), colons (:), or periods (.). For more information, see [
279
- # Identifying projects](https://cloud.google.com/resource-manager/docs/creating-
280
- # managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID
281
- # for the job's location. The list of available locations can be obtained by
282
- # calling ListLocations. For more information, see https://cloud.google.com/
283
- # about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-
284
- # 9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
348
+ # Identifying projects](/resource-manager/docs/creating-managing-projects#
349
+ # identifying_projects) * `LOCATION_ID` is the canonical ID for the job's
350
+ # location. The list of available locations can be obtained by calling [
351
+ # locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list).
352
+ # For more information, see [Cloud Scheduler locations](/scheduler/docs/
353
+ # locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
354
+ # hyphens (-), or underscores (_). The maximum length is 500 characters.
285
355
  # @param [Google::Apis::CloudschedulerV1::Job] job_object
286
356
  # @param [String] update_mask
287
357
  # A mask used to specify which fields of the job are being updated.
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-cloudscheduler_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.41.0
4
+ version: 0.42.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -57,7 +57,7 @@ licenses:
57
57
  metadata:
58
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-cloudscheduler_v1/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-cloudscheduler_v1/v0.41.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-cloudscheduler_v1/v0.42.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-cloudscheduler_v1
62
62
  rdoc_options: []
63
63
  require_paths: