google-cloud-scheduler-v1 0.4.5 → 0.6.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 +4 -4
- data/AUTHENTICATION.md +1 -1
- data/README.md +13 -8
- data/lib/google/cloud/scheduler/v1/cloud_scheduler/client.rb +49 -25
- data/lib/google/cloud/scheduler/v1/cloud_scheduler.rb +1 -1
- data/lib/google/cloud/scheduler/v1/cloudscheduler_pb.rb +2 -1
- data/lib/google/cloud/scheduler/v1/cloudscheduler_services_pb.rb +21 -15
- data/lib/google/cloud/scheduler/v1/job_pb.rb +2 -2
- data/lib/google/cloud/scheduler/v1/target_pb.rb +2 -2
- data/lib/google/cloud/scheduler/v1/version.rb +1 -1
- data/lib/google/cloud/scheduler/v1.rb +3 -1
- data/proto_docs/google/api/client.rb +318 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/cloud/scheduler/v1/cloudscheduler.rb +30 -17
- data/proto_docs/google/cloud/scheduler/v1/job.rb +58 -34
- data/proto_docs/google/cloud/scheduler/v1/target.rb +34 -16
- data/proto_docs/google/protobuf/any.rb +3 -3
- data/proto_docs/google/protobuf/empty.rb +0 -2
- data/proto_docs/google/rpc/status.rb +4 -2
- metadata +35 -13
@@ -0,0 +1,318 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Api
|
22
|
+
# Required information for every language.
|
23
|
+
# @!attribute [rw] reference_docs_uri
|
24
|
+
# @return [::String]
|
25
|
+
# Link to automatically generated reference documentation. Example:
|
26
|
+
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
27
|
+
# @!attribute [rw] destinations
|
28
|
+
# @return [::Array<::Google::Api::ClientLibraryDestination>]
|
29
|
+
# The destination where API teams want this client library to be published.
|
30
|
+
class CommonLanguageSettings
|
31
|
+
include ::Google::Protobuf::MessageExts
|
32
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
33
|
+
end
|
34
|
+
|
35
|
+
# Details about how and where to publish client libraries.
|
36
|
+
# @!attribute [rw] version
|
37
|
+
# @return [::String]
|
38
|
+
# Version of the API to apply these settings to.
|
39
|
+
# @!attribute [rw] launch_stage
|
40
|
+
# @return [::Google::Api::LaunchStage]
|
41
|
+
# Launch stage of this version of the API.
|
42
|
+
# @!attribute [rw] rest_numeric_enums
|
43
|
+
# @return [::Boolean]
|
44
|
+
# When using transport=rest, the client request will encode enums as
|
45
|
+
# numbers rather than strings.
|
46
|
+
# @!attribute [rw] java_settings
|
47
|
+
# @return [::Google::Api::JavaSettings]
|
48
|
+
# Settings for legacy Java features, supported in the Service YAML.
|
49
|
+
# @!attribute [rw] cpp_settings
|
50
|
+
# @return [::Google::Api::CppSettings]
|
51
|
+
# Settings for C++ client libraries.
|
52
|
+
# @!attribute [rw] php_settings
|
53
|
+
# @return [::Google::Api::PhpSettings]
|
54
|
+
# Settings for PHP client libraries.
|
55
|
+
# @!attribute [rw] python_settings
|
56
|
+
# @return [::Google::Api::PythonSettings]
|
57
|
+
# Settings for Python client libraries.
|
58
|
+
# @!attribute [rw] node_settings
|
59
|
+
# @return [::Google::Api::NodeSettings]
|
60
|
+
# Settings for Node client libraries.
|
61
|
+
# @!attribute [rw] dotnet_settings
|
62
|
+
# @return [::Google::Api::DotnetSettings]
|
63
|
+
# Settings for .NET client libraries.
|
64
|
+
# @!attribute [rw] ruby_settings
|
65
|
+
# @return [::Google::Api::RubySettings]
|
66
|
+
# Settings for Ruby client libraries.
|
67
|
+
# @!attribute [rw] go_settings
|
68
|
+
# @return [::Google::Api::GoSettings]
|
69
|
+
# Settings for Go client libraries.
|
70
|
+
class ClientLibrarySettings
|
71
|
+
include ::Google::Protobuf::MessageExts
|
72
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
73
|
+
end
|
74
|
+
|
75
|
+
# This message configures the settings for publishing [Google Cloud Client
|
76
|
+
# libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
|
77
|
+
# generated from the service config.
|
78
|
+
# @!attribute [rw] method_settings
|
79
|
+
# @return [::Array<::Google::Api::MethodSettings>]
|
80
|
+
# A list of API method settings, e.g. the behavior for methods that use the
|
81
|
+
# long-running operation pattern.
|
82
|
+
# @!attribute [rw] new_issue_uri
|
83
|
+
# @return [::String]
|
84
|
+
# Link to a place that API users can report issues. Example:
|
85
|
+
# https://issuetracker.google.com/issues/new?component=190865&template=1161103
|
86
|
+
# @!attribute [rw] documentation_uri
|
87
|
+
# @return [::String]
|
88
|
+
# Link to product home page. Example:
|
89
|
+
# https://cloud.google.com/asset-inventory/docs/overview
|
90
|
+
# @!attribute [rw] api_short_name
|
91
|
+
# @return [::String]
|
92
|
+
# Used as a tracking tag when collecting data about the APIs developer
|
93
|
+
# relations artifacts like docs, packages delivered to package managers,
|
94
|
+
# etc. Example: "speech".
|
95
|
+
# @!attribute [rw] github_label
|
96
|
+
# @return [::String]
|
97
|
+
# GitHub label to apply to issues and pull requests opened for this API.
|
98
|
+
# @!attribute [rw] codeowner_github_teams
|
99
|
+
# @return [::Array<::String>]
|
100
|
+
# GitHub teams to be added to CODEOWNERS in the directory in GitHub
|
101
|
+
# containing source code for the client libraries for this API.
|
102
|
+
# @!attribute [rw] doc_tag_prefix
|
103
|
+
# @return [::String]
|
104
|
+
# A prefix used in sample code when demarking regions to be included in
|
105
|
+
# documentation.
|
106
|
+
# @!attribute [rw] organization
|
107
|
+
# @return [::Google::Api::ClientLibraryOrganization]
|
108
|
+
# For whom the client library is being published.
|
109
|
+
# @!attribute [rw] library_settings
|
110
|
+
# @return [::Array<::Google::Api::ClientLibrarySettings>]
|
111
|
+
# Client library settings. If the same version string appears multiple
|
112
|
+
# times in this list, then the last one wins. Settings from earlier
|
113
|
+
# settings with the same version string are discarded.
|
114
|
+
class Publishing
|
115
|
+
include ::Google::Protobuf::MessageExts
|
116
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
117
|
+
end
|
118
|
+
|
119
|
+
# Settings for Java client libraries.
|
120
|
+
# @!attribute [rw] library_package
|
121
|
+
# @return [::String]
|
122
|
+
# The package name to use in Java. Clobbers the java_package option
|
123
|
+
# set in the protobuf. This should be used **only** by APIs
|
124
|
+
# who have already set the language_settings.java.package_name" field
|
125
|
+
# in gapic.yaml. API teams should use the protobuf java_package option
|
126
|
+
# where possible.
|
127
|
+
#
|
128
|
+
# Example of a YAML configuration::
|
129
|
+
#
|
130
|
+
# publishing:
|
131
|
+
# java_settings:
|
132
|
+
# library_package: com.google.cloud.pubsub.v1
|
133
|
+
# @!attribute [rw] service_class_names
|
134
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
135
|
+
# Configure the Java class name to use instead of the service's for its
|
136
|
+
# corresponding generated GAPIC client. Keys are fully-qualified
|
137
|
+
# service names as they appear in the protobuf (including the full
|
138
|
+
# the language_settings.java.interface_names" field in gapic.yaml. API
|
139
|
+
# teams should otherwise use the service name as it appears in the
|
140
|
+
# protobuf.
|
141
|
+
#
|
142
|
+
# Example of a YAML configuration::
|
143
|
+
#
|
144
|
+
# publishing:
|
145
|
+
# java_settings:
|
146
|
+
# service_class_names:
|
147
|
+
# - google.pubsub.v1.Publisher: TopicAdmin
|
148
|
+
# - google.pubsub.v1.Subscriber: SubscriptionAdmin
|
149
|
+
# @!attribute [rw] common
|
150
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
151
|
+
# Some settings.
|
152
|
+
class JavaSettings
|
153
|
+
include ::Google::Protobuf::MessageExts
|
154
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
155
|
+
|
156
|
+
# @!attribute [rw] key
|
157
|
+
# @return [::String]
|
158
|
+
# @!attribute [rw] value
|
159
|
+
# @return [::String]
|
160
|
+
class ServiceClassNamesEntry
|
161
|
+
include ::Google::Protobuf::MessageExts
|
162
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
163
|
+
end
|
164
|
+
end
|
165
|
+
|
166
|
+
# Settings for C++ client libraries.
|
167
|
+
# @!attribute [rw] common
|
168
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
169
|
+
# Some settings.
|
170
|
+
class CppSettings
|
171
|
+
include ::Google::Protobuf::MessageExts
|
172
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
173
|
+
end
|
174
|
+
|
175
|
+
# Settings for Php client libraries.
|
176
|
+
# @!attribute [rw] common
|
177
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
178
|
+
# Some settings.
|
179
|
+
class PhpSettings
|
180
|
+
include ::Google::Protobuf::MessageExts
|
181
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
182
|
+
end
|
183
|
+
|
184
|
+
# Settings for Python client libraries.
|
185
|
+
# @!attribute [rw] common
|
186
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
187
|
+
# Some settings.
|
188
|
+
class PythonSettings
|
189
|
+
include ::Google::Protobuf::MessageExts
|
190
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
191
|
+
end
|
192
|
+
|
193
|
+
# Settings for Node client libraries.
|
194
|
+
# @!attribute [rw] common
|
195
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
196
|
+
# Some settings.
|
197
|
+
class NodeSettings
|
198
|
+
include ::Google::Protobuf::MessageExts
|
199
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
200
|
+
end
|
201
|
+
|
202
|
+
# Settings for Dotnet client libraries.
|
203
|
+
# @!attribute [rw] common
|
204
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
205
|
+
# Some settings.
|
206
|
+
class DotnetSettings
|
207
|
+
include ::Google::Protobuf::MessageExts
|
208
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
209
|
+
end
|
210
|
+
|
211
|
+
# Settings for Ruby client libraries.
|
212
|
+
# @!attribute [rw] common
|
213
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
214
|
+
# Some settings.
|
215
|
+
class RubySettings
|
216
|
+
include ::Google::Protobuf::MessageExts
|
217
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
218
|
+
end
|
219
|
+
|
220
|
+
# Settings for Go client libraries.
|
221
|
+
# @!attribute [rw] common
|
222
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
223
|
+
# Some settings.
|
224
|
+
class GoSettings
|
225
|
+
include ::Google::Protobuf::MessageExts
|
226
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
227
|
+
end
|
228
|
+
|
229
|
+
# Describes the generator configuration for a method.
|
230
|
+
# @!attribute [rw] selector
|
231
|
+
# @return [::String]
|
232
|
+
# The fully qualified name of the method, for which the options below apply.
|
233
|
+
# This is used to find the method to apply the options.
|
234
|
+
# @!attribute [rw] long_running
|
235
|
+
# @return [::Google::Api::MethodSettings::LongRunning]
|
236
|
+
# Describes settings to use for long-running operations when generating
|
237
|
+
# API methods for RPCs. Complements RPCs that use the annotations in
|
238
|
+
# google/longrunning/operations.proto.
|
239
|
+
#
|
240
|
+
# Example of a YAML configuration::
|
241
|
+
#
|
242
|
+
# publishing:
|
243
|
+
# method_behavior:
|
244
|
+
# - selector: CreateAdDomain
|
245
|
+
# long_running:
|
246
|
+
# initial_poll_delay:
|
247
|
+
# seconds: 60 # 1 minute
|
248
|
+
# poll_delay_multiplier: 1.5
|
249
|
+
# max_poll_delay:
|
250
|
+
# seconds: 360 # 6 minutes
|
251
|
+
# total_poll_timeout:
|
252
|
+
# seconds: 54000 # 90 minutes
|
253
|
+
class MethodSettings
|
254
|
+
include ::Google::Protobuf::MessageExts
|
255
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
256
|
+
|
257
|
+
# Describes settings to use when generating API methods that use the
|
258
|
+
# long-running operation pattern.
|
259
|
+
# All default values below are from those used in the client library
|
260
|
+
# generators (e.g.
|
261
|
+
# [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
|
262
|
+
# @!attribute [rw] initial_poll_delay
|
263
|
+
# @return [::Google::Protobuf::Duration]
|
264
|
+
# Initial delay after which the first poll request will be made.
|
265
|
+
# Default value: 5 seconds.
|
266
|
+
# @!attribute [rw] poll_delay_multiplier
|
267
|
+
# @return [::Float]
|
268
|
+
# Multiplier to gradually increase delay between subsequent polls until it
|
269
|
+
# reaches max_poll_delay.
|
270
|
+
# Default value: 1.5.
|
271
|
+
# @!attribute [rw] max_poll_delay
|
272
|
+
# @return [::Google::Protobuf::Duration]
|
273
|
+
# Maximum time between two subsequent poll requests.
|
274
|
+
# Default value: 45 seconds.
|
275
|
+
# @!attribute [rw] total_poll_timeout
|
276
|
+
# @return [::Google::Protobuf::Duration]
|
277
|
+
# Total polling timeout.
|
278
|
+
# Default value: 5 minutes.
|
279
|
+
class LongRunning
|
280
|
+
include ::Google::Protobuf::MessageExts
|
281
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
282
|
+
end
|
283
|
+
end
|
284
|
+
|
285
|
+
# The organization for which the client libraries are being published.
|
286
|
+
# Affects the url where generated docs are published, etc.
|
287
|
+
module ClientLibraryOrganization
|
288
|
+
# Not useful.
|
289
|
+
CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
|
290
|
+
|
291
|
+
# Google Cloud Platform Org.
|
292
|
+
CLOUD = 1
|
293
|
+
|
294
|
+
# Ads (Advertising) Org.
|
295
|
+
ADS = 2
|
296
|
+
|
297
|
+
# Photos Org.
|
298
|
+
PHOTOS = 3
|
299
|
+
|
300
|
+
# Street View Org.
|
301
|
+
STREET_VIEW = 4
|
302
|
+
end
|
303
|
+
|
304
|
+
# To where should client libraries be published?
|
305
|
+
module ClientLibraryDestination
|
306
|
+
# Client libraries will neither be generated nor published to package
|
307
|
+
# managers.
|
308
|
+
CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
|
309
|
+
|
310
|
+
# Generate the client library in a repo under github.com/googleapis,
|
311
|
+
# but don't publish it to package managers.
|
312
|
+
GITHUB = 10
|
313
|
+
|
314
|
+
# Publish the library to package managers like nuget.org and npmjs.com.
|
315
|
+
PACKAGE_MANAGER = 20
|
316
|
+
end
|
317
|
+
end
|
318
|
+
end
|
@@ -0,0 +1,71 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Api
|
22
|
+
# The launch stage as defined by [Google Cloud Platform
|
23
|
+
# Launch Stages](https://cloud.google.com/terms/launch-stages).
|
24
|
+
module LaunchStage
|
25
|
+
# Do not use this default value.
|
26
|
+
LAUNCH_STAGE_UNSPECIFIED = 0
|
27
|
+
|
28
|
+
# The feature is not yet implemented. Users can not use it.
|
29
|
+
UNIMPLEMENTED = 6
|
30
|
+
|
31
|
+
# Prelaunch features are hidden from users and are only visible internally.
|
32
|
+
PRELAUNCH = 7
|
33
|
+
|
34
|
+
# Early Access features are limited to a closed group of testers. To use
|
35
|
+
# these features, you must sign up in advance and sign a Trusted Tester
|
36
|
+
# agreement (which includes confidentiality provisions). These features may
|
37
|
+
# be unstable, changed in backward-incompatible ways, and are not
|
38
|
+
# guaranteed to be released.
|
39
|
+
EARLY_ACCESS = 1
|
40
|
+
|
41
|
+
# Alpha is a limited availability test for releases before they are cleared
|
42
|
+
# for widespread use. By Alpha, all significant design issues are resolved
|
43
|
+
# and we are in the process of verifying functionality. Alpha customers
|
44
|
+
# need to apply for access, agree to applicable terms, and have their
|
45
|
+
# projects allowlisted. Alpha releases don't have to be feature complete,
|
46
|
+
# no SLAs are provided, and there are no technical support obligations, but
|
47
|
+
# they will be far enough along that customers can actually use them in
|
48
|
+
# test environments or for limited-use tests -- just like they would in
|
49
|
+
# normal production cases.
|
50
|
+
ALPHA = 2
|
51
|
+
|
52
|
+
# Beta is the point at which we are ready to open a release for any
|
53
|
+
# customer to use. There are no SLA or technical support obligations in a
|
54
|
+
# Beta release. Products will be complete from a feature perspective, but
|
55
|
+
# may have some open outstanding issues. Beta releases are suitable for
|
56
|
+
# limited production use cases.
|
57
|
+
BETA = 3
|
58
|
+
|
59
|
+
# GA features are open to all developers and are considered stable and
|
60
|
+
# fully qualified for production use.
|
61
|
+
GA = 4
|
62
|
+
|
63
|
+
# Deprecated features are scheduled to be shut down and removed. For more
|
64
|
+
# information, see the "Deprecation Policy" section of our [Terms of
|
65
|
+
# Service](https://cloud.google.com/terms/)
|
66
|
+
# and the [Google Cloud Platform Subject to the Deprecation
|
67
|
+
# Policy](https://cloud.google.com/terms/deprecation) documentation.
|
68
|
+
DEPRECATED = 5
|
69
|
+
end
|
70
|
+
end
|
71
|
+
end
|
@@ -21,7 +21,8 @@ module Google
|
|
21
21
|
module Cloud
|
22
22
|
module Scheduler
|
23
23
|
module V1
|
24
|
-
# Request message for listing jobs using
|
24
|
+
# Request message for listing jobs using
|
25
|
+
# {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#list_jobs ListJobs}.
|
25
26
|
# @!attribute [rw] parent
|
26
27
|
# @return [::String]
|
27
28
|
# Required. The location name. For example:
|
@@ -39,26 +40,31 @@ module Google
|
|
39
40
|
# A token identifying a page of results the server will return. To
|
40
41
|
# request the first page results, page_token must be empty. To
|
41
42
|
# request the next page of results, page_token must be the value of
|
42
|
-
# {::Google::Cloud::Scheduler::V1::ListJobsResponse#next_page_token next_page_token}
|
43
|
-
# the previous call to
|
44
|
-
#
|
45
|
-
#
|
43
|
+
# {::Google::Cloud::Scheduler::V1::ListJobsResponse#next_page_token next_page_token}
|
44
|
+
# returned from the previous call to
|
45
|
+
# {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#list_jobs ListJobs}. It is an
|
46
|
+
# error to switch the value of
|
47
|
+
# [filter][google.cloud.scheduler.v1.ListJobsRequest.filter] or
|
48
|
+
# [order_by][google.cloud.scheduler.v1.ListJobsRequest.order_by] while
|
49
|
+
# iterating through pages.
|
46
50
|
class ListJobsRequest
|
47
51
|
include ::Google::Protobuf::MessageExts
|
48
52
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
49
53
|
end
|
50
54
|
|
51
|
-
# Response message for listing jobs using
|
55
|
+
# Response message for listing jobs using
|
56
|
+
# {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#list_jobs ListJobs}.
|
52
57
|
# @!attribute [rw] jobs
|
53
58
|
# @return [::Array<::Google::Cloud::Scheduler::V1::Job>]
|
54
59
|
# The list of jobs.
|
55
60
|
# @!attribute [rw] next_page_token
|
56
61
|
# @return [::String]
|
57
62
|
# A token to retrieve next page of results. Pass this value in the
|
58
|
-
# {::Google::Cloud::Scheduler::V1::ListJobsRequest#page_token page_token} field in
|
59
|
-
#
|
60
|
-
#
|
61
|
-
#
|
63
|
+
# {::Google::Cloud::Scheduler::V1::ListJobsRequest#page_token page_token} field in
|
64
|
+
# the subsequent call to
|
65
|
+
# {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#list_jobs ListJobs} to retrieve
|
66
|
+
# the next page of results. If this is empty it indicates that there are no
|
67
|
+
# more results through which to paginate.
|
62
68
|
#
|
63
69
|
# The page token is valid for only 2 hours.
|
64
70
|
class ListJobsResponse
|
@@ -66,7 +72,8 @@ module Google
|
|
66
72
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
67
73
|
end
|
68
74
|
|
69
|
-
# Request message for
|
75
|
+
# Request message for
|
76
|
+
# {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#get_job GetJob}.
|
70
77
|
# @!attribute [rw] name
|
71
78
|
# @return [::String]
|
72
79
|
# Required. The job name. For example:
|
@@ -76,7 +83,8 @@ module Google
|
|
76
83
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
77
84
|
end
|
78
85
|
|
79
|
-
# Request message for
|
86
|
+
# Request message for
|
87
|
+
# {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#create_job CreateJob}.
|
80
88
|
# @!attribute [rw] parent
|
81
89
|
# @return [::String]
|
82
90
|
# Required. The location name. For example:
|
@@ -84,7 +92,8 @@ module Google
|
|
84
92
|
# @!attribute [rw] job
|
85
93
|
# @return [::Google::Cloud::Scheduler::V1::Job]
|
86
94
|
# Required. The job to add. The user can optionally specify a name for the
|
87
|
-
# job in {::Google::Cloud::Scheduler::V1::Job#name name}.
|
95
|
+
# job in {::Google::Cloud::Scheduler::V1::Job#name name}.
|
96
|
+
# {::Google::Cloud::Scheduler::V1::Job#name name} cannot be the same as an
|
88
97
|
# existing job. If a name is not specified then the system will
|
89
98
|
# generate a random unique name that will be returned
|
90
99
|
# ({::Google::Cloud::Scheduler::V1::Job#name name}) in the response.
|
@@ -93,10 +102,12 @@ module Google
|
|
93
102
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
94
103
|
end
|
95
104
|
|
96
|
-
# Request message for
|
105
|
+
# Request message for
|
106
|
+
# {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#update_job UpdateJob}.
|
97
107
|
# @!attribute [rw] job
|
98
108
|
# @return [::Google::Cloud::Scheduler::V1::Job]
|
99
|
-
# Required. The new job properties.
|
109
|
+
# Required. The new job properties.
|
110
|
+
# {::Google::Cloud::Scheduler::V1::Job#name name} must be specified.
|
100
111
|
#
|
101
112
|
# Output only fields cannot be modified using UpdateJob.
|
102
113
|
# Any value specified for an output only field will be ignored.
|
@@ -119,7 +130,8 @@ module Google
|
|
119
130
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
120
131
|
end
|
121
132
|
|
122
|
-
# Request message for
|
133
|
+
# Request message for
|
134
|
+
# {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#pause_job PauseJob}.
|
123
135
|
# @!attribute [rw] name
|
124
136
|
# @return [::String]
|
125
137
|
# Required. The job name. For example:
|
@@ -129,7 +141,8 @@ module Google
|
|
129
141
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
130
142
|
end
|
131
143
|
|
132
|
-
# Request message for
|
144
|
+
# Request message for
|
145
|
+
# {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#resume_job ResumeJob}.
|
133
146
|
# @!attribute [rw] name
|
134
147
|
# @return [::String]
|
135
148
|
# Required. The job name. For example:
|
@@ -22,10 +22,11 @@ module Google
|
|
22
22
|
module Scheduler
|
23
23
|
module V1
|
24
24
|
# Configuration for a job.
|
25
|
-
# The maximum allowed size for a job is
|
25
|
+
# The maximum allowed size for a job is 1MB.
|
26
26
|
# @!attribute [rw] name
|
27
27
|
# @return [::String]
|
28
|
-
# Optionally caller-specified in
|
28
|
+
# Optionally caller-specified in
|
29
|
+
# {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#create_job CreateJob}, after
|
29
30
|
# which it becomes output only.
|
30
31
|
#
|
31
32
|
# The job name. For example:
|
@@ -38,13 +39,14 @@ module Google
|
|
38
39
|
# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
|
39
40
|
# * `LOCATION_ID` is the canonical ID for the job's location.
|
40
41
|
# The list of available locations can be obtained by calling
|
41
|
-
#
|
42
|
+
# ListLocations.
|
42
43
|
# For more information, see https://cloud.google.com/about/locations/.
|
43
44
|
# * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),
|
44
45
|
# hyphens (-), or underscores (_). The maximum length is 500 characters.
|
45
46
|
# @!attribute [rw] description
|
46
47
|
# @return [::String]
|
47
|
-
# Optionally caller-specified in
|
48
|
+
# Optionally caller-specified in
|
49
|
+
# {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#create_job CreateJob} or
|
48
50
|
# {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#update_job UpdateJob}.
|
49
51
|
#
|
50
52
|
# A human-readable description for the job. This string must not contain
|
@@ -60,13 +62,14 @@ module Google
|
|
60
62
|
# HTTP target.
|
61
63
|
# @!attribute [rw] schedule
|
62
64
|
# @return [::String]
|
63
|
-
# Required, except when used with
|
65
|
+
# Required, except when used with
|
66
|
+
# {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#update_job UpdateJob}.
|
64
67
|
#
|
65
68
|
# Describes the schedule on which the job will be executed.
|
66
69
|
#
|
67
70
|
# The schedule can be either of the following types:
|
68
71
|
#
|
69
|
-
# * [Crontab](
|
72
|
+
# * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview)
|
70
73
|
# * English-like
|
71
74
|
# [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules)
|
72
75
|
#
|
@@ -79,15 +82,16 @@ module Google
|
|
79
82
|
# A scheduled start time will be delayed if the previous
|
80
83
|
# execution has not ended when its scheduled time occurs.
|
81
84
|
#
|
82
|
-
# If {::Google::Cloud::Scheduler::V1::RetryConfig#retry_count retry_count} > 0 and
|
83
|
-
# the job will be tried a total of
|
84
|
-
#
|
85
|
-
# time.
|
85
|
+
# If {::Google::Cloud::Scheduler::V1::RetryConfig#retry_count retry_count} > 0 and
|
86
|
+
# a job attempt fails, the job will be tried a total of
|
87
|
+
# {::Google::Cloud::Scheduler::V1::RetryConfig#retry_count retry_count} times,
|
88
|
+
# with exponential backoff, until the next scheduled start time.
|
86
89
|
# @!attribute [rw] time_zone
|
87
90
|
# @return [::String]
|
88
91
|
# Specifies the time zone to be used in interpreting
|
89
|
-
# {::Google::Cloud::Scheduler::V1::Job#schedule schedule}. The value of this field
|
90
|
-
# zone name from the [tz
|
92
|
+
# {::Google::Cloud::Scheduler::V1::Job#schedule schedule}. The value of this field
|
93
|
+
# must be a time zone name from the [tz
|
94
|
+
# database](http://en.wikipedia.org/wiki/Tz_database).
|
91
95
|
#
|
92
96
|
# Note that some time zones include a provision for
|
93
97
|
# daylight savings time. The rules for daylight saving time are
|
@@ -122,10 +126,22 @@ module Google
|
|
122
126
|
# execution logs. Cloud Scheduler will retry the job according
|
123
127
|
# to the {::Google::Cloud::Scheduler::V1::RetryConfig RetryConfig}.
|
124
128
|
#
|
125
|
-
# The allowed
|
126
|
-
#
|
127
|
-
# * For {::Google::Cloud::Scheduler::V1::Job#
|
128
|
-
#
|
129
|
+
# The default and the allowed values depend on the type of target:
|
130
|
+
#
|
131
|
+
# * For {::Google::Cloud::Scheduler::V1::Job#http_target HTTP targets}, the
|
132
|
+
# default is 3 minutes. The deadline must be in the interval [15 seconds, 30
|
133
|
+
# minutes].
|
134
|
+
#
|
135
|
+
# * For [App Engine HTTP
|
136
|
+
# targets][google.cloud.scheduler.v1.Job.app_engine_http_target], 0 indicates
|
137
|
+
# that the request has the default deadline. The default deadline depends on
|
138
|
+
# the scaling type of the service: 10 minutes for standard apps with
|
139
|
+
# automatic scaling, 24 hours for standard apps with manual and basic
|
140
|
+
# scaling, and 60 minutes for flex apps. If the request deadline is set, it
|
141
|
+
# must be in the interval [15 seconds, 24 hours 15 seconds].
|
142
|
+
#
|
143
|
+
# * For [Pub/Sub targets][google.cloud.scheduler.v1.Job.pubsub_target], this
|
144
|
+
# field is ignored.
|
129
145
|
class Job
|
130
146
|
include ::Google::Protobuf::MessageExts
|
131
147
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -147,9 +163,11 @@ module Google
|
|
147
163
|
# cannot directly set a job to be disabled.
|
148
164
|
DISABLED = 3
|
149
165
|
|
150
|
-
# The job state resulting from a failed
|
166
|
+
# The job state resulting from a failed
|
167
|
+
# {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob}
|
151
168
|
# operation. To recover a job from this state, retry
|
152
|
-
# {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob}
|
169
|
+
# {::Google::Cloud::Scheduler::V1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob}
|
170
|
+
# until a successful response is received.
|
153
171
|
UPDATE_FAILED = 4
|
154
172
|
end
|
155
173
|
end
|
@@ -158,7 +176,8 @@ module Google
|
|
158
176
|
#
|
159
177
|
# By default, if a job does not complete successfully (meaning that
|
160
178
|
# an acknowledgement is not received from the handler, then it will be retried
|
161
|
-
# with exponential backoff according to the settings in
|
179
|
+
# with exponential backoff according to the settings in
|
180
|
+
# {::Google::Cloud::Scheduler::V1::RetryConfig RetryConfig}.
|
162
181
|
# @!attribute [rw] retry_count
|
163
182
|
# @return [::Integer]
|
164
183
|
# The number of attempts that the system will make to run a job using the
|
@@ -181,8 +200,8 @@ module Google
|
|
181
200
|
# @return [::Google::Protobuf::Duration]
|
182
201
|
# The time limit for retrying a failed job, measured from time when an
|
183
202
|
# execution was first attempted. If specified with
|
184
|
-
# {::Google::Cloud::Scheduler::V1::RetryConfig#retry_count retry_count}, the job
|
185
|
-
# limits are reached.
|
203
|
+
# {::Google::Cloud::Scheduler::V1::RetryConfig#retry_count retry_count}, the job
|
204
|
+
# will be retried until both limits are reached.
|
186
205
|
#
|
187
206
|
# The default value for max_retry_duration is zero, which means retry
|
188
207
|
# duration is unlimited.
|
@@ -203,20 +222,25 @@ module Google
|
|
203
222
|
# The time between retries will double `max_doublings` times.
|
204
223
|
#
|
205
224
|
# A job's retry interval starts at
|
206
|
-
# {::Google::Cloud::Scheduler::V1::RetryConfig#min_backoff_duration min_backoff_duration},
|
207
|
-
# `max_doublings` times, then increases linearly, and finally
|
208
|
-
# retries
|
209
|
-
# {::Google::Cloud::Scheduler::V1::RetryConfig#max_backoff_duration max_backoff_duration}
|
225
|
+
# {::Google::Cloud::Scheduler::V1::RetryConfig#min_backoff_duration min_backoff_duration},
|
226
|
+
# then doubles `max_doublings` times, then increases linearly, and finally
|
227
|
+
# retries at intervals of
|
228
|
+
# {::Google::Cloud::Scheduler::V1::RetryConfig#max_backoff_duration max_backoff_duration}
|
229
|
+
# up to {::Google::Cloud::Scheduler::V1::RetryConfig#retry_count retry_count}
|
230
|
+
# times.
|
231
|
+
#
|
232
|
+
# For example, if
|
233
|
+
# {::Google::Cloud::Scheduler::V1::RetryConfig#min_backoff_duration min_backoff_duration}
|
234
|
+
# is 10s,
|
235
|
+
# {::Google::Cloud::Scheduler::V1::RetryConfig#max_backoff_duration max_backoff_duration}
|
236
|
+
# is 300s, and `max_doublings` is 3, then the a job will first be retried in
|
237
|
+
# 10s. The retry interval will double three times, and then increase linearly
|
238
|
+
# by 2^3 * 10s. Finally, the job will retry at intervals of
|
239
|
+
# {::Google::Cloud::Scheduler::V1::RetryConfig#max_backoff_duration max_backoff_duration}
|
240
|
+
# until the job has been attempted
|
210
241
|
# {::Google::Cloud::Scheduler::V1::RetryConfig#retry_count retry_count} times.
|
211
|
-
#
|
212
|
-
#
|
213
|
-
# 10s, {::Google::Cloud::Scheduler::V1::RetryConfig#max_backoff_duration max_backoff_duration} is 300s, and
|
214
|
-
# `max_doublings` is 3, then the a job will first be retried in 10s. The
|
215
|
-
# retry interval will double three times, and then increase linearly by
|
216
|
-
# 2^3 * 10s. Finally, the job will retry at intervals of
|
217
|
-
# {::Google::Cloud::Scheduler::V1::RetryConfig#max_backoff_duration max_backoff_duration} until the job has
|
218
|
-
# been attempted {::Google::Cloud::Scheduler::V1::RetryConfig#retry_count retry_count} times. Thus, the
|
219
|
-
# requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
|
242
|
+
# Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s,
|
243
|
+
# 300s, ....
|
220
244
|
#
|
221
245
|
# The default value of this field is 5.
|
222
246
|
class RetryConfig
|