google-cloud-tasks-v2beta2 0.9.1 → 0.10.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/lib/google/cloud/tasks/v2beta2/bindings_override.rb +102 -0
- data/lib/google/cloud/tasks/v2beta2/cloud_tasks/client.rb +239 -4
- data/lib/google/cloud/tasks/v2beta2/cloud_tasks/rest/client.rb +461 -3
- data/lib/google/cloud/tasks/v2beta2/cloud_tasks/rest/service_stub.rb +61 -0
- data/lib/google/cloud/tasks/v2beta2/cloud_tasks/rest.rb +1 -0
- data/lib/google/cloud/tasks/v2beta2/cloudtasks_pb.rb +6 -1
- data/lib/google/cloud/tasks/v2beta2/cloudtasks_services_pb.rb +18 -0
- data/lib/google/cloud/tasks/v2beta2/old_target_pb.rb +41 -0
- data/lib/google/cloud/tasks/v2beta2/queue_pb.rb +1 -1
- data/lib/google/cloud/tasks/v2beta2/rest.rb +1 -0
- data/lib/google/cloud/tasks/v2beta2/target_pb.rb +14 -1
- data/lib/google/cloud/tasks/v2beta2/task_pb.rb +1 -1
- data/lib/google/cloud/tasks/v2beta2/version.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +14 -0
- data/proto_docs/google/api/httpbody.rb +80 -0
- data/proto_docs/google/cloud/tasks/v2beta2/cloudtasks.rb +52 -3
- data/proto_docs/google/cloud/tasks/v2beta2/queue.rb +5 -2
- data/proto_docs/google/cloud/tasks/v2beta2/target.rb +340 -0
- data/proto_docs/google/cloud/tasks/v2beta2/task.rb +7 -1
- data/proto_docs/google/iam/v1/policy.rb +8 -4
- metadata +28 -5
@@ -19,6 +19,7 @@
|
|
19
19
|
require "google/cloud/errors"
|
20
20
|
require "google/cloud/tasks/v2beta2/cloudtasks_pb"
|
21
21
|
require "google/cloud/tasks/v2beta2/cloud_tasks/rest/service_stub"
|
22
|
+
require "google/cloud/location/rest"
|
22
23
|
|
23
24
|
module Google
|
24
25
|
module Cloud
|
@@ -131,6 +132,8 @@ module Google
|
|
131
132
|
|
132
133
|
default_config.rpcs.run_task.timeout = 20.0
|
133
134
|
|
135
|
+
default_config.rpcs.buffer_task.timeout = 20.0
|
136
|
+
|
134
137
|
default_config
|
135
138
|
end
|
136
139
|
yield @configure if block_given?
|
@@ -195,9 +198,23 @@ module Google
|
|
195
198
|
@quota_project_id = @config.quota_project
|
196
199
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
197
200
|
|
201
|
+
@location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
|
202
|
+
config.credentials = credentials
|
203
|
+
config.quota_project = @quota_project_id
|
204
|
+
config.endpoint = @config.endpoint
|
205
|
+
config.bindings_override = @config.bindings_override
|
206
|
+
end
|
207
|
+
|
198
208
|
@cloud_tasks_stub = ::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
|
199
209
|
end
|
200
210
|
|
211
|
+
##
|
212
|
+
# Get the associated client for mix-in of the Locations.
|
213
|
+
#
|
214
|
+
# @return [Google::Cloud::Location::Locations::Rest::Client]
|
215
|
+
#
|
216
|
+
attr_reader :location_client
|
217
|
+
|
201
218
|
# Service calls
|
202
219
|
|
203
220
|
##
|
@@ -265,6 +282,26 @@ module Google
|
|
265
282
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Tasks::V2beta2::Queue>]
|
266
283
|
#
|
267
284
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
285
|
+
#
|
286
|
+
# @example Basic example
|
287
|
+
# require "google/cloud/tasks/v2beta2"
|
288
|
+
#
|
289
|
+
# # Create a client object. The client can be reused for multiple calls.
|
290
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
291
|
+
#
|
292
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
293
|
+
# request = Google::Cloud::Tasks::V2beta2::ListQueuesRequest.new
|
294
|
+
#
|
295
|
+
# # Call the list_queues method.
|
296
|
+
# result = client.list_queues request
|
297
|
+
#
|
298
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
299
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
300
|
+
# result.each do |item|
|
301
|
+
# # Each element is of type ::Google::Cloud::Tasks::V2beta2::Queue.
|
302
|
+
# p item
|
303
|
+
# end
|
304
|
+
#
|
268
305
|
def list_queues request, options = nil
|
269
306
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
270
307
|
|
@@ -334,6 +371,22 @@ module Google
|
|
334
371
|
# @return [::Google::Cloud::Tasks::V2beta2::Queue]
|
335
372
|
#
|
336
373
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
374
|
+
#
|
375
|
+
# @example Basic example
|
376
|
+
# require "google/cloud/tasks/v2beta2"
|
377
|
+
#
|
378
|
+
# # Create a client object. The client can be reused for multiple calls.
|
379
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
380
|
+
#
|
381
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
382
|
+
# request = Google::Cloud::Tasks::V2beta2::GetQueueRequest.new
|
383
|
+
#
|
384
|
+
# # Call the get_queue method.
|
385
|
+
# result = client.get_queue request
|
386
|
+
#
|
387
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Queue.
|
388
|
+
# p result
|
389
|
+
#
|
337
390
|
def get_queue request, options = nil
|
338
391
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
339
392
|
|
@@ -404,7 +457,7 @@ module Google
|
|
404
457
|
#
|
405
458
|
# The list of allowed locations can be obtained by calling Cloud
|
406
459
|
# Tasks' implementation of
|
407
|
-
#
|
460
|
+
# `::Google::Cloud::Location::Locations::Rest::Client#list_locations`.
|
408
461
|
# @param queue [::Google::Cloud::Tasks::V2beta2::Queue, ::Hash]
|
409
462
|
# Required. The queue to create.
|
410
463
|
#
|
@@ -417,6 +470,22 @@ module Google
|
|
417
470
|
# @return [::Google::Cloud::Tasks::V2beta2::Queue]
|
418
471
|
#
|
419
472
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
473
|
+
#
|
474
|
+
# @example Basic example
|
475
|
+
# require "google/cloud/tasks/v2beta2"
|
476
|
+
#
|
477
|
+
# # Create a client object. The client can be reused for multiple calls.
|
478
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
479
|
+
#
|
480
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
481
|
+
# request = Google::Cloud::Tasks::V2beta2::CreateQueueRequest.new
|
482
|
+
#
|
483
|
+
# # Call the create_queue method.
|
484
|
+
# result = client.create_queue request
|
485
|
+
#
|
486
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Queue.
|
487
|
+
# p result
|
488
|
+
#
|
420
489
|
def create_queue request, options = nil
|
421
490
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
422
491
|
|
@@ -505,6 +574,22 @@ module Google
|
|
505
574
|
# @return [::Google::Cloud::Tasks::V2beta2::Queue]
|
506
575
|
#
|
507
576
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
577
|
+
#
|
578
|
+
# @example Basic example
|
579
|
+
# require "google/cloud/tasks/v2beta2"
|
580
|
+
#
|
581
|
+
# # Create a client object. The client can be reused for multiple calls.
|
582
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
583
|
+
#
|
584
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
585
|
+
# request = Google::Cloud::Tasks::V2beta2::UpdateQueueRequest.new
|
586
|
+
#
|
587
|
+
# # Call the update_queue method.
|
588
|
+
# result = client.update_queue request
|
589
|
+
#
|
590
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Queue.
|
591
|
+
# p result
|
592
|
+
#
|
508
593
|
def update_queue request, options = nil
|
509
594
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
510
595
|
|
@@ -580,6 +665,22 @@ module Google
|
|
580
665
|
# @return [::Google::Protobuf::Empty]
|
581
666
|
#
|
582
667
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
668
|
+
#
|
669
|
+
# @example Basic example
|
670
|
+
# require "google/cloud/tasks/v2beta2"
|
671
|
+
#
|
672
|
+
# # Create a client object. The client can be reused for multiple calls.
|
673
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
674
|
+
#
|
675
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
676
|
+
# request = Google::Cloud::Tasks::V2beta2::DeleteQueueRequest.new
|
677
|
+
#
|
678
|
+
# # Call the delete_queue method.
|
679
|
+
# result = client.delete_queue request
|
680
|
+
#
|
681
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
682
|
+
# p result
|
683
|
+
#
|
583
684
|
def delete_queue request, options = nil
|
584
685
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
585
686
|
|
@@ -648,6 +749,22 @@ module Google
|
|
648
749
|
# @return [::Google::Cloud::Tasks::V2beta2::Queue]
|
649
750
|
#
|
650
751
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
752
|
+
#
|
753
|
+
# @example Basic example
|
754
|
+
# require "google/cloud/tasks/v2beta2"
|
755
|
+
#
|
756
|
+
# # Create a client object. The client can be reused for multiple calls.
|
757
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
758
|
+
#
|
759
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
760
|
+
# request = Google::Cloud::Tasks::V2beta2::PurgeQueueRequest.new
|
761
|
+
#
|
762
|
+
# # Call the purge_queue method.
|
763
|
+
# result = client.purge_queue request
|
764
|
+
#
|
765
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Queue.
|
766
|
+
# p result
|
767
|
+
#
|
651
768
|
def purge_queue request, options = nil
|
652
769
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
653
770
|
|
@@ -718,6 +835,22 @@ module Google
|
|
718
835
|
# @return [::Google::Cloud::Tasks::V2beta2::Queue]
|
719
836
|
#
|
720
837
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
838
|
+
#
|
839
|
+
# @example Basic example
|
840
|
+
# require "google/cloud/tasks/v2beta2"
|
841
|
+
#
|
842
|
+
# # Create a client object. The client can be reused for multiple calls.
|
843
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
844
|
+
#
|
845
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
846
|
+
# request = Google::Cloud::Tasks::V2beta2::PauseQueueRequest.new
|
847
|
+
#
|
848
|
+
# # Call the pause_queue method.
|
849
|
+
# result = client.pause_queue request
|
850
|
+
#
|
851
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Queue.
|
852
|
+
# p result
|
853
|
+
#
|
721
854
|
def pause_queue request, options = nil
|
722
855
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
723
856
|
|
@@ -795,6 +928,22 @@ module Google
|
|
795
928
|
# @return [::Google::Cloud::Tasks::V2beta2::Queue]
|
796
929
|
#
|
797
930
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
931
|
+
#
|
932
|
+
# @example Basic example
|
933
|
+
# require "google/cloud/tasks/v2beta2"
|
934
|
+
#
|
935
|
+
# # Create a client object. The client can be reused for multiple calls.
|
936
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
937
|
+
#
|
938
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
939
|
+
# request = Google::Cloud::Tasks::V2beta2::ResumeQueueRequest.new
|
940
|
+
#
|
941
|
+
# # Call the resume_queue method.
|
942
|
+
# result = client.resume_queue request
|
943
|
+
#
|
944
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Queue.
|
945
|
+
# p result
|
946
|
+
#
|
798
947
|
def resume_queue request, options = nil
|
799
948
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
800
949
|
|
@@ -869,6 +1018,22 @@ module Google
|
|
869
1018
|
# @return [::Google::Iam::V1::Policy]
|
870
1019
|
#
|
871
1020
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1021
|
+
#
|
1022
|
+
# @example Basic example
|
1023
|
+
# require "google/cloud/tasks/v2beta2"
|
1024
|
+
#
|
1025
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1026
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
1027
|
+
#
|
1028
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1029
|
+
# request = Google::Iam::V1::GetIamPolicyRequest.new
|
1030
|
+
#
|
1031
|
+
# # Call the get_iam_policy method.
|
1032
|
+
# result = client.get_iam_policy request
|
1033
|
+
#
|
1034
|
+
# # The returned object is of type Google::Iam::V1::Policy.
|
1035
|
+
# p result
|
1036
|
+
#
|
872
1037
|
def get_iam_policy request, options = nil
|
873
1038
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
874
1039
|
|
@@ -953,6 +1118,22 @@ module Google
|
|
953
1118
|
# @return [::Google::Iam::V1::Policy]
|
954
1119
|
#
|
955
1120
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1121
|
+
#
|
1122
|
+
# @example Basic example
|
1123
|
+
# require "google/cloud/tasks/v2beta2"
|
1124
|
+
#
|
1125
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1126
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
1127
|
+
#
|
1128
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1129
|
+
# request = Google::Iam::V1::SetIamPolicyRequest.new
|
1130
|
+
#
|
1131
|
+
# # Call the set_iam_policy method.
|
1132
|
+
# result = client.set_iam_policy request
|
1133
|
+
#
|
1134
|
+
# # The returned object is of type Google::Iam::V1::Policy.
|
1135
|
+
# p result
|
1136
|
+
#
|
956
1137
|
def set_iam_policy request, options = nil
|
957
1138
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
958
1139
|
|
@@ -1028,6 +1209,22 @@ module Google
|
|
1028
1209
|
# @return [::Google::Iam::V1::TestIamPermissionsResponse]
|
1029
1210
|
#
|
1030
1211
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1212
|
+
#
|
1213
|
+
# @example Basic example
|
1214
|
+
# require "google/cloud/tasks/v2beta2"
|
1215
|
+
#
|
1216
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1217
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
1218
|
+
#
|
1219
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1220
|
+
# request = Google::Iam::V1::TestIamPermissionsRequest.new
|
1221
|
+
#
|
1222
|
+
# # Call the test_iam_permissions method.
|
1223
|
+
# result = client.test_iam_permissions request
|
1224
|
+
#
|
1225
|
+
# # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
|
1226
|
+
# p result
|
1227
|
+
#
|
1031
1228
|
def test_iam_permissions request, options = nil
|
1032
1229
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1033
1230
|
|
@@ -1132,6 +1329,26 @@ module Google
|
|
1132
1329
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Tasks::V2beta2::Task>]
|
1133
1330
|
#
|
1134
1331
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1332
|
+
#
|
1333
|
+
# @example Basic example
|
1334
|
+
# require "google/cloud/tasks/v2beta2"
|
1335
|
+
#
|
1336
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1337
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
1338
|
+
#
|
1339
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1340
|
+
# request = Google::Cloud::Tasks::V2beta2::ListTasksRequest.new
|
1341
|
+
#
|
1342
|
+
# # Call the list_tasks method.
|
1343
|
+
# result = client.list_tasks request
|
1344
|
+
#
|
1345
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
1346
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
1347
|
+
# result.each do |item|
|
1348
|
+
# # Each element is of type ::Google::Cloud::Tasks::V2beta2::Task.
|
1349
|
+
# p item
|
1350
|
+
# end
|
1351
|
+
#
|
1135
1352
|
def list_tasks request, options = nil
|
1136
1353
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1137
1354
|
|
@@ -1210,6 +1427,22 @@ module Google
|
|
1210
1427
|
# @return [::Google::Cloud::Tasks::V2beta2::Task]
|
1211
1428
|
#
|
1212
1429
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1430
|
+
#
|
1431
|
+
# @example Basic example
|
1432
|
+
# require "google/cloud/tasks/v2beta2"
|
1433
|
+
#
|
1434
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1435
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
1436
|
+
#
|
1437
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1438
|
+
# request = Google::Cloud::Tasks::V2beta2::GetTaskRequest.new
|
1439
|
+
#
|
1440
|
+
# # Call the get_task method.
|
1441
|
+
# result = client.get_task request
|
1442
|
+
#
|
1443
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Task.
|
1444
|
+
# p result
|
1445
|
+
#
|
1213
1446
|
def get_task request, options = nil
|
1214
1447
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1215
1448
|
|
@@ -1296,10 +1529,10 @@ module Google
|
|
1296
1529
|
# that was deleted or completed recently then the call will fail
|
1297
1530
|
# with [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS].
|
1298
1531
|
# If the task's queue was created using Cloud Tasks, then another task with
|
1299
|
-
# the same name can't be created for ~
|
1532
|
+
# the same name can't be created for ~1 hour after the original task was
|
1300
1533
|
# deleted or completed. If the task's queue was created using queue.yaml or
|
1301
1534
|
# queue.xml, then another task with the same name can't be created
|
1302
|
-
# for ~
|
1535
|
+
# for ~9 days after the original task was deleted or completed.
|
1303
1536
|
#
|
1304
1537
|
# Because there is an extra lookup cost to identify duplicate task
|
1305
1538
|
# names, these {::Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client#create_task CreateTask}
|
@@ -1331,6 +1564,22 @@ module Google
|
|
1331
1564
|
# @return [::Google::Cloud::Tasks::V2beta2::Task]
|
1332
1565
|
#
|
1333
1566
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1567
|
+
#
|
1568
|
+
# @example Basic example
|
1569
|
+
# require "google/cloud/tasks/v2beta2"
|
1570
|
+
#
|
1571
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1572
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
1573
|
+
#
|
1574
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1575
|
+
# request = Google::Cloud::Tasks::V2beta2::CreateTaskRequest.new
|
1576
|
+
#
|
1577
|
+
# # Call the create_task method.
|
1578
|
+
# result = client.create_task request
|
1579
|
+
#
|
1580
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Task.
|
1581
|
+
# p result
|
1582
|
+
#
|
1334
1583
|
def create_task request, options = nil
|
1335
1584
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1336
1585
|
|
@@ -1398,6 +1647,22 @@ module Google
|
|
1398
1647
|
# @return [::Google::Protobuf::Empty]
|
1399
1648
|
#
|
1400
1649
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1650
|
+
#
|
1651
|
+
# @example Basic example
|
1652
|
+
# require "google/cloud/tasks/v2beta2"
|
1653
|
+
#
|
1654
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1655
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
1656
|
+
#
|
1657
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1658
|
+
# request = Google::Cloud::Tasks::V2beta2::DeleteTaskRequest.new
|
1659
|
+
#
|
1660
|
+
# # Call the delete_task method.
|
1661
|
+
# result = client.delete_task request
|
1662
|
+
#
|
1663
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
1664
|
+
# p result
|
1665
|
+
#
|
1401
1666
|
def delete_task request, options = nil
|
1402
1667
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1403
1668
|
|
@@ -1564,6 +1829,22 @@ module Google
|
|
1564
1829
|
# @return [::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse]
|
1565
1830
|
#
|
1566
1831
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1832
|
+
#
|
1833
|
+
# @example Basic example
|
1834
|
+
# require "google/cloud/tasks/v2beta2"
|
1835
|
+
#
|
1836
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1837
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
1838
|
+
#
|
1839
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1840
|
+
# request = Google::Cloud::Tasks::V2beta2::LeaseTasksRequest.new
|
1841
|
+
#
|
1842
|
+
# # Call the lease_tasks method.
|
1843
|
+
# result = client.lease_tasks request
|
1844
|
+
#
|
1845
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::LeaseTasksResponse.
|
1846
|
+
# p result
|
1847
|
+
#
|
1567
1848
|
def lease_tasks request, options = nil
|
1568
1849
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1569
1850
|
|
@@ -1646,6 +1927,22 @@ module Google
|
|
1646
1927
|
# @return [::Google::Protobuf::Empty]
|
1647
1928
|
#
|
1648
1929
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1930
|
+
#
|
1931
|
+
# @example Basic example
|
1932
|
+
# require "google/cloud/tasks/v2beta2"
|
1933
|
+
#
|
1934
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1935
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
1936
|
+
#
|
1937
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1938
|
+
# request = Google::Cloud::Tasks::V2beta2::AcknowledgeTaskRequest.new
|
1939
|
+
#
|
1940
|
+
# # Call the acknowledge_task method.
|
1941
|
+
# result = client.acknowledge_task request
|
1942
|
+
#
|
1943
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
1944
|
+
# p result
|
1945
|
+
#
|
1649
1946
|
def acknowledge_task request, options = nil
|
1650
1947
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1651
1948
|
|
@@ -1740,6 +2037,22 @@ module Google
|
|
1740
2037
|
# @return [::Google::Cloud::Tasks::V2beta2::Task]
|
1741
2038
|
#
|
1742
2039
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
2040
|
+
#
|
2041
|
+
# @example Basic example
|
2042
|
+
# require "google/cloud/tasks/v2beta2"
|
2043
|
+
#
|
2044
|
+
# # Create a client object. The client can be reused for multiple calls.
|
2045
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
2046
|
+
#
|
2047
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
2048
|
+
# request = Google::Cloud::Tasks::V2beta2::RenewLeaseRequest.new
|
2049
|
+
#
|
2050
|
+
# # Call the renew_lease method.
|
2051
|
+
# result = client.renew_lease request
|
2052
|
+
#
|
2053
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Task.
|
2054
|
+
# p result
|
2055
|
+
#
|
1743
2056
|
def renew_lease request, options = nil
|
1744
2057
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1745
2058
|
|
@@ -1828,6 +2141,22 @@ module Google
|
|
1828
2141
|
# @return [::Google::Cloud::Tasks::V2beta2::Task]
|
1829
2142
|
#
|
1830
2143
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
2144
|
+
#
|
2145
|
+
# @example Basic example
|
2146
|
+
# require "google/cloud/tasks/v2beta2"
|
2147
|
+
#
|
2148
|
+
# # Create a client object. The client can be reused for multiple calls.
|
2149
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
2150
|
+
#
|
2151
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
2152
|
+
# request = Google::Cloud::Tasks::V2beta2::CancelLeaseRequest.new
|
2153
|
+
#
|
2154
|
+
# # Call the cancel_lease method.
|
2155
|
+
# result = client.cancel_lease request
|
2156
|
+
#
|
2157
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Task.
|
2158
|
+
# p result
|
2159
|
+
#
|
1831
2160
|
def cancel_lease request, options = nil
|
1832
2161
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1833
2162
|
|
@@ -1934,6 +2263,22 @@ module Google
|
|
1934
2263
|
# @return [::Google::Cloud::Tasks::V2beta2::Task]
|
1935
2264
|
#
|
1936
2265
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
2266
|
+
#
|
2267
|
+
# @example Basic example
|
2268
|
+
# require "google/cloud/tasks/v2beta2"
|
2269
|
+
#
|
2270
|
+
# # Create a client object. The client can be reused for multiple calls.
|
2271
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
2272
|
+
#
|
2273
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
2274
|
+
# request = Google::Cloud::Tasks::V2beta2::RunTaskRequest.new
|
2275
|
+
#
|
2276
|
+
# # Call the run_task method.
|
2277
|
+
# result = client.run_task request
|
2278
|
+
#
|
2279
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::Task.
|
2280
|
+
# p result
|
2281
|
+
#
|
1937
2282
|
def run_task request, options = nil
|
1938
2283
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
1939
2284
|
|
@@ -1969,6 +2314,105 @@ module Google
|
|
1969
2314
|
raise ::Google::Cloud::Error.from_error(e)
|
1970
2315
|
end
|
1971
2316
|
|
2317
|
+
##
|
2318
|
+
# Creates and buffers a new task without the need to explicitly define a Task
|
2319
|
+
# message. The queue must have [HTTP
|
2320
|
+
# target][google.cloud.tasks.v2beta2.HttpTarget]. To create the task with a
|
2321
|
+
# custom ID, use the following format and set TASK_ID to your desired ID:
|
2322
|
+
# projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID:buffer
|
2323
|
+
# To create the task with an automatically generated ID, use the following
|
2324
|
+
# format:
|
2325
|
+
# projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks:buffer.
|
2326
|
+
# Note: This feature is in its experimental stage. You must request access to
|
2327
|
+
# the API through the [Cloud Tasks BufferTask Experiment Signup
|
2328
|
+
# form](https://forms.gle/X8Zr5hiXH5tTGFqh8).
|
2329
|
+
#
|
2330
|
+
# @overload buffer_task(request, options = nil)
|
2331
|
+
# Pass arguments to `buffer_task` via a request object, either of type
|
2332
|
+
# {::Google::Cloud::Tasks::V2beta2::BufferTaskRequest} or an equivalent Hash.
|
2333
|
+
#
|
2334
|
+
# @param request [::Google::Cloud::Tasks::V2beta2::BufferTaskRequest, ::Hash]
|
2335
|
+
# A request object representing the call parameters. Required. To specify no
|
2336
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
2337
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
2338
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
2339
|
+
#
|
2340
|
+
# @overload buffer_task(queue: nil, task_id: nil, body: nil)
|
2341
|
+
# Pass arguments to `buffer_task` via keyword arguments. Note that at
|
2342
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
2343
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
2344
|
+
#
|
2345
|
+
# @param queue [::String]
|
2346
|
+
# Required. The parent queue name. For example:
|
2347
|
+
# projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
2348
|
+
#
|
2349
|
+
# The queue must already exist.
|
2350
|
+
# @param task_id [::String]
|
2351
|
+
# Optional. Task ID for the task being created. If not provided, a random
|
2352
|
+
# task ID is assigned to the task.
|
2353
|
+
# @param body [::Google::Api::HttpBody, ::Hash]
|
2354
|
+
# Optional. Body of the HTTP request.
|
2355
|
+
#
|
2356
|
+
# The body can take any generic value. The value is written to the
|
2357
|
+
# [HttpRequest][payload] of the [Task].
|
2358
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
2359
|
+
# @yieldparam result [::Google::Cloud::Tasks::V2beta2::BufferTaskResponse]
|
2360
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
2361
|
+
#
|
2362
|
+
# @return [::Google::Cloud::Tasks::V2beta2::BufferTaskResponse]
|
2363
|
+
#
|
2364
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
2365
|
+
#
|
2366
|
+
# @example Basic example
|
2367
|
+
# require "google/cloud/tasks/v2beta2"
|
2368
|
+
#
|
2369
|
+
# # Create a client object. The client can be reused for multiple calls.
|
2370
|
+
# client = Google::Cloud::Tasks::V2beta2::CloudTasks::Rest::Client.new
|
2371
|
+
#
|
2372
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
2373
|
+
# request = Google::Cloud::Tasks::V2beta2::BufferTaskRequest.new
|
2374
|
+
#
|
2375
|
+
# # Call the buffer_task method.
|
2376
|
+
# result = client.buffer_task request
|
2377
|
+
#
|
2378
|
+
# # The returned object is of type Google::Cloud::Tasks::V2beta2::BufferTaskResponse.
|
2379
|
+
# p result
|
2380
|
+
#
|
2381
|
+
def buffer_task request, options = nil
|
2382
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
2383
|
+
|
2384
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Tasks::V2beta2::BufferTaskRequest
|
2385
|
+
|
2386
|
+
# Converts hash and nil to an options object
|
2387
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
2388
|
+
|
2389
|
+
# Customize the options with defaults
|
2390
|
+
call_metadata = @config.rpcs.buffer_task.metadata.to_h
|
2391
|
+
|
2392
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
2393
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
2394
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
2395
|
+
gapic_version: ::Google::Cloud::Tasks::V2beta2::VERSION,
|
2396
|
+
transports_version_send: [:rest]
|
2397
|
+
|
2398
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2399
|
+
|
2400
|
+
options.apply_defaults timeout: @config.rpcs.buffer_task.timeout,
|
2401
|
+
metadata: call_metadata,
|
2402
|
+
retry_policy: @config.rpcs.buffer_task.retry_policy
|
2403
|
+
|
2404
|
+
options.apply_defaults timeout: @config.timeout,
|
2405
|
+
metadata: @config.metadata,
|
2406
|
+
retry_policy: @config.retry_policy
|
2407
|
+
|
2408
|
+
@cloud_tasks_stub.buffer_task request, options do |result, operation|
|
2409
|
+
yield result, operation if block_given?
|
2410
|
+
return result
|
2411
|
+
end
|
2412
|
+
rescue ::Gapic::Rest::Error => e
|
2413
|
+
raise ::Google::Cloud::Error.from_error(e)
|
2414
|
+
end
|
2415
|
+
|
1972
2416
|
##
|
1973
2417
|
# Configuration class for the CloudTasks REST API.
|
1974
2418
|
#
|
@@ -2057,6 +2501,13 @@ module Google
|
|
2057
2501
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
2058
2502
|
config_attr :quota_project, nil, ::String, nil
|
2059
2503
|
|
2504
|
+
# @private
|
2505
|
+
# Overrides for http bindings for the RPCs of this service
|
2506
|
+
# are only used when this service is used as mixin, and only
|
2507
|
+
# by the host service.
|
2508
|
+
# @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
|
2509
|
+
config_attr :bindings_override, {}, ::Hash, nil
|
2510
|
+
|
2060
2511
|
# @private
|
2061
2512
|
def initialize parent_config = nil
|
2062
2513
|
@parent_config = parent_config unless parent_config.nil?
|
@@ -2194,6 +2645,11 @@ module Google
|
|
2194
2645
|
# @return [::Gapic::Config::Method]
|
2195
2646
|
#
|
2196
2647
|
attr_reader :run_task
|
2648
|
+
##
|
2649
|
+
# RPC-specific configuration for `buffer_task`
|
2650
|
+
# @return [::Gapic::Config::Method]
|
2651
|
+
#
|
2652
|
+
attr_reader :buffer_task
|
2197
2653
|
|
2198
2654
|
# @private
|
2199
2655
|
def initialize parent_rpcs = nil
|
@@ -2237,6 +2693,8 @@ module Google
|
|
2237
2693
|
@cancel_lease = ::Gapic::Config::Method.new cancel_lease_config
|
2238
2694
|
run_task_config = parent_rpcs.run_task if parent_rpcs.respond_to? :run_task
|
2239
2695
|
@run_task = ::Gapic::Config::Method.new run_task_config
|
2696
|
+
buffer_task_config = parent_rpcs.buffer_task if parent_rpcs.respond_to? :buffer_task
|
2697
|
+
@buffer_task = ::Gapic::Config::Method.new buffer_task_config
|
2240
2698
|
|
2241
2699
|
yield self if block_given?
|
2242
2700
|
end
|