google-cloud-tasks-v2 0.6.0 → 0.7.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1002 @@
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/tasks/v2/cloudtasks_pb"
20
+
21
+ module Google
22
+ module Cloud
23
+ module Tasks
24
+ module V2
25
+ module CloudTasks
26
+ module Rest
27
+ ##
28
+ # REST service stub for the CloudTasks 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_queues REST call
45
+ #
46
+ # @param request_pb [::Google::Cloud::Tasks::V2::ListQueuesRequest]
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::Tasks::V2::ListQueuesResponse]
53
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
54
+ #
55
+ # @return [::Google::Cloud::Tasks::V2::ListQueuesResponse]
56
+ # A result object deserialized from the server's reply
57
+ def list_queues 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_queues_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::Tasks::V2::ListQueuesResponse.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_queue REST call
83
+ #
84
+ # @param request_pb [::Google::Cloud::Tasks::V2::GetQueueRequest]
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::Tasks::V2::Queue]
91
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
92
+ #
93
+ # @return [::Google::Cloud::Tasks::V2::Queue]
94
+ # A result object deserialized from the server's reply
95
+ def get_queue 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_queue_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::Tasks::V2::Queue.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_queue REST call
121
+ #
122
+ # @param request_pb [::Google::Cloud::Tasks::V2::CreateQueueRequest]
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::Tasks::V2::Queue]
129
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
130
+ #
131
+ # @return [::Google::Cloud::Tasks::V2::Queue]
132
+ # A result object deserialized from the server's reply
133
+ def create_queue 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_queue_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::Tasks::V2::Queue.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_queue REST call
159
+ #
160
+ # @param request_pb [::Google::Cloud::Tasks::V2::UpdateQueueRequest]
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::Tasks::V2::Queue]
167
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
168
+ #
169
+ # @return [::Google::Cloud::Tasks::V2::Queue]
170
+ # A result object deserialized from the server's reply
171
+ def update_queue 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_queue_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::Tasks::V2::Queue.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_queue REST call
197
+ #
198
+ # @param request_pb [::Google::Cloud::Tasks::V2::DeleteQueueRequest]
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_queue 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_queue_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 purge_queue REST call
235
+ #
236
+ # @param request_pb [::Google::Cloud::Tasks::V2::PurgeQueueRequest]
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::Tasks::V2::Queue]
243
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
244
+ #
245
+ # @return [::Google::Cloud::Tasks::V2::Queue]
246
+ # A result object deserialized from the server's reply
247
+ def purge_queue 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_purge_queue_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::Tasks::V2::Queue.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 pause_queue REST call
273
+ #
274
+ # @param request_pb [::Google::Cloud::Tasks::V2::PauseQueueRequest]
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::Tasks::V2::Queue]
281
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
282
+ #
283
+ # @return [::Google::Cloud::Tasks::V2::Queue]
284
+ # A result object deserialized from the server's reply
285
+ def pause_queue 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_pause_queue_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::Tasks::V2::Queue.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 resume_queue REST call
311
+ #
312
+ # @param request_pb [::Google::Cloud::Tasks::V2::ResumeQueueRequest]
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::Tasks::V2::Queue]
319
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
320
+ #
321
+ # @return [::Google::Cloud::Tasks::V2::Queue]
322
+ # A result object deserialized from the server's reply
323
+ def resume_queue 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_resume_queue_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::Tasks::V2::Queue.decode_json response.body, ignore_unknown_fields: true
342
+
343
+ yield result, operation if block_given?
344
+ result
345
+ end
346
+
347
+ ##
348
+ # Baseline implementation for the get_iam_policy REST call
349
+ #
350
+ # @param request_pb [::Google::Iam::V1::GetIamPolicyRequest]
351
+ # A request object representing the call parameters. Required.
352
+ # @param options [::Gapic::CallOptions]
353
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
354
+ #
355
+ # @yield [result, operation] Access the result along with the TransportOperation object
356
+ # @yieldparam result [::Google::Iam::V1::Policy]
357
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
358
+ #
359
+ # @return [::Google::Iam::V1::Policy]
360
+ # A result object deserialized from the server's reply
361
+ def get_iam_policy request_pb, options = nil
362
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
363
+
364
+ verb, uri, query_string_params, body = ServiceStub.transcode_get_iam_policy_request request_pb
365
+ query_string_params = if query_string_params.any?
366
+ query_string_params.to_h { |p| p.split("=", 2) }
367
+ else
368
+ {}
369
+ end
370
+
371
+ response = @client_stub.make_http_request(
372
+ verb,
373
+ uri: uri,
374
+ body: body || "",
375
+ params: query_string_params,
376
+ options: options
377
+ )
378
+ operation = ::Gapic::Rest::TransportOperation.new response
379
+ result = ::Google::Iam::V1::Policy.decode_json response.body, ignore_unknown_fields: true
380
+
381
+ yield result, operation if block_given?
382
+ result
383
+ end
384
+
385
+ ##
386
+ # Baseline implementation for the set_iam_policy REST call
387
+ #
388
+ # @param request_pb [::Google::Iam::V1::SetIamPolicyRequest]
389
+ # A request object representing the call parameters. Required.
390
+ # @param options [::Gapic::CallOptions]
391
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
392
+ #
393
+ # @yield [result, operation] Access the result along with the TransportOperation object
394
+ # @yieldparam result [::Google::Iam::V1::Policy]
395
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
396
+ #
397
+ # @return [::Google::Iam::V1::Policy]
398
+ # A result object deserialized from the server's reply
399
+ def set_iam_policy request_pb, options = nil
400
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
401
+
402
+ verb, uri, query_string_params, body = ServiceStub.transcode_set_iam_policy_request request_pb
403
+ query_string_params = if query_string_params.any?
404
+ query_string_params.to_h { |p| p.split("=", 2) }
405
+ else
406
+ {}
407
+ end
408
+
409
+ response = @client_stub.make_http_request(
410
+ verb,
411
+ uri: uri,
412
+ body: body || "",
413
+ params: query_string_params,
414
+ options: options
415
+ )
416
+ operation = ::Gapic::Rest::TransportOperation.new response
417
+ result = ::Google::Iam::V1::Policy.decode_json response.body, ignore_unknown_fields: true
418
+
419
+ yield result, operation if block_given?
420
+ result
421
+ end
422
+
423
+ ##
424
+ # Baseline implementation for the test_iam_permissions REST call
425
+ #
426
+ # @param request_pb [::Google::Iam::V1::TestIamPermissionsRequest]
427
+ # A request object representing the call parameters. Required.
428
+ # @param options [::Gapic::CallOptions]
429
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
430
+ #
431
+ # @yield [result, operation] Access the result along with the TransportOperation object
432
+ # @yieldparam result [::Google::Iam::V1::TestIamPermissionsResponse]
433
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
434
+ #
435
+ # @return [::Google::Iam::V1::TestIamPermissionsResponse]
436
+ # A result object deserialized from the server's reply
437
+ def test_iam_permissions request_pb, options = nil
438
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
439
+
440
+ verb, uri, query_string_params, body = ServiceStub.transcode_test_iam_permissions_request request_pb
441
+ query_string_params = if query_string_params.any?
442
+ query_string_params.to_h { |p| p.split("=", 2) }
443
+ else
444
+ {}
445
+ end
446
+
447
+ response = @client_stub.make_http_request(
448
+ verb,
449
+ uri: uri,
450
+ body: body || "",
451
+ params: query_string_params,
452
+ options: options
453
+ )
454
+ operation = ::Gapic::Rest::TransportOperation.new response
455
+ result = ::Google::Iam::V1::TestIamPermissionsResponse.decode_json response.body, ignore_unknown_fields: true
456
+
457
+ yield result, operation if block_given?
458
+ result
459
+ end
460
+
461
+ ##
462
+ # Baseline implementation for the list_tasks REST call
463
+ #
464
+ # @param request_pb [::Google::Cloud::Tasks::V2::ListTasksRequest]
465
+ # A request object representing the call parameters. Required.
466
+ # @param options [::Gapic::CallOptions]
467
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
468
+ #
469
+ # @yield [result, operation] Access the result along with the TransportOperation object
470
+ # @yieldparam result [::Google::Cloud::Tasks::V2::ListTasksResponse]
471
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
472
+ #
473
+ # @return [::Google::Cloud::Tasks::V2::ListTasksResponse]
474
+ # A result object deserialized from the server's reply
475
+ def list_tasks request_pb, options = nil
476
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
477
+
478
+ verb, uri, query_string_params, body = ServiceStub.transcode_list_tasks_request request_pb
479
+ query_string_params = if query_string_params.any?
480
+ query_string_params.to_h { |p| p.split("=", 2) }
481
+ else
482
+ {}
483
+ end
484
+
485
+ response = @client_stub.make_http_request(
486
+ verb,
487
+ uri: uri,
488
+ body: body || "",
489
+ params: query_string_params,
490
+ options: options
491
+ )
492
+ operation = ::Gapic::Rest::TransportOperation.new response
493
+ result = ::Google::Cloud::Tasks::V2::ListTasksResponse.decode_json response.body, ignore_unknown_fields: true
494
+
495
+ yield result, operation if block_given?
496
+ result
497
+ end
498
+
499
+ ##
500
+ # Baseline implementation for the get_task REST call
501
+ #
502
+ # @param request_pb [::Google::Cloud::Tasks::V2::GetTaskRequest]
503
+ # A request object representing the call parameters. Required.
504
+ # @param options [::Gapic::CallOptions]
505
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
506
+ #
507
+ # @yield [result, operation] Access the result along with the TransportOperation object
508
+ # @yieldparam result [::Google::Cloud::Tasks::V2::Task]
509
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
510
+ #
511
+ # @return [::Google::Cloud::Tasks::V2::Task]
512
+ # A result object deserialized from the server's reply
513
+ def get_task request_pb, options = nil
514
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
515
+
516
+ verb, uri, query_string_params, body = ServiceStub.transcode_get_task_request request_pb
517
+ query_string_params = if query_string_params.any?
518
+ query_string_params.to_h { |p| p.split("=", 2) }
519
+ else
520
+ {}
521
+ end
522
+
523
+ response = @client_stub.make_http_request(
524
+ verb,
525
+ uri: uri,
526
+ body: body || "",
527
+ params: query_string_params,
528
+ options: options
529
+ )
530
+ operation = ::Gapic::Rest::TransportOperation.new response
531
+ result = ::Google::Cloud::Tasks::V2::Task.decode_json response.body, ignore_unknown_fields: true
532
+
533
+ yield result, operation if block_given?
534
+ result
535
+ end
536
+
537
+ ##
538
+ # Baseline implementation for the create_task REST call
539
+ #
540
+ # @param request_pb [::Google::Cloud::Tasks::V2::CreateTaskRequest]
541
+ # A request object representing the call parameters. Required.
542
+ # @param options [::Gapic::CallOptions]
543
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
544
+ #
545
+ # @yield [result, operation] Access the result along with the TransportOperation object
546
+ # @yieldparam result [::Google::Cloud::Tasks::V2::Task]
547
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
548
+ #
549
+ # @return [::Google::Cloud::Tasks::V2::Task]
550
+ # A result object deserialized from the server's reply
551
+ def create_task request_pb, options = nil
552
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
553
+
554
+ verb, uri, query_string_params, body = ServiceStub.transcode_create_task_request request_pb
555
+ query_string_params = if query_string_params.any?
556
+ query_string_params.to_h { |p| p.split("=", 2) }
557
+ else
558
+ {}
559
+ end
560
+
561
+ response = @client_stub.make_http_request(
562
+ verb,
563
+ uri: uri,
564
+ body: body || "",
565
+ params: query_string_params,
566
+ options: options
567
+ )
568
+ operation = ::Gapic::Rest::TransportOperation.new response
569
+ result = ::Google::Cloud::Tasks::V2::Task.decode_json response.body, ignore_unknown_fields: true
570
+
571
+ yield result, operation if block_given?
572
+ result
573
+ end
574
+
575
+ ##
576
+ # Baseline implementation for the delete_task REST call
577
+ #
578
+ # @param request_pb [::Google::Cloud::Tasks::V2::DeleteTaskRequest]
579
+ # A request object representing the call parameters. Required.
580
+ # @param options [::Gapic::CallOptions]
581
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
582
+ #
583
+ # @yield [result, operation] Access the result along with the TransportOperation object
584
+ # @yieldparam result [::Google::Protobuf::Empty]
585
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
586
+ #
587
+ # @return [::Google::Protobuf::Empty]
588
+ # A result object deserialized from the server's reply
589
+ def delete_task request_pb, options = nil
590
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
591
+
592
+ verb, uri, query_string_params, body = ServiceStub.transcode_delete_task_request request_pb
593
+ query_string_params = if query_string_params.any?
594
+ query_string_params.to_h { |p| p.split("=", 2) }
595
+ else
596
+ {}
597
+ end
598
+
599
+ response = @client_stub.make_http_request(
600
+ verb,
601
+ uri: uri,
602
+ body: body || "",
603
+ params: query_string_params,
604
+ options: options
605
+ )
606
+ operation = ::Gapic::Rest::TransportOperation.new response
607
+ result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
608
+
609
+ yield result, operation if block_given?
610
+ result
611
+ end
612
+
613
+ ##
614
+ # Baseline implementation for the run_task REST call
615
+ #
616
+ # @param request_pb [::Google::Cloud::Tasks::V2::RunTaskRequest]
617
+ # A request object representing the call parameters. Required.
618
+ # @param options [::Gapic::CallOptions]
619
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
620
+ #
621
+ # @yield [result, operation] Access the result along with the TransportOperation object
622
+ # @yieldparam result [::Google::Cloud::Tasks::V2::Task]
623
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
624
+ #
625
+ # @return [::Google::Cloud::Tasks::V2::Task]
626
+ # A result object deserialized from the server's reply
627
+ def run_task request_pb, options = nil
628
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
629
+
630
+ verb, uri, query_string_params, body = ServiceStub.transcode_run_task_request request_pb
631
+ query_string_params = if query_string_params.any?
632
+ query_string_params.to_h { |p| p.split("=", 2) }
633
+ else
634
+ {}
635
+ end
636
+
637
+ response = @client_stub.make_http_request(
638
+ verb,
639
+ uri: uri,
640
+ body: body || "",
641
+ params: query_string_params,
642
+ options: options
643
+ )
644
+ operation = ::Gapic::Rest::TransportOperation.new response
645
+ result = ::Google::Cloud::Tasks::V2::Task.decode_json response.body, ignore_unknown_fields: true
646
+
647
+ yield result, operation if block_given?
648
+ result
649
+ end
650
+
651
+ ##
652
+ # @private
653
+ #
654
+ # GRPC transcoding helper method for the list_queues REST call
655
+ #
656
+ # @param request_pb [::Google::Cloud::Tasks::V2::ListQueuesRequest]
657
+ # A request object representing the call parameters. Required.
658
+ # @return [Array(String, [String, nil], Hash{String => String})]
659
+ # Uri, Body, Query string parameters
660
+ def self.transcode_list_queues_request request_pb
661
+ transcoder = Gapic::Rest::GrpcTranscoder.new
662
+ .with_bindings(
663
+ uri_method: :get,
664
+ uri_template: "/v2/{parent}/queues",
665
+ matches: [
666
+ ["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
667
+ ]
668
+ )
669
+ transcoder.transcode request_pb
670
+ end
671
+
672
+ ##
673
+ # @private
674
+ #
675
+ # GRPC transcoding helper method for the get_queue REST call
676
+ #
677
+ # @param request_pb [::Google::Cloud::Tasks::V2::GetQueueRequest]
678
+ # A request object representing the call parameters. Required.
679
+ # @return [Array(String, [String, nil], Hash{String => String})]
680
+ # Uri, Body, Query string parameters
681
+ def self.transcode_get_queue_request request_pb
682
+ transcoder = Gapic::Rest::GrpcTranscoder.new
683
+ .with_bindings(
684
+ uri_method: :get,
685
+ uri_template: "/v2/{name}",
686
+ matches: [
687
+ ["name", %r{^projects/[^/]+/locations/[^/]+/queues/[^/]+/?$}, false]
688
+ ]
689
+ )
690
+ transcoder.transcode request_pb
691
+ end
692
+
693
+ ##
694
+ # @private
695
+ #
696
+ # GRPC transcoding helper method for the create_queue REST call
697
+ #
698
+ # @param request_pb [::Google::Cloud::Tasks::V2::CreateQueueRequest]
699
+ # A request object representing the call parameters. Required.
700
+ # @return [Array(String, [String, nil], Hash{String => String})]
701
+ # Uri, Body, Query string parameters
702
+ def self.transcode_create_queue_request request_pb
703
+ transcoder = Gapic::Rest::GrpcTranscoder.new
704
+ .with_bindings(
705
+ uri_method: :post,
706
+ uri_template: "/v2/{parent}/queues",
707
+ body: "queue",
708
+ matches: [
709
+ ["parent", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
710
+ ]
711
+ )
712
+ transcoder.transcode request_pb
713
+ end
714
+
715
+ ##
716
+ # @private
717
+ #
718
+ # GRPC transcoding helper method for the update_queue REST call
719
+ #
720
+ # @param request_pb [::Google::Cloud::Tasks::V2::UpdateQueueRequest]
721
+ # A request object representing the call parameters. Required.
722
+ # @return [Array(String, [String, nil], Hash{String => String})]
723
+ # Uri, Body, Query string parameters
724
+ def self.transcode_update_queue_request request_pb
725
+ transcoder = Gapic::Rest::GrpcTranscoder.new
726
+ .with_bindings(
727
+ uri_method: :patch,
728
+ uri_template: "/v2/{queue.name}",
729
+ body: "queue",
730
+ matches: [
731
+ ["queue.name", %r{^projects/[^/]+/locations/[^/]+/queues/[^/]+/?$}, false]
732
+ ]
733
+ )
734
+ transcoder.transcode request_pb
735
+ end
736
+
737
+ ##
738
+ # @private
739
+ #
740
+ # GRPC transcoding helper method for the delete_queue REST call
741
+ #
742
+ # @param request_pb [::Google::Cloud::Tasks::V2::DeleteQueueRequest]
743
+ # A request object representing the call parameters. Required.
744
+ # @return [Array(String, [String, nil], Hash{String => String})]
745
+ # Uri, Body, Query string parameters
746
+ def self.transcode_delete_queue_request request_pb
747
+ transcoder = Gapic::Rest::GrpcTranscoder.new
748
+ .with_bindings(
749
+ uri_method: :delete,
750
+ uri_template: "/v2/{name}",
751
+ matches: [
752
+ ["name", %r{^projects/[^/]+/locations/[^/]+/queues/[^/]+/?$}, false]
753
+ ]
754
+ )
755
+ transcoder.transcode request_pb
756
+ end
757
+
758
+ ##
759
+ # @private
760
+ #
761
+ # GRPC transcoding helper method for the purge_queue REST call
762
+ #
763
+ # @param request_pb [::Google::Cloud::Tasks::V2::PurgeQueueRequest]
764
+ # A request object representing the call parameters. Required.
765
+ # @return [Array(String, [String, nil], Hash{String => String})]
766
+ # Uri, Body, Query string parameters
767
+ def self.transcode_purge_queue_request request_pb
768
+ transcoder = Gapic::Rest::GrpcTranscoder.new
769
+ .with_bindings(
770
+ uri_method: :post,
771
+ uri_template: "/v2/{name}:purge",
772
+ body: "*",
773
+ matches: [
774
+ ["name", %r{^projects/[^/]+/locations/[^/]+/queues/[^/]+/?$}, false]
775
+ ]
776
+ )
777
+ transcoder.transcode request_pb
778
+ end
779
+
780
+ ##
781
+ # @private
782
+ #
783
+ # GRPC transcoding helper method for the pause_queue REST call
784
+ #
785
+ # @param request_pb [::Google::Cloud::Tasks::V2::PauseQueueRequest]
786
+ # A request object representing the call parameters. Required.
787
+ # @return [Array(String, [String, nil], Hash{String => String})]
788
+ # Uri, Body, Query string parameters
789
+ def self.transcode_pause_queue_request request_pb
790
+ transcoder = Gapic::Rest::GrpcTranscoder.new
791
+ .with_bindings(
792
+ uri_method: :post,
793
+ uri_template: "/v2/{name}:pause",
794
+ body: "*",
795
+ matches: [
796
+ ["name", %r{^projects/[^/]+/locations/[^/]+/queues/[^/]+/?$}, false]
797
+ ]
798
+ )
799
+ transcoder.transcode request_pb
800
+ end
801
+
802
+ ##
803
+ # @private
804
+ #
805
+ # GRPC transcoding helper method for the resume_queue REST call
806
+ #
807
+ # @param request_pb [::Google::Cloud::Tasks::V2::ResumeQueueRequest]
808
+ # A request object representing the call parameters. Required.
809
+ # @return [Array(String, [String, nil], Hash{String => String})]
810
+ # Uri, Body, Query string parameters
811
+ def self.transcode_resume_queue_request request_pb
812
+ transcoder = Gapic::Rest::GrpcTranscoder.new
813
+ .with_bindings(
814
+ uri_method: :post,
815
+ uri_template: "/v2/{name}:resume",
816
+ body: "*",
817
+ matches: [
818
+ ["name", %r{^projects/[^/]+/locations/[^/]+/queues/[^/]+/?$}, false]
819
+ ]
820
+ )
821
+ transcoder.transcode request_pb
822
+ end
823
+
824
+ ##
825
+ # @private
826
+ #
827
+ # GRPC transcoding helper method for the get_iam_policy REST call
828
+ #
829
+ # @param request_pb [::Google::Iam::V1::GetIamPolicyRequest]
830
+ # A request object representing the call parameters. Required.
831
+ # @return [Array(String, [String, nil], Hash{String => String})]
832
+ # Uri, Body, Query string parameters
833
+ def self.transcode_get_iam_policy_request request_pb
834
+ transcoder = Gapic::Rest::GrpcTranscoder.new
835
+ .with_bindings(
836
+ uri_method: :post,
837
+ uri_template: "/v2/{resource}:getIamPolicy",
838
+ body: "*",
839
+ matches: [
840
+ ["resource", %r{^projects/[^/]+/locations/[^/]+/queues/[^/]+/?$}, false]
841
+ ]
842
+ )
843
+ transcoder.transcode request_pb
844
+ end
845
+
846
+ ##
847
+ # @private
848
+ #
849
+ # GRPC transcoding helper method for the set_iam_policy REST call
850
+ #
851
+ # @param request_pb [::Google::Iam::V1::SetIamPolicyRequest]
852
+ # A request object representing the call parameters. Required.
853
+ # @return [Array(String, [String, nil], Hash{String => String})]
854
+ # Uri, Body, Query string parameters
855
+ def self.transcode_set_iam_policy_request request_pb
856
+ transcoder = Gapic::Rest::GrpcTranscoder.new
857
+ .with_bindings(
858
+ uri_method: :post,
859
+ uri_template: "/v2/{resource}:setIamPolicy",
860
+ body: "*",
861
+ matches: [
862
+ ["resource", %r{^projects/[^/]+/locations/[^/]+/queues/[^/]+/?$}, false]
863
+ ]
864
+ )
865
+ transcoder.transcode request_pb
866
+ end
867
+
868
+ ##
869
+ # @private
870
+ #
871
+ # GRPC transcoding helper method for the test_iam_permissions REST call
872
+ #
873
+ # @param request_pb [::Google::Iam::V1::TestIamPermissionsRequest]
874
+ # A request object representing the call parameters. Required.
875
+ # @return [Array(String, [String, nil], Hash{String => String})]
876
+ # Uri, Body, Query string parameters
877
+ def self.transcode_test_iam_permissions_request request_pb
878
+ transcoder = Gapic::Rest::GrpcTranscoder.new
879
+ .with_bindings(
880
+ uri_method: :post,
881
+ uri_template: "/v2/{resource}:testIamPermissions",
882
+ body: "*",
883
+ matches: [
884
+ ["resource", %r{^projects/[^/]+/locations/[^/]+/queues/[^/]+/?$}, false]
885
+ ]
886
+ )
887
+ transcoder.transcode request_pb
888
+ end
889
+
890
+ ##
891
+ # @private
892
+ #
893
+ # GRPC transcoding helper method for the list_tasks REST call
894
+ #
895
+ # @param request_pb [::Google::Cloud::Tasks::V2::ListTasksRequest]
896
+ # A request object representing the call parameters. Required.
897
+ # @return [Array(String, [String, nil], Hash{String => String})]
898
+ # Uri, Body, Query string parameters
899
+ def self.transcode_list_tasks_request request_pb
900
+ transcoder = Gapic::Rest::GrpcTranscoder.new
901
+ .with_bindings(
902
+ uri_method: :get,
903
+ uri_template: "/v2/{parent}/tasks",
904
+ matches: [
905
+ ["parent", %r{^projects/[^/]+/locations/[^/]+/queues/[^/]+/?$}, false]
906
+ ]
907
+ )
908
+ transcoder.transcode request_pb
909
+ end
910
+
911
+ ##
912
+ # @private
913
+ #
914
+ # GRPC transcoding helper method for the get_task REST call
915
+ #
916
+ # @param request_pb [::Google::Cloud::Tasks::V2::GetTaskRequest]
917
+ # A request object representing the call parameters. Required.
918
+ # @return [Array(String, [String, nil], Hash{String => String})]
919
+ # Uri, Body, Query string parameters
920
+ def self.transcode_get_task_request request_pb
921
+ transcoder = Gapic::Rest::GrpcTranscoder.new
922
+ .with_bindings(
923
+ uri_method: :get,
924
+ uri_template: "/v2/{name}",
925
+ matches: [
926
+ ["name", %r{^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+/?$}, false]
927
+ ]
928
+ )
929
+ transcoder.transcode request_pb
930
+ end
931
+
932
+ ##
933
+ # @private
934
+ #
935
+ # GRPC transcoding helper method for the create_task REST call
936
+ #
937
+ # @param request_pb [::Google::Cloud::Tasks::V2::CreateTaskRequest]
938
+ # A request object representing the call parameters. Required.
939
+ # @return [Array(String, [String, nil], Hash{String => String})]
940
+ # Uri, Body, Query string parameters
941
+ def self.transcode_create_task_request request_pb
942
+ transcoder = Gapic::Rest::GrpcTranscoder.new
943
+ .with_bindings(
944
+ uri_method: :post,
945
+ uri_template: "/v2/{parent}/tasks",
946
+ body: "*",
947
+ matches: [
948
+ ["parent", %r{^projects/[^/]+/locations/[^/]+/queues/[^/]+/?$}, false]
949
+ ]
950
+ )
951
+ transcoder.transcode request_pb
952
+ end
953
+
954
+ ##
955
+ # @private
956
+ #
957
+ # GRPC transcoding helper method for the delete_task REST call
958
+ #
959
+ # @param request_pb [::Google::Cloud::Tasks::V2::DeleteTaskRequest]
960
+ # A request object representing the call parameters. Required.
961
+ # @return [Array(String, [String, nil], Hash{String => String})]
962
+ # Uri, Body, Query string parameters
963
+ def self.transcode_delete_task_request request_pb
964
+ transcoder = Gapic::Rest::GrpcTranscoder.new
965
+ .with_bindings(
966
+ uri_method: :delete,
967
+ uri_template: "/v2/{name}",
968
+ matches: [
969
+ ["name", %r{^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+/?$}, false]
970
+ ]
971
+ )
972
+ transcoder.transcode request_pb
973
+ end
974
+
975
+ ##
976
+ # @private
977
+ #
978
+ # GRPC transcoding helper method for the run_task REST call
979
+ #
980
+ # @param request_pb [::Google::Cloud::Tasks::V2::RunTaskRequest]
981
+ # A request object representing the call parameters. Required.
982
+ # @return [Array(String, [String, nil], Hash{String => String})]
983
+ # Uri, Body, Query string parameters
984
+ def self.transcode_run_task_request request_pb
985
+ transcoder = Gapic::Rest::GrpcTranscoder.new
986
+ .with_bindings(
987
+ uri_method: :post,
988
+ uri_template: "/v2/{name}:run",
989
+ body: "*",
990
+ matches: [
991
+ ["name", %r{^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+/?$}, false]
992
+ ]
993
+ )
994
+ transcoder.transcode request_pb
995
+ end
996
+ end
997
+ end
998
+ end
999
+ end
1000
+ end
1001
+ end
1002
+ end