google-cloud-scheduler-v1 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/v1/bindings_override.rb +102 -0
- data/lib/google/cloud/scheduler/v1/cloud_scheduler/client.rb +49 -25
- data/lib/google/cloud/scheduler/v1/cloud_scheduler/rest/client.rb +943 -0
- data/lib/google/cloud/scheduler/v1/cloud_scheduler/rest/service_stub.rb +525 -0
- data/lib/google/cloud/scheduler/v1/cloud_scheduler/rest.rb +54 -0
- data/lib/google/cloud/scheduler/v1/cloud_scheduler.rb +7 -1
- data/lib/google/cloud/scheduler/v1/cloudscheduler_services_pb.rb +21 -15
- data/lib/google/cloud/scheduler/v1/job_pb.rb +0 -1
- data/lib/google/cloud/scheduler/v1/rest.rb +38 -0
- data/lib/google/cloud/scheduler/v1/target_pb.rb +0 -1
- data/lib/google/cloud/scheduler/v1/version.rb +1 -1
- data/lib/google/cloud/scheduler/v1.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/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/empty.rb +0 -2
- data/proto_docs/google/rpc/status.rb +4 -2
- metadata +35 -8
@@ -0,0 +1,525 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2023 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
|
+
require "google/cloud/scheduler/v1/cloudscheduler_pb"
|
20
|
+
|
21
|
+
module Google
|
22
|
+
module Cloud
|
23
|
+
module Scheduler
|
24
|
+
module V1
|
25
|
+
module CloudScheduler
|
26
|
+
module Rest
|
27
|
+
##
|
28
|
+
# REST service stub for the CloudScheduler service.
|
29
|
+
# Service stub contains baseline method implementations
|
30
|
+
# including transcoding, making the REST call, and deserialing the response.
|
31
|
+
#
|
32
|
+
class ServiceStub
|
33
|
+
def initialize endpoint:, credentials:
|
34
|
+
# These require statements are intentionally placed here to initialize
|
35
|
+
# the REST modules only when it's required.
|
36
|
+
require "gapic/rest"
|
37
|
+
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
|
39
|
+
numeric_enums: true,
|
40
|
+
raise_faraday_errors: false
|
41
|
+
end
|
42
|
+
|
43
|
+
##
|
44
|
+
# Baseline implementation for the list_jobs REST call
|
45
|
+
#
|
46
|
+
# @param request_pb [::Google::Cloud::Scheduler::V1::ListJobsRequest]
|
47
|
+
# A request object representing the call parameters. Required.
|
48
|
+
# @param options [::Gapic::CallOptions]
|
49
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
50
|
+
#
|
51
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
52
|
+
# @yieldparam result [::Google::Cloud::Scheduler::V1::ListJobsResponse]
|
53
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
54
|
+
#
|
55
|
+
# @return [::Google::Cloud::Scheduler::V1::ListJobsResponse]
|
56
|
+
# A result object deserialized from the server's reply
|
57
|
+
def list_jobs request_pb, options = nil
|
58
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
59
|
+
|
60
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_list_jobs_request request_pb
|
61
|
+
query_string_params = if query_string_params.any?
|
62
|
+
query_string_params.to_h { |p| p.split("=", 2) }
|
63
|
+
else
|
64
|
+
{}
|
65
|
+
end
|
66
|
+
|
67
|
+
response = @client_stub.make_http_request(
|
68
|
+
verb,
|
69
|
+
uri: uri,
|
70
|
+
body: body || "",
|
71
|
+
params: query_string_params,
|
72
|
+
options: options
|
73
|
+
)
|
74
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
75
|
+
result = ::Google::Cloud::Scheduler::V1::ListJobsResponse.decode_json response.body, ignore_unknown_fields: true
|
76
|
+
|
77
|
+
yield result, operation if block_given?
|
78
|
+
result
|
79
|
+
end
|
80
|
+
|
81
|
+
##
|
82
|
+
# Baseline implementation for the get_job REST call
|
83
|
+
#
|
84
|
+
# @param request_pb [::Google::Cloud::Scheduler::V1::GetJobRequest]
|
85
|
+
# A request object representing the call parameters. Required.
|
86
|
+
# @param options [::Gapic::CallOptions]
|
87
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
88
|
+
#
|
89
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
90
|
+
# @yieldparam result [::Google::Cloud::Scheduler::V1::Job]
|
91
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
92
|
+
#
|
93
|
+
# @return [::Google::Cloud::Scheduler::V1::Job]
|
94
|
+
# A result object deserialized from the server's reply
|
95
|
+
def get_job request_pb, options = nil
|
96
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
97
|
+
|
98
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_get_job_request request_pb
|
99
|
+
query_string_params = if query_string_params.any?
|
100
|
+
query_string_params.to_h { |p| p.split("=", 2) }
|
101
|
+
else
|
102
|
+
{}
|
103
|
+
end
|
104
|
+
|
105
|
+
response = @client_stub.make_http_request(
|
106
|
+
verb,
|
107
|
+
uri: uri,
|
108
|
+
body: body || "",
|
109
|
+
params: query_string_params,
|
110
|
+
options: options
|
111
|
+
)
|
112
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
113
|
+
result = ::Google::Cloud::Scheduler::V1::Job.decode_json response.body, ignore_unknown_fields: true
|
114
|
+
|
115
|
+
yield result, operation if block_given?
|
116
|
+
result
|
117
|
+
end
|
118
|
+
|
119
|
+
##
|
120
|
+
# Baseline implementation for the create_job REST call
|
121
|
+
#
|
122
|
+
# @param request_pb [::Google::Cloud::Scheduler::V1::CreateJobRequest]
|
123
|
+
# A request object representing the call parameters. Required.
|
124
|
+
# @param options [::Gapic::CallOptions]
|
125
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
126
|
+
#
|
127
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
128
|
+
# @yieldparam result [::Google::Cloud::Scheduler::V1::Job]
|
129
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
130
|
+
#
|
131
|
+
# @return [::Google::Cloud::Scheduler::V1::Job]
|
132
|
+
# A result object deserialized from the server's reply
|
133
|
+
def create_job request_pb, options = nil
|
134
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
135
|
+
|
136
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_create_job_request request_pb
|
137
|
+
query_string_params = if query_string_params.any?
|
138
|
+
query_string_params.to_h { |p| p.split("=", 2) }
|
139
|
+
else
|
140
|
+
{}
|
141
|
+
end
|
142
|
+
|
143
|
+
response = @client_stub.make_http_request(
|
144
|
+
verb,
|
145
|
+
uri: uri,
|
146
|
+
body: body || "",
|
147
|
+
params: query_string_params,
|
148
|
+
options: options
|
149
|
+
)
|
150
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
151
|
+
result = ::Google::Cloud::Scheduler::V1::Job.decode_json response.body, ignore_unknown_fields: true
|
152
|
+
|
153
|
+
yield result, operation if block_given?
|
154
|
+
result
|
155
|
+
end
|
156
|
+
|
157
|
+
##
|
158
|
+
# Baseline implementation for the update_job REST call
|
159
|
+
#
|
160
|
+
# @param request_pb [::Google::Cloud::Scheduler::V1::UpdateJobRequest]
|
161
|
+
# A request object representing the call parameters. Required.
|
162
|
+
# @param options [::Gapic::CallOptions]
|
163
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
164
|
+
#
|
165
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
166
|
+
# @yieldparam result [::Google::Cloud::Scheduler::V1::Job]
|
167
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
168
|
+
#
|
169
|
+
# @return [::Google::Cloud::Scheduler::V1::Job]
|
170
|
+
# A result object deserialized from the server's reply
|
171
|
+
def update_job request_pb, options = nil
|
172
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
173
|
+
|
174
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_update_job_request request_pb
|
175
|
+
query_string_params = if query_string_params.any?
|
176
|
+
query_string_params.to_h { |p| p.split("=", 2) }
|
177
|
+
else
|
178
|
+
{}
|
179
|
+
end
|
180
|
+
|
181
|
+
response = @client_stub.make_http_request(
|
182
|
+
verb,
|
183
|
+
uri: uri,
|
184
|
+
body: body || "",
|
185
|
+
params: query_string_params,
|
186
|
+
options: options
|
187
|
+
)
|
188
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
189
|
+
result = ::Google::Cloud::Scheduler::V1::Job.decode_json response.body, ignore_unknown_fields: true
|
190
|
+
|
191
|
+
yield result, operation if block_given?
|
192
|
+
result
|
193
|
+
end
|
194
|
+
|
195
|
+
##
|
196
|
+
# Baseline implementation for the delete_job REST call
|
197
|
+
#
|
198
|
+
# @param request_pb [::Google::Cloud::Scheduler::V1::DeleteJobRequest]
|
199
|
+
# A request object representing the call parameters. Required.
|
200
|
+
# @param options [::Gapic::CallOptions]
|
201
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
202
|
+
#
|
203
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
204
|
+
# @yieldparam result [::Google::Protobuf::Empty]
|
205
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
206
|
+
#
|
207
|
+
# @return [::Google::Protobuf::Empty]
|
208
|
+
# A result object deserialized from the server's reply
|
209
|
+
def delete_job request_pb, options = nil
|
210
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
211
|
+
|
212
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_delete_job_request request_pb
|
213
|
+
query_string_params = if query_string_params.any?
|
214
|
+
query_string_params.to_h { |p| p.split("=", 2) }
|
215
|
+
else
|
216
|
+
{}
|
217
|
+
end
|
218
|
+
|
219
|
+
response = @client_stub.make_http_request(
|
220
|
+
verb,
|
221
|
+
uri: uri,
|
222
|
+
body: body || "",
|
223
|
+
params: query_string_params,
|
224
|
+
options: options
|
225
|
+
)
|
226
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
227
|
+
result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
|
228
|
+
|
229
|
+
yield result, operation if block_given?
|
230
|
+
result
|
231
|
+
end
|
232
|
+
|
233
|
+
##
|
234
|
+
# Baseline implementation for the pause_job REST call
|
235
|
+
#
|
236
|
+
# @param request_pb [::Google::Cloud::Scheduler::V1::PauseJobRequest]
|
237
|
+
# A request object representing the call parameters. Required.
|
238
|
+
# @param options [::Gapic::CallOptions]
|
239
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
240
|
+
#
|
241
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
242
|
+
# @yieldparam result [::Google::Cloud::Scheduler::V1::Job]
|
243
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
244
|
+
#
|
245
|
+
# @return [::Google::Cloud::Scheduler::V1::Job]
|
246
|
+
# A result object deserialized from the server's reply
|
247
|
+
def pause_job request_pb, options = nil
|
248
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
249
|
+
|
250
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_pause_job_request request_pb
|
251
|
+
query_string_params = if query_string_params.any?
|
252
|
+
query_string_params.to_h { |p| p.split("=", 2) }
|
253
|
+
else
|
254
|
+
{}
|
255
|
+
end
|
256
|
+
|
257
|
+
response = @client_stub.make_http_request(
|
258
|
+
verb,
|
259
|
+
uri: uri,
|
260
|
+
body: body || "",
|
261
|
+
params: query_string_params,
|
262
|
+
options: options
|
263
|
+
)
|
264
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
265
|
+
result = ::Google::Cloud::Scheduler::V1::Job.decode_json response.body, ignore_unknown_fields: true
|
266
|
+
|
267
|
+
yield result, operation if block_given?
|
268
|
+
result
|
269
|
+
end
|
270
|
+
|
271
|
+
##
|
272
|
+
# Baseline implementation for the resume_job REST call
|
273
|
+
#
|
274
|
+
# @param request_pb [::Google::Cloud::Scheduler::V1::ResumeJobRequest]
|
275
|
+
# A request object representing the call parameters. Required.
|
276
|
+
# @param options [::Gapic::CallOptions]
|
277
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
278
|
+
#
|
279
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
280
|
+
# @yieldparam result [::Google::Cloud::Scheduler::V1::Job]
|
281
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
282
|
+
#
|
283
|
+
# @return [::Google::Cloud::Scheduler::V1::Job]
|
284
|
+
# A result object deserialized from the server's reply
|
285
|
+
def resume_job request_pb, options = nil
|
286
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
287
|
+
|
288
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_resume_job_request request_pb
|
289
|
+
query_string_params = if query_string_params.any?
|
290
|
+
query_string_params.to_h { |p| p.split("=", 2) }
|
291
|
+
else
|
292
|
+
{}
|
293
|
+
end
|
294
|
+
|
295
|
+
response = @client_stub.make_http_request(
|
296
|
+
verb,
|
297
|
+
uri: uri,
|
298
|
+
body: body || "",
|
299
|
+
params: query_string_params,
|
300
|
+
options: options
|
301
|
+
)
|
302
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
303
|
+
result = ::Google::Cloud::Scheduler::V1::Job.decode_json response.body, ignore_unknown_fields: true
|
304
|
+
|
305
|
+
yield result, operation if block_given?
|
306
|
+
result
|
307
|
+
end
|
308
|
+
|
309
|
+
##
|
310
|
+
# Baseline implementation for the run_job REST call
|
311
|
+
#
|
312
|
+
# @param request_pb [::Google::Cloud::Scheduler::V1::RunJobRequest]
|
313
|
+
# A request object representing the call parameters. Required.
|
314
|
+
# @param options [::Gapic::CallOptions]
|
315
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
316
|
+
#
|
317
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
318
|
+
# @yieldparam result [::Google::Cloud::Scheduler::V1::Job]
|
319
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
320
|
+
#
|
321
|
+
# @return [::Google::Cloud::Scheduler::V1::Job]
|
322
|
+
# A result object deserialized from the server's reply
|
323
|
+
def run_job request_pb, options = nil
|
324
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
325
|
+
|
326
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_run_job_request request_pb
|
327
|
+
query_string_params = if query_string_params.any?
|
328
|
+
query_string_params.to_h { |p| p.split("=", 2) }
|
329
|
+
else
|
330
|
+
{}
|
331
|
+
end
|
332
|
+
|
333
|
+
response = @client_stub.make_http_request(
|
334
|
+
verb,
|
335
|
+
uri: uri,
|
336
|
+
body: body || "",
|
337
|
+
params: query_string_params,
|
338
|
+
options: options
|
339
|
+
)
|
340
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
341
|
+
result = ::Google::Cloud::Scheduler::V1::Job.decode_json response.body, ignore_unknown_fields: true
|
342
|
+
|
343
|
+
yield result, operation if block_given?
|
344
|
+
result
|
345
|
+
end
|
346
|
+
|
347
|
+
##
|
348
|
+
# @private
|
349
|
+
#
|
350
|
+
# GRPC transcoding helper method for the list_jobs REST call
|
351
|
+
#
|
352
|
+
# @param request_pb [::Google::Cloud::Scheduler::V1::ListJobsRequest]
|
353
|
+
# A request object representing the call parameters. Required.
|
354
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
355
|
+
# Uri, Body, Query string parameters
|
356
|
+
def self.transcode_list_jobs_request request_pb
|
357
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
358
|
+
.with_bindings(
|
359
|
+
uri_method: :get,
|
360
|
+
uri_template: "/v1/{parent}/jobs",
|
361
|
+
matches: [
|
362
|
+
["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
|
363
|
+
]
|
364
|
+
)
|
365
|
+
transcoder.transcode request_pb
|
366
|
+
end
|
367
|
+
|
368
|
+
##
|
369
|
+
# @private
|
370
|
+
#
|
371
|
+
# GRPC transcoding helper method for the get_job REST call
|
372
|
+
#
|
373
|
+
# @param request_pb [::Google::Cloud::Scheduler::V1::GetJobRequest]
|
374
|
+
# A request object representing the call parameters. Required.
|
375
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
376
|
+
# Uri, Body, Query string parameters
|
377
|
+
def self.transcode_get_job_request request_pb
|
378
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
379
|
+
.with_bindings(
|
380
|
+
uri_method: :get,
|
381
|
+
uri_template: "/v1/{name}",
|
382
|
+
matches: [
|
383
|
+
["name", %r{^projects/[^/]+/locations/[^/]+/jobs/[^/]+/?$}, false]
|
384
|
+
]
|
385
|
+
)
|
386
|
+
transcoder.transcode request_pb
|
387
|
+
end
|
388
|
+
|
389
|
+
##
|
390
|
+
# @private
|
391
|
+
#
|
392
|
+
# GRPC transcoding helper method for the create_job REST call
|
393
|
+
#
|
394
|
+
# @param request_pb [::Google::Cloud::Scheduler::V1::CreateJobRequest]
|
395
|
+
# A request object representing the call parameters. Required.
|
396
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
397
|
+
# Uri, Body, Query string parameters
|
398
|
+
def self.transcode_create_job_request request_pb
|
399
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
400
|
+
.with_bindings(
|
401
|
+
uri_method: :post,
|
402
|
+
uri_template: "/v1/{parent}/jobs",
|
403
|
+
body: "job",
|
404
|
+
matches: [
|
405
|
+
["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
|
406
|
+
]
|
407
|
+
)
|
408
|
+
transcoder.transcode request_pb
|
409
|
+
end
|
410
|
+
|
411
|
+
##
|
412
|
+
# @private
|
413
|
+
#
|
414
|
+
# GRPC transcoding helper method for the update_job REST call
|
415
|
+
#
|
416
|
+
# @param request_pb [::Google::Cloud::Scheduler::V1::UpdateJobRequest]
|
417
|
+
# A request object representing the call parameters. Required.
|
418
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
419
|
+
# Uri, Body, Query string parameters
|
420
|
+
def self.transcode_update_job_request request_pb
|
421
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
422
|
+
.with_bindings(
|
423
|
+
uri_method: :patch,
|
424
|
+
uri_template: "/v1/{job.name}",
|
425
|
+
body: "job",
|
426
|
+
matches: [
|
427
|
+
["job.name", %r{^projects/[^/]+/locations/[^/]+/jobs/[^/]+/?$}, false]
|
428
|
+
]
|
429
|
+
)
|
430
|
+
transcoder.transcode request_pb
|
431
|
+
end
|
432
|
+
|
433
|
+
##
|
434
|
+
# @private
|
435
|
+
#
|
436
|
+
# GRPC transcoding helper method for the delete_job REST call
|
437
|
+
#
|
438
|
+
# @param request_pb [::Google::Cloud::Scheduler::V1::DeleteJobRequest]
|
439
|
+
# A request object representing the call parameters. Required.
|
440
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
441
|
+
# Uri, Body, Query string parameters
|
442
|
+
def self.transcode_delete_job_request request_pb
|
443
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
444
|
+
.with_bindings(
|
445
|
+
uri_method: :delete,
|
446
|
+
uri_template: "/v1/{name}",
|
447
|
+
matches: [
|
448
|
+
["name", %r{^projects/[^/]+/locations/[^/]+/jobs/[^/]+/?$}, false]
|
449
|
+
]
|
450
|
+
)
|
451
|
+
transcoder.transcode request_pb
|
452
|
+
end
|
453
|
+
|
454
|
+
##
|
455
|
+
# @private
|
456
|
+
#
|
457
|
+
# GRPC transcoding helper method for the pause_job REST call
|
458
|
+
#
|
459
|
+
# @param request_pb [::Google::Cloud::Scheduler::V1::PauseJobRequest]
|
460
|
+
# A request object representing the call parameters. Required.
|
461
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
462
|
+
# Uri, Body, Query string parameters
|
463
|
+
def self.transcode_pause_job_request request_pb
|
464
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
465
|
+
.with_bindings(
|
466
|
+
uri_method: :post,
|
467
|
+
uri_template: "/v1/{name}:pause",
|
468
|
+
body: "*",
|
469
|
+
matches: [
|
470
|
+
["name", %r{^projects/[^/]+/locations/[^/]+/jobs/[^/]+/?$}, false]
|
471
|
+
]
|
472
|
+
)
|
473
|
+
transcoder.transcode request_pb
|
474
|
+
end
|
475
|
+
|
476
|
+
##
|
477
|
+
# @private
|
478
|
+
#
|
479
|
+
# GRPC transcoding helper method for the resume_job REST call
|
480
|
+
#
|
481
|
+
# @param request_pb [::Google::Cloud::Scheduler::V1::ResumeJobRequest]
|
482
|
+
# A request object representing the call parameters. Required.
|
483
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
484
|
+
# Uri, Body, Query string parameters
|
485
|
+
def self.transcode_resume_job_request request_pb
|
486
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
487
|
+
.with_bindings(
|
488
|
+
uri_method: :post,
|
489
|
+
uri_template: "/v1/{name}:resume",
|
490
|
+
body: "*",
|
491
|
+
matches: [
|
492
|
+
["name", %r{^projects/[^/]+/locations/[^/]+/jobs/[^/]+/?$}, false]
|
493
|
+
]
|
494
|
+
)
|
495
|
+
transcoder.transcode request_pb
|
496
|
+
end
|
497
|
+
|
498
|
+
##
|
499
|
+
# @private
|
500
|
+
#
|
501
|
+
# GRPC transcoding helper method for the run_job REST call
|
502
|
+
#
|
503
|
+
# @param request_pb [::Google::Cloud::Scheduler::V1::RunJobRequest]
|
504
|
+
# A request object representing the call parameters. Required.
|
505
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
506
|
+
# Uri, Body, Query string parameters
|
507
|
+
def self.transcode_run_job_request request_pb
|
508
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
509
|
+
.with_bindings(
|
510
|
+
uri_method: :post,
|
511
|
+
uri_template: "/v1/{name}:run",
|
512
|
+
body: "*",
|
513
|
+
matches: [
|
514
|
+
["name", %r{^projects/[^/]+/locations/[^/]+/jobs/[^/]+/?$}, false]
|
515
|
+
]
|
516
|
+
)
|
517
|
+
transcoder.transcode request_pb
|
518
|
+
end
|
519
|
+
end
|
520
|
+
end
|
521
|
+
end
|
522
|
+
end
|
523
|
+
end
|
524
|
+
end
|
525
|
+
end
|
@@ -0,0 +1,54 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2023 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
|
+
require "gapic/rest"
|
20
|
+
require "gapic/config"
|
21
|
+
require "gapic/config/method"
|
22
|
+
|
23
|
+
require "google/cloud/scheduler/v1/version"
|
24
|
+
require "google/cloud/scheduler/v1/bindings_override"
|
25
|
+
|
26
|
+
require "google/cloud/scheduler/v1/cloud_scheduler/credentials"
|
27
|
+
require "google/cloud/scheduler/v1/cloud_scheduler/paths"
|
28
|
+
require "google/cloud/scheduler/v1/cloud_scheduler/rest/client"
|
29
|
+
|
30
|
+
module Google
|
31
|
+
module Cloud
|
32
|
+
module Scheduler
|
33
|
+
module V1
|
34
|
+
##
|
35
|
+
# The Cloud Scheduler API allows external entities to reliably
|
36
|
+
# schedule asynchronous jobs.
|
37
|
+
#
|
38
|
+
# To load this service and instantiate a REST client:
|
39
|
+
#
|
40
|
+
# require "google/cloud/scheduler/v1/cloud_scheduler/rest"
|
41
|
+
# client = ::Google::Cloud::Scheduler::V1::CloudScheduler::Rest::Client.new
|
42
|
+
#
|
43
|
+
module CloudScheduler
|
44
|
+
# Client for the REST transport
|
45
|
+
module Rest
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
53
|
+
helper_path = ::File.join __dir__, "rest", "helpers.rb"
|
54
|
+
require "google/cloud/scheduler/v1/cloud_scheduler/rest/helpers" if ::File.file? helper_path
|
@@ -25,6 +25,7 @@ require "google/cloud/scheduler/v1/version"
|
|
25
25
|
require "google/cloud/scheduler/v1/cloud_scheduler/credentials"
|
26
26
|
require "google/cloud/scheduler/v1/cloud_scheduler/paths"
|
27
27
|
require "google/cloud/scheduler/v1/cloud_scheduler/client"
|
28
|
+
require "google/cloud/scheduler/v1/cloud_scheduler/rest"
|
28
29
|
|
29
30
|
module Google
|
30
31
|
module Cloud
|
@@ -34,11 +35,16 @@ module Google
|
|
34
35
|
# The Cloud Scheduler API allows external entities to reliably
|
35
36
|
# schedule asynchronous jobs.
|
36
37
|
#
|
37
|
-
#
|
38
|
+
# @example Load this service and instantiate a gRPC client
|
38
39
|
#
|
39
40
|
# require "google/cloud/scheduler/v1/cloud_scheduler"
|
40
41
|
# client = ::Google::Cloud::Scheduler::V1::CloudScheduler::Client.new
|
41
42
|
#
|
43
|
+
# @example Load this service and instantiate a REST client
|
44
|
+
#
|
45
|
+
# require "google/cloud/scheduler/v1/cloud_scheduler/rest"
|
46
|
+
# client = ::Google::Cloud::Scheduler::V1::CloudScheduler::Rest::Client.new
|
47
|
+
#
|
42
48
|
module CloudScheduler
|
43
49
|
end
|
44
50
|
end
|
@@ -1,7 +1,7 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# Source: google/cloud/scheduler/v1/cloudscheduler.proto for package 'google.cloud.scheduler.v1'
|
3
3
|
# Original file comments:
|
4
|
-
# Copyright
|
4
|
+
# Copyright 2022 Google LLC
|
5
5
|
#
|
6
6
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
7
7
|
# you may not use this file except in compliance with the License.
|
@@ -15,7 +15,6 @@
|
|
15
15
|
# See the License for the specific language governing permissions and
|
16
16
|
# limitations under the License.
|
17
17
|
#
|
18
|
-
#
|
19
18
|
|
20
19
|
require 'grpc'
|
21
20
|
require 'google/cloud/scheduler/v1/cloudscheduler_pb'
|
@@ -43,30 +42,37 @@ module Google
|
|
43
42
|
rpc :CreateJob, ::Google::Cloud::Scheduler::V1::CreateJobRequest, ::Google::Cloud::Scheduler::V1::Job
|
44
43
|
# Updates a job.
|
45
44
|
#
|
46
|
-
# If successful, the updated [Job][google.cloud.scheduler.v1.Job] is
|
47
|
-
# not exist, `NOT_FOUND` is returned.
|
45
|
+
# If successful, the updated [Job][google.cloud.scheduler.v1.Job] is
|
46
|
+
# returned. If the job does not exist, `NOT_FOUND` is returned.
|
48
47
|
#
|
49
48
|
# If UpdateJob does not successfully return, it is possible for the
|
50
|
-
# job to be in an
|
51
|
-
#
|
52
|
-
#
|
49
|
+
# job to be in an
|
50
|
+
# [Job.State.UPDATE_FAILED][google.cloud.scheduler.v1.Job.State.UPDATE_FAILED]
|
51
|
+
# state. A job in this state may not be executed. If this happens, retry the
|
52
|
+
# UpdateJob request until a successful response is received.
|
53
53
|
rpc :UpdateJob, ::Google::Cloud::Scheduler::V1::UpdateJobRequest, ::Google::Cloud::Scheduler::V1::Job
|
54
54
|
# Deletes a job.
|
55
55
|
rpc :DeleteJob, ::Google::Cloud::Scheduler::V1::DeleteJobRequest, ::Google::Protobuf::Empty
|
56
56
|
# Pauses a job.
|
57
57
|
#
|
58
58
|
# If a job is paused then the system will stop executing the job
|
59
|
-
# until it is re-enabled via
|
60
|
-
#
|
61
|
-
#
|
62
|
-
#
|
59
|
+
# until it is re-enabled via
|
60
|
+
# [ResumeJob][google.cloud.scheduler.v1.CloudScheduler.ResumeJob]. The state
|
61
|
+
# of the job is stored in [state][google.cloud.scheduler.v1.Job.state]; if
|
62
|
+
# paused it will be set to
|
63
|
+
# [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. A job must
|
64
|
+
# be in [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED] to
|
65
|
+
# be paused.
|
63
66
|
rpc :PauseJob, ::Google::Cloud::Scheduler::V1::PauseJobRequest, ::Google::Cloud::Scheduler::V1::Job
|
64
67
|
# Resume a job.
|
65
68
|
#
|
66
|
-
# This method reenables a job after it has been
|
67
|
-
#
|
68
|
-
#
|
69
|
-
#
|
69
|
+
# This method reenables a job after it has been
|
70
|
+
# [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]. The state
|
71
|
+
# of a job is stored in [Job.state][google.cloud.scheduler.v1.Job.state];
|
72
|
+
# after calling this method it will be set to
|
73
|
+
# [Job.State.ENABLED][google.cloud.scheduler.v1.Job.State.ENABLED]. A job
|
74
|
+
# must be in [Job.State.PAUSED][google.cloud.scheduler.v1.Job.State.PAUSED]
|
75
|
+
# to be resumed.
|
70
76
|
rpc :ResumeJob, ::Google::Cloud::Scheduler::V1::ResumeJobRequest, ::Google::Cloud::Scheduler::V1::Job
|
71
77
|
# Forces a job to run now.
|
72
78
|
#
|