google-cloud-scheduler-v1beta1 0.5.0 → 0.7.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 +2 -2
- data/lib/google/cloud/scheduler/v1beta1/bindings_override.rb +102 -0
- data/lib/google/cloud/scheduler/v1beta1/cloud_scheduler/client.rb +76 -28
- data/lib/google/cloud/scheduler/v1beta1/cloud_scheduler/rest/client.rb +973 -0
- data/lib/google/cloud/scheduler/v1beta1/cloud_scheduler/rest/service_stub.rb +525 -0
- data/lib/google/cloud/scheduler/v1beta1/cloud_scheduler/rest.rb +54 -0
- data/lib/google/cloud/scheduler/v1beta1/cloud_scheduler.rb +7 -1
- data/lib/google/cloud/scheduler/v1beta1/cloudscheduler_pb.rb +4 -0
- data/lib/google/cloud/scheduler/v1beta1/cloudscheduler_services_pb.rb +24 -15
- data/lib/google/cloud/scheduler/v1beta1/job_pb.rb +2 -1
- data/lib/google/cloud/scheduler/v1beta1/rest.rb +38 -0
- data/lib/google/cloud/scheduler/v1beta1/target_pb.rb +0 -1
- data/lib/google/cloud/scheduler/v1beta1/version.rb +1 -1
- data/lib/google/cloud/scheduler/v1beta1.rb +7 -2
- 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/v1beta1/cloudscheduler.rb +55 -17
- data/proto_docs/google/cloud/scheduler/v1beta1/job.rb +64 -34
- data/proto_docs/google/cloud/scheduler/v1beta1/target.rb +54 -34
- data/proto_docs/google/protobuf/empty.rb +0 -2
- data/proto_docs/google/rpc/status.rb +4 -2
- metadata +35 -8
@@ -21,11 +21,22 @@ module Google
|
|
21
21
|
module Cloud
|
22
22
|
module Scheduler
|
23
23
|
module V1beta1
|
24
|
-
# Request message for listing jobs using
|
24
|
+
# Request message for listing jobs using
|
25
|
+
# {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#list_jobs ListJobs}.
|
25
26
|
# @!attribute [rw] parent
|
26
27
|
# @return [::String]
|
27
28
|
# Required. The location name. For example:
|
28
29
|
# `projects/PROJECT_ID/locations/LOCATION_ID`.
|
30
|
+
# @!attribute [rw] filter
|
31
|
+
# @return [::String]
|
32
|
+
# `filter` can be used to specify a subset of jobs.
|
33
|
+
#
|
34
|
+
# If `filter` equals `target_config="HttpConfig"`, then the http
|
35
|
+
# target jobs are retrieved. If `filter` equals
|
36
|
+
# `target_config="PubSubConfig"`, then the Pub/Sub target jobs are
|
37
|
+
# retrieved. If `filter` equals `labels.foo=value1
|
38
|
+
# labels.foo=value2` then only jobs which are labeled with
|
39
|
+
# foo=value1 AND foo=value2 will be returned.
|
29
40
|
# @!attribute [rw] page_size
|
30
41
|
# @return [::Integer]
|
31
42
|
# Requested page size.
|
@@ -39,26 +50,36 @@ module Google
|
|
39
50
|
# A token identifying a page of results the server will return. To
|
40
51
|
# request the first page results, page_token must be empty. To
|
41
52
|
# request the next page of results, page_token must be the value of
|
42
|
-
# {::Google::Cloud::Scheduler::V1beta1::ListJobsResponse#next_page_token next_page_token}
|
43
|
-
# the previous call to
|
44
|
-
#
|
45
|
-
#
|
53
|
+
# {::Google::Cloud::Scheduler::V1beta1::ListJobsResponse#next_page_token next_page_token}
|
54
|
+
# returned from the previous call to
|
55
|
+
# {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#list_jobs ListJobs}. It is
|
56
|
+
# an error to switch the value of
|
57
|
+
# {::Google::Cloud::Scheduler::V1beta1::ListJobsRequest#filter filter} or
|
58
|
+
# [order_by][google.cloud.scheduler.v1beta1.ListJobsRequest.order_by] while
|
59
|
+
# iterating through pages.
|
60
|
+
# @!attribute [rw] legacy_app_engine_cron
|
61
|
+
# @return [::Boolean]
|
62
|
+
# This field is used to manage the legacy App Engine Cron jobs using the
|
63
|
+
# Cloud Scheduler API. If the field is set to true, the jobs in the __cron
|
64
|
+
# queue will be listed instead.
|
46
65
|
class ListJobsRequest
|
47
66
|
include ::Google::Protobuf::MessageExts
|
48
67
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
49
68
|
end
|
50
69
|
|
51
|
-
# Response message for listing jobs using
|
70
|
+
# Response message for listing jobs using
|
71
|
+
# {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#list_jobs ListJobs}.
|
52
72
|
# @!attribute [rw] jobs
|
53
73
|
# @return [::Array<::Google::Cloud::Scheduler::V1beta1::Job>]
|
54
74
|
# The list of jobs.
|
55
75
|
# @!attribute [rw] next_page_token
|
56
76
|
# @return [::String]
|
57
77
|
# A token to retrieve next page of results. Pass this value in the
|
58
|
-
# {::Google::Cloud::Scheduler::V1beta1::ListJobsRequest#page_token page_token}
|
59
|
-
#
|
60
|
-
#
|
61
|
-
#
|
78
|
+
# {::Google::Cloud::Scheduler::V1beta1::ListJobsRequest#page_token page_token}
|
79
|
+
# field in the subsequent call to
|
80
|
+
# {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#list_jobs ListJobs} to
|
81
|
+
# retrieve the next page of results. If this is empty it indicates that there
|
82
|
+
# are no more results through which to paginate.
|
62
83
|
#
|
63
84
|
# The page token is valid for only 2 hours.
|
64
85
|
class ListJobsResponse
|
@@ -66,7 +87,8 @@ module Google
|
|
66
87
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
67
88
|
end
|
68
89
|
|
69
|
-
# Request message for
|
90
|
+
# Request message for
|
91
|
+
# {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#get_job GetJob}.
|
70
92
|
# @!attribute [rw] name
|
71
93
|
# @return [::String]
|
72
94
|
# Required. The job name. For example:
|
@@ -76,7 +98,8 @@ module Google
|
|
76
98
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
77
99
|
end
|
78
100
|
|
79
|
-
# Request message for
|
101
|
+
# Request message for
|
102
|
+
# {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#create_job CreateJob}.
|
80
103
|
# @!attribute [rw] parent
|
81
104
|
# @return [::String]
|
82
105
|
# Required. The location name. For example:
|
@@ -84,7 +107,8 @@ module Google
|
|
84
107
|
# @!attribute [rw] job
|
85
108
|
# @return [::Google::Cloud::Scheduler::V1beta1::Job]
|
86
109
|
# Required. The job to add. The user can optionally specify a name for the
|
87
|
-
# job in {::Google::Cloud::Scheduler::V1beta1::Job#name name}.
|
110
|
+
# job in {::Google::Cloud::Scheduler::V1beta1::Job#name name}.
|
111
|
+
# {::Google::Cloud::Scheduler::V1beta1::Job#name name} cannot be the same as an
|
88
112
|
# existing job. If a name is not specified then the system will
|
89
113
|
# generate a random unique name that will be returned
|
90
114
|
# ({::Google::Cloud::Scheduler::V1beta1::Job#name name}) in the response.
|
@@ -93,10 +117,12 @@ module Google
|
|
93
117
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
94
118
|
end
|
95
119
|
|
96
|
-
# Request message for
|
120
|
+
# Request message for
|
121
|
+
# {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job UpdateJob}.
|
97
122
|
# @!attribute [rw] job
|
98
123
|
# @return [::Google::Cloud::Scheduler::V1beta1::Job]
|
99
|
-
# Required. The new job properties.
|
124
|
+
# Required. The new job properties.
|
125
|
+
# {::Google::Cloud::Scheduler::V1beta1::Job#name name} must be specified.
|
100
126
|
#
|
101
127
|
# Output only fields cannot be modified using UpdateJob.
|
102
128
|
# Any value specified for an output only field will be ignored.
|
@@ -114,12 +140,18 @@ module Google
|
|
114
140
|
# @return [::String]
|
115
141
|
# Required. The job name. For example:
|
116
142
|
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
|
143
|
+
# @!attribute [rw] legacy_app_engine_cron
|
144
|
+
# @return [::Boolean]
|
145
|
+
# This field is used to manage the legacy App Engine Cron jobs using the
|
146
|
+
# Cloud Scheduler API. If the field is set to true, the job in the __cron
|
147
|
+
# queue with the corresponding name will be deleted instead.
|
117
148
|
class DeleteJobRequest
|
118
149
|
include ::Google::Protobuf::MessageExts
|
119
150
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
120
151
|
end
|
121
152
|
|
122
|
-
# Request message for
|
153
|
+
# Request message for
|
154
|
+
# {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#pause_job PauseJob}.
|
123
155
|
# @!attribute [rw] name
|
124
156
|
# @return [::String]
|
125
157
|
# Required. The job name. For example:
|
@@ -129,7 +161,8 @@ module Google
|
|
129
161
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
130
162
|
end
|
131
163
|
|
132
|
-
# Request message for
|
164
|
+
# Request message for
|
165
|
+
# {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#resume_job ResumeJob}.
|
133
166
|
# @!attribute [rw] name
|
134
167
|
# @return [::String]
|
135
168
|
# Required. The job name. For example:
|
@@ -145,6 +178,11 @@ module Google
|
|
145
178
|
# @return [::String]
|
146
179
|
# Required. The job name. For example:
|
147
180
|
# `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`.
|
181
|
+
# @!attribute [rw] legacy_app_engine_cron
|
182
|
+
# @return [::Boolean]
|
183
|
+
# This field is used to manage the legacy App Engine Cron jobs using the
|
184
|
+
# Cloud Scheduler API. If the field is set to true, the job in the __cron
|
185
|
+
# queue with the corresponding name will be forced to run instead.
|
148
186
|
class RunJobRequest
|
149
187
|
include ::Google::Protobuf::MessageExts
|
150
188
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -22,10 +22,11 @@ module Google
|
|
22
22
|
module Scheduler
|
23
23
|
module V1beta1
|
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::V1beta1::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
|
+
# `::Google::Cloud::Location::Locations::Client#list_locations`.
|
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::V1beta1::CloudScheduler::Client#create_job CreateJob} or
|
48
50
|
# {::Google::Cloud::Scheduler::V1beta1::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::V1beta1::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,17 @@ 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::V1beta1::RetryConfig#retry_count retry_count} >
|
83
|
-
# the job will be tried a total of
|
85
|
+
# If {::Google::Cloud::Scheduler::V1beta1::RetryConfig#retry_count retry_count} >
|
86
|
+
# 0 and a job attempt fails, the job will be tried a total of
|
87
|
+
# {::Google::Cloud::Scheduler::V1beta1::RetryConfig#retry_count retry_count}
|
84
88
|
# times, with exponential backoff, until the next scheduled start
|
85
89
|
# time.
|
86
90
|
# @!attribute [rw] time_zone
|
87
91
|
# @return [::String]
|
88
92
|
# Specifies the time zone to be used in interpreting
|
89
|
-
# {::Google::Cloud::Scheduler::V1beta1::Job#schedule schedule}. The value of this
|
90
|
-
# zone name from the [tz
|
93
|
+
# {::Google::Cloud::Scheduler::V1beta1::Job#schedule schedule}. The value of this
|
94
|
+
# field must be a time zone name from the [tz
|
95
|
+
# database](http://en.wikipedia.org/wiki/Tz_database).
|
91
96
|
#
|
92
97
|
# Note that some time zones include a provision for
|
93
98
|
# daylight savings time. The rules for daylight saving time are
|
@@ -122,12 +127,29 @@ module Google
|
|
122
127
|
# execution logs. Cloud Scheduler will retry the job according
|
123
128
|
# to the {::Google::Cloud::Scheduler::V1beta1::RetryConfig RetryConfig}.
|
124
129
|
#
|
125
|
-
# The allowed
|
130
|
+
# The default and the allowed values depend on the type of target:
|
131
|
+
#
|
132
|
+
# * For {::Google::Cloud::Scheduler::V1beta1::Job#http_target HTTP targets}, the
|
133
|
+
# default is 3 minutes. The deadline must be in the interval [15 seconds, 30
|
134
|
+
# minutes].
|
126
135
|
#
|
127
|
-
# * For
|
128
|
-
#
|
129
|
-
#
|
130
|
-
#
|
136
|
+
# * For [App Engine HTTP
|
137
|
+
# targets][google.cloud.scheduler.v1beta1.Job.app_engine_http_target], 0
|
138
|
+
# indicates that the request has the default deadline. The default deadline
|
139
|
+
# depends on the scaling type of the service: 10 minutes for standard apps
|
140
|
+
# with automatic scaling, 24 hours for standard apps with manual and basic
|
141
|
+
# scaling, and 60 minutes for flex apps. If the request deadline is set, it
|
142
|
+
# must be in the interval [15 seconds, 24 hours 15 seconds].
|
143
|
+
#
|
144
|
+
# * For [Pub/Sub targets][google.cloud.scheduler.v1beta1.Job.pubsub_target],
|
145
|
+
# this field is ignored.
|
146
|
+
# @!attribute [rw] legacy_app_engine_cron
|
147
|
+
# @return [::Boolean]
|
148
|
+
# Immutable. This field is used to manage the legacy App Engine Cron jobs
|
149
|
+
# using the Cloud Scheduler API. If the field is set to true, the job will be
|
150
|
+
# considered a legacy job. Note that App Engine Cron jobs have fewer
|
151
|
+
# features than Cloud Scheduler jobs, e.g., are only limited to App Engine
|
152
|
+
# targets.
|
131
153
|
class Job
|
132
154
|
include ::Google::Protobuf::MessageExts
|
133
155
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -149,9 +171,11 @@ module Google
|
|
149
171
|
# cannot directly set a job to be disabled.
|
150
172
|
DISABLED = 3
|
151
173
|
|
152
|
-
# The job state resulting from a failed
|
174
|
+
# The job state resulting from a failed
|
175
|
+
# {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob}
|
153
176
|
# operation. To recover a job from this state, retry
|
154
|
-
# {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob}
|
177
|
+
# {::Google::Cloud::Scheduler::V1beta1::CloudScheduler::Client#update_job CloudScheduler.UpdateJob}
|
178
|
+
# until a successful response is received.
|
155
179
|
UPDATE_FAILED = 4
|
156
180
|
end
|
157
181
|
end
|
@@ -160,7 +184,8 @@ module Google
|
|
160
184
|
#
|
161
185
|
# By default, if a job does not complete successfully (meaning that
|
162
186
|
# an acknowledgement is not received from the handler, then it will be retried
|
163
|
-
# with exponential backoff according to the settings in
|
187
|
+
# with exponential backoff according to the settings in
|
188
|
+
# {::Google::Cloud::Scheduler::V1beta1::RetryConfig RetryConfig}.
|
164
189
|
# @!attribute [rw] retry_count
|
165
190
|
# @return [::Integer]
|
166
191
|
# The number of attempts that the system will make to run a job using the
|
@@ -183,8 +208,8 @@ module Google
|
|
183
208
|
# @return [::Google::Protobuf::Duration]
|
184
209
|
# The time limit for retrying a failed job, measured from time when an
|
185
210
|
# execution was first attempted. If specified with
|
186
|
-
# {::Google::Cloud::Scheduler::V1beta1::RetryConfig#retry_count retry_count}, the
|
187
|
-
# limits are reached.
|
211
|
+
# {::Google::Cloud::Scheduler::V1beta1::RetryConfig#retry_count retry_count}, the
|
212
|
+
# job will be retried until both limits are reached.
|
188
213
|
#
|
189
214
|
# The default value for max_retry_duration is zero, which means retry
|
190
215
|
# duration is unlimited.
|
@@ -205,20 +230,25 @@ module Google
|
|
205
230
|
# The time between retries will double `max_doublings` times.
|
206
231
|
#
|
207
232
|
# A job's retry interval starts at
|
208
|
-
# {::Google::Cloud::Scheduler::V1beta1::RetryConfig#min_backoff_duration min_backoff_duration},
|
209
|
-
# `max_doublings` times, then increases linearly, and finally
|
210
|
-
# retries
|
211
|
-
# {::Google::Cloud::Scheduler::V1beta1::RetryConfig#max_backoff_duration max_backoff_duration}
|
212
|
-
# {::Google::Cloud::Scheduler::V1beta1::RetryConfig#retry_count retry_count}
|
213
|
-
#
|
214
|
-
#
|
215
|
-
#
|
216
|
-
#
|
217
|
-
#
|
218
|
-
#
|
219
|
-
#
|
220
|
-
#
|
221
|
-
#
|
233
|
+
# {::Google::Cloud::Scheduler::V1beta1::RetryConfig#min_backoff_duration min_backoff_duration},
|
234
|
+
# then doubles `max_doublings` times, then increases linearly, and finally
|
235
|
+
# retries at intervals of
|
236
|
+
# {::Google::Cloud::Scheduler::V1beta1::RetryConfig#max_backoff_duration max_backoff_duration}
|
237
|
+
# up to {::Google::Cloud::Scheduler::V1beta1::RetryConfig#retry_count retry_count}
|
238
|
+
# times.
|
239
|
+
#
|
240
|
+
# For example, if
|
241
|
+
# {::Google::Cloud::Scheduler::V1beta1::RetryConfig#min_backoff_duration min_backoff_duration}
|
242
|
+
# is 10s,
|
243
|
+
# {::Google::Cloud::Scheduler::V1beta1::RetryConfig#max_backoff_duration max_backoff_duration}
|
244
|
+
# is 300s, and `max_doublings` is 3, then the a job will first be retried in
|
245
|
+
# 10s. The retry interval will double three times, and then increase linearly
|
246
|
+
# by 2^3 * 10s. Finally, the job will retry at intervals of
|
247
|
+
# {::Google::Cloud::Scheduler::V1beta1::RetryConfig#max_backoff_duration max_backoff_duration}
|
248
|
+
# until the job has been attempted
|
249
|
+
# {::Google::Cloud::Scheduler::V1beta1::RetryConfig#retry_count retry_count}
|
250
|
+
# times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s,
|
251
|
+
# 300s, 300s, ....
|
222
252
|
#
|
223
253
|
# The default value of this field is 5.
|
224
254
|
class RetryConfig
|
@@ -22,8 +22,9 @@ module Google
|
|
22
22
|
module Scheduler
|
23
23
|
module V1beta1
|
24
24
|
# Http target. The job will be pushed to the job handler by means of
|
25
|
-
# an HTTP request via an
|
26
|
-
#
|
25
|
+
# an HTTP request via an
|
26
|
+
# {::Google::Cloud::Scheduler::V1beta1::HttpTarget#http_method http_method} such as
|
27
|
+
# HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP
|
27
28
|
# response code in the range [200 - 299]. A failure to receive a response
|
28
29
|
# constitutes a failed execution. For a redirected request, the response
|
29
30
|
# returned by the redirected request is considered.
|
@@ -53,6 +54,11 @@ module Google
|
|
53
54
|
# * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.
|
54
55
|
# * `X-Google-*`: Google internal use only.
|
55
56
|
# * `X-AppEngine-*`: Google internal use only.
|
57
|
+
# * `X-CloudScheduler`: This header will be set to true.
|
58
|
+
# * `X-CloudScheduler-JobName`: This header will contain the job name.
|
59
|
+
# * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
|
60
|
+
# the unix-cron format, this header will contain the job schedule time in
|
61
|
+
# RFC3339 UTC "Zulu" format.
|
56
62
|
#
|
57
63
|
# The total size of headers must be less than 80KB.
|
58
64
|
# @!attribute [rw] body
|
@@ -94,14 +100,14 @@ module Google
|
|
94
100
|
end
|
95
101
|
|
96
102
|
# App Engine target. The job will be pushed to a job handler by means
|
97
|
-
# of an HTTP request via an
|
98
|
-
#
|
99
|
-
# HTTP
|
100
|
-
#
|
101
|
-
# error. Requests returning error 503
|
102
|
-
# retry configuration and not counted against
|
103
|
-
# response code, or a failure to receive a response
|
104
|
-
# deadline, constitutes a failed attempt.
|
103
|
+
# of an HTTP request via an
|
104
|
+
# {::Google::Cloud::Scheduler::V1beta1::AppEngineHttpTarget#http_method http_method}
|
105
|
+
# such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP
|
106
|
+
# response code in the range [200 - 299]. Error 503 is considered an App Engine
|
107
|
+
# system error instead of an application error. Requests returning error 503
|
108
|
+
# will be retried regardless of retry configuration and not counted against
|
109
|
+
# retry counts. Any other response code, or a failure to receive a response
|
110
|
+
# before the deadline, constitutes a failed attempt.
|
105
111
|
# @!attribute [rw] http_method
|
106
112
|
# @return [::Google::Cloud::Scheduler::V1beta1::HttpMethod]
|
107
113
|
# The HTTP method to use for the request. PATCH and OPTIONS are not
|
@@ -132,9 +138,14 @@ module Google
|
|
132
138
|
# `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
|
133
139
|
# modified `User-Agent`.
|
134
140
|
# * `X-CloudScheduler`: This header will be set to true.
|
141
|
+
# * `X-CloudScheduler-JobName`: This header will contain the job name.
|
142
|
+
# * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
|
143
|
+
# the unix-cron format, this header will contain the job schedule time in
|
144
|
+
# RFC3339 UTC "Zulu" format.
|
135
145
|
#
|
136
|
-
# If the job has an
|
137
|
-
#
|
146
|
+
# If the job has an
|
147
|
+
# {::Google::Cloud::Scheduler::V1beta1::AppEngineHttpTarget#body body}, Cloud
|
148
|
+
# Scheduler sets the following headers:
|
138
149
|
#
|
139
150
|
# * `Content-Type`: By default, the `Content-Type` header is set to
|
140
151
|
# `"application/octet-stream"`. The default can be overridden by explictly
|
@@ -157,7 +168,8 @@ module Google
|
|
157
168
|
#
|
158
169
|
# HTTP request body. A request body is allowed only if the HTTP method is
|
159
170
|
# POST or PUT. It will result in invalid argument error to set a body on a
|
160
|
-
# job with an incompatible
|
171
|
+
# job with an incompatible
|
172
|
+
# {::Google::Cloud::Scheduler::V1beta1::HttpMethod HttpMethod}.
|
161
173
|
class AppEngineHttpTarget
|
162
174
|
include ::Google::Protobuf::MessageExts
|
163
175
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -178,7 +190,7 @@ module Google
|
|
178
190
|
# @return [::String]
|
179
191
|
# Required. The name of the Cloud Pub/Sub topic to which messages will
|
180
192
|
# be published when a job is delivered. The topic name must be in the
|
181
|
-
# same format as required by
|
193
|
+
# same format as required by Pub/Sub's
|
182
194
|
# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),
|
183
195
|
# for example `projects/PROJECT_ID/topics/TOPIC_ID`.
|
184
196
|
#
|
@@ -241,7 +253,7 @@ module Google
|
|
241
253
|
#
|
242
254
|
# Requests can only be sent to a specific instance if
|
243
255
|
# [manual scaling is used in App Engine
|
244
|
-
# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine
|
256
|
+
# Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?#scaling_types_and_instance_classes).
|
245
257
|
# App Engine Flex does not support instances. For more information, see
|
246
258
|
# [App Engine Standard request
|
247
259
|
# routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
|
@@ -270,43 +282,51 @@ module Google
|
|
270
282
|
# example <app-id>.appspot.com, which is associated with the
|
271
283
|
# job's project ID.
|
272
284
|
#
|
273
|
-
# * `service =`
|
285
|
+
# * `service =`
|
286
|
+
# {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#service service}
|
274
287
|
#
|
275
|
-
# * `version =`
|
288
|
+
# * `version =`
|
289
|
+
# {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#version version}
|
276
290
|
#
|
277
291
|
# * `version_dot_service =`
|
278
|
-
# {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#version version} `+ '.'
|
279
|
-
#
|
292
|
+
# {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#version version} `+ '.'
|
293
|
+
# +` [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service]
|
280
294
|
#
|
281
|
-
# * `instance =`
|
295
|
+
# * `instance =`
|
296
|
+
# {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#instance instance}
|
282
297
|
#
|
283
298
|
# * `instance_dot_service =`
|
284
|
-
# {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#instance instance} `+
|
285
|
-
#
|
299
|
+
# {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#instance instance} `+
|
300
|
+
# '.' +` [service][google.cloud.scheduler.v1beta1.AppEngineRouting.service]
|
286
301
|
#
|
287
302
|
# * `instance_dot_version =`
|
288
|
-
# {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#instance instance} `+
|
289
|
-
#
|
303
|
+
# {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#instance instance} `+
|
304
|
+
# '.' +` [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version]
|
290
305
|
#
|
291
306
|
# * `instance_dot_version_dot_service =`
|
292
|
-
# {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#instance instance} `+
|
293
|
-
#
|
307
|
+
# {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#instance instance} `+
|
308
|
+
# '.' +` [version][google.cloud.scheduler.v1beta1.AppEngineRouting.version]
|
309
|
+
# `+ '.' +`
|
294
310
|
# {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#service service}
|
295
311
|
#
|
296
312
|
#
|
297
|
-
# If {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#service service} is
|
298
|
-
# to the service which is the default
|
313
|
+
# If {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#service service} is
|
314
|
+
# empty, then the job will be sent to the service which is the default
|
315
|
+
# service when the job is attempted.
|
299
316
|
#
|
300
|
-
# If {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#version version} is
|
301
|
-
# to the version which is the default
|
317
|
+
# If {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#version version} is
|
318
|
+
# empty, then the job will be sent to the version which is the default
|
319
|
+
# version when the job is attempted.
|
302
320
|
#
|
303
|
-
# If {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#instance instance} is
|
304
|
-
# sent to an instance which is available when the
|
321
|
+
# If {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#instance instance} is
|
322
|
+
# empty, then the job will be sent to an instance which is available when the
|
323
|
+
# job is attempted.
|
305
324
|
#
|
306
325
|
# If {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#service service},
|
307
326
|
# {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#version version}, or
|
308
|
-
# {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#instance instance} is
|
309
|
-
#
|
327
|
+
# {::Google::Cloud::Scheduler::V1beta1::AppEngineRouting#instance instance} is
|
328
|
+
# invalid, then the job will be sent to the default version of the default
|
329
|
+
# service when the job is attempted.
|
310
330
|
class AppEngineRouting
|
311
331
|
include ::Google::Protobuf::MessageExts
|
312
332
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -26,8 +26,6 @@ module Google
|
|
26
26
|
# service Foo {
|
27
27
|
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
28
28
|
# }
|
29
|
-
#
|
30
|
-
# The JSON representation for `Empty` is empty JSON object `{}`.
|
31
29
|
class Empty
|
32
30
|
include ::Google::Protobuf::MessageExts
|
33
31
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -28,12 +28,14 @@ module Google
|
|
28
28
|
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
29
29
|
# @!attribute [rw] code
|
30
30
|
# @return [::Integer]
|
31
|
-
# The status code, which should be an enum value of
|
31
|
+
# The status code, which should be an enum value of
|
32
|
+
# [google.rpc.Code][google.rpc.Code].
|
32
33
|
# @!attribute [rw] message
|
33
34
|
# @return [::String]
|
34
35
|
# A developer-facing error message, which should be in English. Any
|
35
36
|
# user-facing error message should be localized and sent in the
|
36
|
-
# {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
|
37
|
+
# {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
|
38
|
+
# by the client.
|
37
39
|
# @!attribute [rw] details
|
38
40
|
# @return [::Array<::Google::Protobuf::Any>]
|
39
41
|
# A list of messages that carry the error details. There is a common set of
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-scheduler-v1beta1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.7.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2023-03-08 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,7 +16,7 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version:
|
19
|
+
version: 0.18.0
|
20
20
|
- - "<"
|
21
21
|
- !ruby/object:Gem::Version
|
22
22
|
version: 2.a
|
@@ -26,7 +26,7 @@ dependencies:
|
|
26
26
|
requirements:
|
27
27
|
- - ">="
|
28
28
|
- !ruby/object:Gem::Version
|
29
|
-
version:
|
29
|
+
version: 0.18.0
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -44,20 +44,40 @@ dependencies:
|
|
44
44
|
- - "~>"
|
45
45
|
- !ruby/object:Gem::Version
|
46
46
|
version: '1.0'
|
47
|
+
- !ruby/object:Gem::Dependency
|
48
|
+
name: google-cloud-location
|
49
|
+
requirement: !ruby/object:Gem::Requirement
|
50
|
+
requirements:
|
51
|
+
- - ">="
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: '0.4'
|
54
|
+
- - "<"
|
55
|
+
- !ruby/object:Gem::Version
|
56
|
+
version: 2.a
|
57
|
+
type: :runtime
|
58
|
+
prerelease: false
|
59
|
+
version_requirements: !ruby/object:Gem::Requirement
|
60
|
+
requirements:
|
61
|
+
- - ">="
|
62
|
+
- !ruby/object:Gem::Version
|
63
|
+
version: '0.4'
|
64
|
+
- - "<"
|
65
|
+
- !ruby/object:Gem::Version
|
66
|
+
version: 2.a
|
47
67
|
- !ruby/object:Gem::Dependency
|
48
68
|
name: google-style
|
49
69
|
requirement: !ruby/object:Gem::Requirement
|
50
70
|
requirements:
|
51
71
|
- - "~>"
|
52
72
|
- !ruby/object:Gem::Version
|
53
|
-
version: 1.26.
|
73
|
+
version: 1.26.3
|
54
74
|
type: :development
|
55
75
|
prerelease: false
|
56
76
|
version_requirements: !ruby/object:Gem::Requirement
|
57
77
|
requirements:
|
58
78
|
- - "~>"
|
59
79
|
- !ruby/object:Gem::Version
|
60
|
-
version: 1.26.
|
80
|
+
version: 1.26.3
|
61
81
|
- !ruby/object:Gem::Dependency
|
62
82
|
name: minitest
|
63
83
|
requirement: !ruby/object:Gem::Requirement
|
@@ -175,17 +195,24 @@ files:
|
|
175
195
|
- README.md
|
176
196
|
- lib/google-cloud-scheduler-v1beta1.rb
|
177
197
|
- lib/google/cloud/scheduler/v1beta1.rb
|
198
|
+
- lib/google/cloud/scheduler/v1beta1/bindings_override.rb
|
178
199
|
- lib/google/cloud/scheduler/v1beta1/cloud_scheduler.rb
|
179
200
|
- lib/google/cloud/scheduler/v1beta1/cloud_scheduler/client.rb
|
180
201
|
- lib/google/cloud/scheduler/v1beta1/cloud_scheduler/credentials.rb
|
181
202
|
- lib/google/cloud/scheduler/v1beta1/cloud_scheduler/paths.rb
|
203
|
+
- lib/google/cloud/scheduler/v1beta1/cloud_scheduler/rest.rb
|
204
|
+
- lib/google/cloud/scheduler/v1beta1/cloud_scheduler/rest/client.rb
|
205
|
+
- lib/google/cloud/scheduler/v1beta1/cloud_scheduler/rest/service_stub.rb
|
182
206
|
- lib/google/cloud/scheduler/v1beta1/cloudscheduler_pb.rb
|
183
207
|
- lib/google/cloud/scheduler/v1beta1/cloudscheduler_services_pb.rb
|
184
208
|
- lib/google/cloud/scheduler/v1beta1/job_pb.rb
|
209
|
+
- lib/google/cloud/scheduler/v1beta1/rest.rb
|
185
210
|
- lib/google/cloud/scheduler/v1beta1/target_pb.rb
|
186
211
|
- lib/google/cloud/scheduler/v1beta1/version.rb
|
187
212
|
- proto_docs/README.md
|
213
|
+
- proto_docs/google/api/client.rb
|
188
214
|
- proto_docs/google/api/field_behavior.rb
|
215
|
+
- proto_docs/google/api/launch_stage.rb
|
189
216
|
- proto_docs/google/api/resource.rb
|
190
217
|
- proto_docs/google/cloud/scheduler/v1beta1/cloudscheduler.rb
|
191
218
|
- proto_docs/google/cloud/scheduler/v1beta1/job.rb
|
@@ -215,8 +242,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
215
242
|
- !ruby/object:Gem::Version
|
216
243
|
version: '0'
|
217
244
|
requirements: []
|
218
|
-
rubygems_version: 3.
|
245
|
+
rubygems_version: 3.4.2
|
219
246
|
signing_key:
|
220
247
|
specification_version: 4
|
221
|
-
summary:
|
248
|
+
summary: Creates and manages jobs run on a regular recurring schedule.
|
222
249
|
test_files: []
|