google-cloud-tasks 1.5.1 → 2.1.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (82) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +2 -1
  3. data/AUTHENTICATION.md +51 -54
  4. data/LICENSE.md +203 -0
  5. data/MIGRATING.md +320 -0
  6. data/README.md +96 -24
  7. data/lib/{google/cloud/tasks/v2beta2/doc/google/protobuf/empty.rb → google-cloud-tasks.rb} +4 -14
  8. data/lib/google/cloud/tasks.rb +88 -117
  9. data/lib/google/cloud/tasks/version.rb +6 -2
  10. metadata +78 -115
  11. data/LICENSE +0 -201
  12. data/lib/google/cloud/tasks/v2.rb +0 -147
  13. data/lib/google/cloud/tasks/v2/cloud_tasks_client.rb +0 -1233
  14. data/lib/google/cloud/tasks/v2/cloud_tasks_client_config.json +0 -106
  15. data/lib/google/cloud/tasks/v2/cloudtasks_pb.rb +0 -100
  16. data/lib/google/cloud/tasks/v2/cloudtasks_services_pb.rb +0 -203
  17. data/lib/google/cloud/tasks/v2/credentials.rb +0 -41
  18. data/lib/google/cloud/tasks/v2/doc/google/cloud/tasks/v2/cloudtasks.rb +0 -312
  19. data/lib/google/cloud/tasks/v2/doc/google/cloud/tasks/v2/queue.rb +0 -348
  20. data/lib/google/cloud/tasks/v2/doc/google/cloud/tasks/v2/target.rb +0 -414
  21. data/lib/google/cloud/tasks/v2/doc/google/cloud/tasks/v2/task.rb +0 -175
  22. data/lib/google/cloud/tasks/v2/doc/google/iam/v1/iam_policy.rb +0 -64
  23. data/lib/google/cloud/tasks/v2/doc/google/iam/v1/options.rb +0 -33
  24. data/lib/google/cloud/tasks/v2/doc/google/iam/v1/policy.rb +0 -151
  25. data/lib/google/cloud/tasks/v2/doc/google/protobuf/any.rb +0 -131
  26. data/lib/google/cloud/tasks/v2/doc/google/protobuf/duration.rb +0 -91
  27. data/lib/google/cloud/tasks/v2/doc/google/protobuf/empty.rb +0 -29
  28. data/lib/google/cloud/tasks/v2/doc/google/protobuf/field_mask.rb +0 -222
  29. data/lib/google/cloud/tasks/v2/doc/google/protobuf/timestamp.rb +0 -113
  30. data/lib/google/cloud/tasks/v2/doc/google/rpc/status.rb +0 -39
  31. data/lib/google/cloud/tasks/v2/doc/google/type/expr.rb +0 -45
  32. data/lib/google/cloud/tasks/v2/helpers.rb +0 -49
  33. data/lib/google/cloud/tasks/v2/queue_pb.rb +0 -56
  34. data/lib/google/cloud/tasks/v2/target_pb.rb +0 -66
  35. data/lib/google/cloud/tasks/v2/task_pb.rb +0 -51
  36. data/lib/google/cloud/tasks/v2beta2.rb +0 -147
  37. data/lib/google/cloud/tasks/v2beta2/cloud_tasks_client.rb +0 -1605
  38. data/lib/google/cloud/tasks/v2beta2/cloud_tasks_client_config.json +0 -126
  39. data/lib/google/cloud/tasks/v2beta2/cloudtasks_pb.rb +0 -133
  40. data/lib/google/cloud/tasks/v2beta2/cloudtasks_services_pb.rb +0 -258
  41. data/lib/google/cloud/tasks/v2beta2/credentials.rb +0 -41
  42. data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb +0 -483
  43. data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/queue.rb +0 -336
  44. data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/target.rb +0 -377
  45. data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/task.rb +0 -166
  46. data/lib/google/cloud/tasks/v2beta2/doc/google/iam/v1/iam_policy.rb +0 -64
  47. data/lib/google/cloud/tasks/v2beta2/doc/google/iam/v1/options.rb +0 -33
  48. data/lib/google/cloud/tasks/v2beta2/doc/google/iam/v1/policy.rb +0 -151
  49. data/lib/google/cloud/tasks/v2beta2/doc/google/protobuf/any.rb +0 -131
  50. data/lib/google/cloud/tasks/v2beta2/doc/google/protobuf/duration.rb +0 -91
  51. data/lib/google/cloud/tasks/v2beta2/doc/google/protobuf/field_mask.rb +0 -222
  52. data/lib/google/cloud/tasks/v2beta2/doc/google/protobuf/timestamp.rb +0 -113
  53. data/lib/google/cloud/tasks/v2beta2/doc/google/rpc/status.rb +0 -39
  54. data/lib/google/cloud/tasks/v2beta2/doc/google/type/expr.rb +0 -45
  55. data/lib/google/cloud/tasks/v2beta2/helpers.rb +0 -49
  56. data/lib/google/cloud/tasks/v2beta2/queue_pb.rb +0 -58
  57. data/lib/google/cloud/tasks/v2beta2/target_pb.rb +0 -54
  58. data/lib/google/cloud/tasks/v2beta2/task_pb.rb +0 -54
  59. data/lib/google/cloud/tasks/v2beta3.rb +0 -147
  60. data/lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb +0 -1233
  61. data/lib/google/cloud/tasks/v2beta3/cloud_tasks_client_config.json +0 -106
  62. data/lib/google/cloud/tasks/v2beta3/cloudtasks_pb.rb +0 -101
  63. data/lib/google/cloud/tasks/v2beta3/cloudtasks_services_pb.rb +0 -203
  64. data/lib/google/cloud/tasks/v2beta3/credentials.rb +0 -41
  65. data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/cloudtasks.rb +0 -312
  66. data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/queue.rb +0 -342
  67. data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/target.rb +0 -431
  68. data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/task.rb +0 -177
  69. data/lib/google/cloud/tasks/v2beta3/doc/google/iam/v1/iam_policy.rb +0 -64
  70. data/lib/google/cloud/tasks/v2beta3/doc/google/iam/v1/options.rb +0 -33
  71. data/lib/google/cloud/tasks/v2beta3/doc/google/iam/v1/policy.rb +0 -151
  72. data/lib/google/cloud/tasks/v2beta3/doc/google/protobuf/any.rb +0 -131
  73. data/lib/google/cloud/tasks/v2beta3/doc/google/protobuf/duration.rb +0 -91
  74. data/lib/google/cloud/tasks/v2beta3/doc/google/protobuf/empty.rb +0 -29
  75. data/lib/google/cloud/tasks/v2beta3/doc/google/protobuf/field_mask.rb +0 -222
  76. data/lib/google/cloud/tasks/v2beta3/doc/google/protobuf/timestamp.rb +0 -113
  77. data/lib/google/cloud/tasks/v2beta3/doc/google/rpc/status.rb +0 -39
  78. data/lib/google/cloud/tasks/v2beta3/doc/google/type/expr.rb +0 -45
  79. data/lib/google/cloud/tasks/v2beta3/helpers.rb +0 -49
  80. data/lib/google/cloud/tasks/v2beta3/queue_pb.rb +0 -59
  81. data/lib/google/cloud/tasks/v2beta3/target_pb.rb +0 -69
  82. data/lib/google/cloud/tasks/v2beta3/task_pb.rb +0 -52
@@ -1,126 +0,0 @@
1
- {
2
- "interfaces": {
3
- "google.cloud.tasks.v2beta2.CloudTasks": {
4
- "retry_codes": {
5
- "idempotent": [
6
- "DEADLINE_EXCEEDED",
7
- "UNAVAILABLE"
8
- ],
9
- "non_idempotent": []
10
- },
11
- "retry_params": {
12
- "default": {
13
- "initial_retry_delay_millis": 100,
14
- "retry_delay_multiplier": 1.3,
15
- "max_retry_delay_millis": 60000,
16
- "initial_rpc_timeout_millis": 20000,
17
- "rpc_timeout_multiplier": 1.0,
18
- "max_rpc_timeout_millis": 20000,
19
- "total_timeout_millis": 600000
20
- }
21
- },
22
- "methods": {
23
- "ListQueues": {
24
- "timeout_millis": 15000,
25
- "retry_codes_name": "idempotent",
26
- "retry_params_name": "default"
27
- },
28
- "GetQueue": {
29
- "timeout_millis": 10000,
30
- "retry_codes_name": "idempotent",
31
- "retry_params_name": "default"
32
- },
33
- "CreateQueue": {
34
- "timeout_millis": 10000,
35
- "retry_codes_name": "non_idempotent",
36
- "retry_params_name": "default"
37
- },
38
- "UpdateQueue": {
39
- "timeout_millis": 10000,
40
- "retry_codes_name": "non_idempotent",
41
- "retry_params_name": "default"
42
- },
43
- "DeleteQueue": {
44
- "timeout_millis": 10000,
45
- "retry_codes_name": "idempotent",
46
- "retry_params_name": "default"
47
- },
48
- "PurgeQueue": {
49
- "timeout_millis": 10000,
50
- "retry_codes_name": "non_idempotent",
51
- "retry_params_name": "default"
52
- },
53
- "PauseQueue": {
54
- "timeout_millis": 10000,
55
- "retry_codes_name": "non_idempotent",
56
- "retry_params_name": "default"
57
- },
58
- "ResumeQueue": {
59
- "timeout_millis": 10000,
60
- "retry_codes_name": "non_idempotent",
61
- "retry_params_name": "default"
62
- },
63
- "GetIamPolicy": {
64
- "timeout_millis": 10000,
65
- "retry_codes_name": "non_idempotent",
66
- "retry_params_name": "default"
67
- },
68
- "SetIamPolicy": {
69
- "timeout_millis": 10000,
70
- "retry_codes_name": "non_idempotent",
71
- "retry_params_name": "default"
72
- },
73
- "TestIamPermissions": {
74
- "timeout_millis": 10000,
75
- "retry_codes_name": "non_idempotent",
76
- "retry_params_name": "default"
77
- },
78
- "ListTasks": {
79
- "timeout_millis": 10000,
80
- "retry_codes_name": "idempotent",
81
- "retry_params_name": "default"
82
- },
83
- "GetTask": {
84
- "timeout_millis": 10000,
85
- "retry_codes_name": "idempotent",
86
- "retry_params_name": "default"
87
- },
88
- "CreateTask": {
89
- "timeout_millis": 10000,
90
- "retry_codes_name": "non_idempotent",
91
- "retry_params_name": "default"
92
- },
93
- "DeleteTask": {
94
- "timeout_millis": 10000,
95
- "retry_codes_name": "non_idempotent",
96
- "retry_params_name": "default"
97
- },
98
- "LeaseTasks": {
99
- "timeout_millis": 10000,
100
- "retry_codes_name": "non_idempotent",
101
- "retry_params_name": "default"
102
- },
103
- "AcknowledgeTask": {
104
- "timeout_millis": 10000,
105
- "retry_codes_name": "non_idempotent",
106
- "retry_params_name": "default"
107
- },
108
- "RenewLease": {
109
- "timeout_millis": 10000,
110
- "retry_codes_name": "non_idempotent",
111
- "retry_params_name": "default"
112
- },
113
- "CancelLease": {
114
- "timeout_millis": 10000,
115
- "retry_codes_name": "non_idempotent",
116
- "retry_params_name": "default"
117
- },
118
- "RunTask": {
119
- "timeout_millis": 10000,
120
- "retry_codes_name": "non_idempotent",
121
- "retry_params_name": "default"
122
- }
123
- }
124
- }
125
- }
126
- }
@@ -1,133 +0,0 @@
1
- # Generated by the protocol buffer compiler. DO NOT EDIT!
2
- # source: google/cloud/tasks/v2beta2/cloudtasks.proto
3
-
4
-
5
- require 'google/protobuf'
6
-
7
- require 'google/api/annotations_pb'
8
- require 'google/api/client_pb'
9
- require 'google/api/field_behavior_pb'
10
- require 'google/api/resource_pb'
11
- require 'google/cloud/tasks/v2beta2/queue_pb'
12
- require 'google/cloud/tasks/v2beta2/task_pb'
13
- require 'google/iam/v1/iam_policy_pb'
14
- require 'google/iam/v1/policy_pb'
15
- require 'google/protobuf/duration_pb'
16
- require 'google/protobuf/empty_pb'
17
- require 'google/protobuf/field_mask_pb'
18
- require 'google/protobuf/timestamp_pb'
19
- Google::Protobuf::DescriptorPool.generated_pool.build do
20
- add_message "google.cloud.tasks.v2beta2.ListQueuesRequest" do
21
- optional :parent, :string, 1
22
- optional :filter, :string, 2
23
- optional :page_size, :int32, 3
24
- optional :page_token, :string, 4
25
- end
26
- add_message "google.cloud.tasks.v2beta2.ListQueuesResponse" do
27
- repeated :queues, :message, 1, "google.cloud.tasks.v2beta2.Queue"
28
- optional :next_page_token, :string, 2
29
- end
30
- add_message "google.cloud.tasks.v2beta2.GetQueueRequest" do
31
- optional :name, :string, 1
32
- end
33
- add_message "google.cloud.tasks.v2beta2.CreateQueueRequest" do
34
- optional :parent, :string, 1
35
- optional :queue, :message, 2, "google.cloud.tasks.v2beta2.Queue"
36
- end
37
- add_message "google.cloud.tasks.v2beta2.UpdateQueueRequest" do
38
- optional :queue, :message, 1, "google.cloud.tasks.v2beta2.Queue"
39
- optional :update_mask, :message, 2, "google.protobuf.FieldMask"
40
- end
41
- add_message "google.cloud.tasks.v2beta2.DeleteQueueRequest" do
42
- optional :name, :string, 1
43
- end
44
- add_message "google.cloud.tasks.v2beta2.PurgeQueueRequest" do
45
- optional :name, :string, 1
46
- end
47
- add_message "google.cloud.tasks.v2beta2.PauseQueueRequest" do
48
- optional :name, :string, 1
49
- end
50
- add_message "google.cloud.tasks.v2beta2.ResumeQueueRequest" do
51
- optional :name, :string, 1
52
- end
53
- add_message "google.cloud.tasks.v2beta2.ListTasksRequest" do
54
- optional :parent, :string, 1
55
- optional :response_view, :enum, 2, "google.cloud.tasks.v2beta2.Task.View"
56
- optional :page_size, :int32, 4
57
- optional :page_token, :string, 5
58
- end
59
- add_message "google.cloud.tasks.v2beta2.ListTasksResponse" do
60
- repeated :tasks, :message, 1, "google.cloud.tasks.v2beta2.Task"
61
- optional :next_page_token, :string, 2
62
- end
63
- add_message "google.cloud.tasks.v2beta2.GetTaskRequest" do
64
- optional :name, :string, 1
65
- optional :response_view, :enum, 2, "google.cloud.tasks.v2beta2.Task.View"
66
- end
67
- add_message "google.cloud.tasks.v2beta2.CreateTaskRequest" do
68
- optional :parent, :string, 1
69
- optional :task, :message, 2, "google.cloud.tasks.v2beta2.Task"
70
- optional :response_view, :enum, 3, "google.cloud.tasks.v2beta2.Task.View"
71
- end
72
- add_message "google.cloud.tasks.v2beta2.DeleteTaskRequest" do
73
- optional :name, :string, 1
74
- end
75
- add_message "google.cloud.tasks.v2beta2.LeaseTasksRequest" do
76
- optional :parent, :string, 1
77
- optional :max_tasks, :int32, 2
78
- optional :lease_duration, :message, 3, "google.protobuf.Duration"
79
- optional :response_view, :enum, 4, "google.cloud.tasks.v2beta2.Task.View"
80
- optional :filter, :string, 5
81
- end
82
- add_message "google.cloud.tasks.v2beta2.LeaseTasksResponse" do
83
- repeated :tasks, :message, 1, "google.cloud.tasks.v2beta2.Task"
84
- end
85
- add_message "google.cloud.tasks.v2beta2.AcknowledgeTaskRequest" do
86
- optional :name, :string, 1
87
- optional :schedule_time, :message, 2, "google.protobuf.Timestamp"
88
- end
89
- add_message "google.cloud.tasks.v2beta2.RenewLeaseRequest" do
90
- optional :name, :string, 1
91
- optional :schedule_time, :message, 2, "google.protobuf.Timestamp"
92
- optional :lease_duration, :message, 3, "google.protobuf.Duration"
93
- optional :response_view, :enum, 4, "google.cloud.tasks.v2beta2.Task.View"
94
- end
95
- add_message "google.cloud.tasks.v2beta2.CancelLeaseRequest" do
96
- optional :name, :string, 1
97
- optional :schedule_time, :message, 2, "google.protobuf.Timestamp"
98
- optional :response_view, :enum, 3, "google.cloud.tasks.v2beta2.Task.View"
99
- end
100
- add_message "google.cloud.tasks.v2beta2.RunTaskRequest" do
101
- optional :name, :string, 1
102
- optional :response_view, :enum, 2, "google.cloud.tasks.v2beta2.Task.View"
103
- end
104
- end
105
-
106
- module Google
107
- module Cloud
108
- module Tasks
109
- module V2beta2
110
- ListQueuesRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.ListQueuesRequest").msgclass
111
- ListQueuesResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.ListQueuesResponse").msgclass
112
- GetQueueRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.GetQueueRequest").msgclass
113
- CreateQueueRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.CreateQueueRequest").msgclass
114
- UpdateQueueRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.UpdateQueueRequest").msgclass
115
- DeleteQueueRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.DeleteQueueRequest").msgclass
116
- PurgeQueueRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.PurgeQueueRequest").msgclass
117
- PauseQueueRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.PauseQueueRequest").msgclass
118
- ResumeQueueRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.ResumeQueueRequest").msgclass
119
- ListTasksRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.ListTasksRequest").msgclass
120
- ListTasksResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.ListTasksResponse").msgclass
121
- GetTaskRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.GetTaskRequest").msgclass
122
- CreateTaskRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.CreateTaskRequest").msgclass
123
- DeleteTaskRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.DeleteTaskRequest").msgclass
124
- LeaseTasksRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.LeaseTasksRequest").msgclass
125
- LeaseTasksResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.LeaseTasksResponse").msgclass
126
- AcknowledgeTaskRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.AcknowledgeTaskRequest").msgclass
127
- RenewLeaseRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.RenewLeaseRequest").msgclass
128
- CancelLeaseRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.CancelLeaseRequest").msgclass
129
- RunTaskRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.RunTaskRequest").msgclass
130
- end
131
- end
132
- end
133
- end
@@ -1,258 +0,0 @@
1
- # Generated by the protocol buffer compiler. DO NOT EDIT!
2
- # Source: google/cloud/tasks/v2beta2/cloudtasks.proto for package 'google.cloud.tasks.v2beta2'
3
- # Original file comments:
4
- # Copyright 2019 Google LLC.
5
- #
6
- # Licensed under the Apache License, Version 2.0 (the "License");
7
- # you may not use this file except in compliance with the License.
8
- # You may obtain a copy of the License at
9
- #
10
- # http://www.apache.org/licenses/LICENSE-2.0
11
- #
12
- # Unless required by applicable law or agreed to in writing, software
13
- # distributed under the License is distributed on an "AS IS" BASIS,
14
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
- # See the License for the specific language governing permissions and
16
- # limitations under the License.
17
- #
18
- #
19
-
20
-
21
- require 'grpc'
22
- require 'google/cloud/tasks/v2beta2/cloudtasks_pb'
23
-
24
- module Google
25
- module Cloud
26
- module Tasks
27
- module V2beta2
28
- module CloudTasks
29
- # Cloud Tasks allows developers to manage the execution of background
30
- # work in their applications.
31
- class Service
32
-
33
- include GRPC::GenericService
34
-
35
- self.marshal_class_method = :encode
36
- self.unmarshal_class_method = :decode
37
- self.service_name = 'google.cloud.tasks.v2beta2.CloudTasks'
38
-
39
- # Lists queues.
40
- #
41
- # Queues are returned in lexicographical order.
42
- rpc :ListQueues, ListQueuesRequest, ListQueuesResponse
43
- # Gets a queue.
44
- rpc :GetQueue, GetQueueRequest, Queue
45
- # Creates a queue.
46
- #
47
- # Queues created with this method allow tasks to live for a maximum of 31
48
- # days. After a task is 31 days old, the task will be deleted regardless of whether
49
- # it was dispatched or not.
50
- #
51
- # WARNING: Using this method may have unintended side effects if you are
52
- # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
53
- # Read
54
- # [Overview of Queue Management and
55
- # queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
56
- # this method.
57
- rpc :CreateQueue, CreateQueueRequest, Queue
58
- # Updates a queue.
59
- #
60
- # This method creates the queue if it does not exist and updates
61
- # the queue if it does exist.
62
- #
63
- # Queues created with this method allow tasks to live for a maximum of 31
64
- # days. After a task is 31 days old, the task will be deleted regardless of whether
65
- # it was dispatched or not.
66
- #
67
- # WARNING: Using this method may have unintended side effects if you are
68
- # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
69
- # Read
70
- # [Overview of Queue Management and
71
- # queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
72
- # this method.
73
- rpc :UpdateQueue, UpdateQueueRequest, Queue
74
- # Deletes a queue.
75
- #
76
- # This command will delete the queue even if it has tasks in it.
77
- #
78
- # Note: If you delete a queue, a queue with the same name can't be created
79
- # for 7 days.
80
- #
81
- # WARNING: Using this method may have unintended side effects if you are
82
- # using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
83
- # Read
84
- # [Overview of Queue Management and
85
- # queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
86
- # this method.
87
- rpc :DeleteQueue, DeleteQueueRequest, Google::Protobuf::Empty
88
- # Purges a queue by deleting all of its tasks.
89
- #
90
- # All tasks created before this method is called are permanently deleted.
91
- #
92
- # Purge operations can take up to one minute to take effect. Tasks
93
- # might be dispatched before the purge takes effect. A purge is irreversible.
94
- rpc :PurgeQueue, PurgeQueueRequest, Queue
95
- # Pauses the queue.
96
- #
97
- # If a queue is paused then the system will stop dispatching tasks
98
- # until the queue is resumed via
99
- # [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue]. Tasks can still be added
100
- # when the queue is paused. A queue is paused if its
101
- # [state][google.cloud.tasks.v2beta2.Queue.state] is [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED].
102
- rpc :PauseQueue, PauseQueueRequest, Queue
103
- # Resume a queue.
104
- #
105
- # This method resumes a queue after it has been
106
- # [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED] or
107
- # [DISABLED][google.cloud.tasks.v2beta2.Queue.State.DISABLED]. The state of a queue is stored
108
- # in the queue's [state][google.cloud.tasks.v2beta2.Queue.state]; after calling this method it
109
- # will be set to [RUNNING][google.cloud.tasks.v2beta2.Queue.State.RUNNING].
110
- #
111
- # WARNING: Resuming many high-QPS queues at the same time can
112
- # lead to target overloading. If you are resuming high-QPS
113
- # queues, follow the 500/50/5 pattern described in
114
- # [Managing Cloud Tasks Scaling
115
- # Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
116
- rpc :ResumeQueue, ResumeQueueRequest, Queue
117
- # Gets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue].
118
- # Returns an empty policy if the resource exists and does not have a policy
119
- # set.
120
- #
121
- # Authorization requires the following
122
- # [Google IAM](https://cloud.google.com/iam) permission on the specified
123
- # resource parent:
124
- #
125
- # * `cloudtasks.queues.getIamPolicy`
126
- rpc :GetIamPolicy, Google::Iam::V1::GetIamPolicyRequest, Google::Iam::V1::Policy
127
- # Sets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue]. Replaces any existing
128
- # policy.
129
- #
130
- # Note: The Cloud Console does not check queue-level IAM permissions yet.
131
- # Project-level permissions are required to use the Cloud Console.
132
- #
133
- # Authorization requires the following
134
- # [Google IAM](https://cloud.google.com/iam) permission on the specified
135
- # resource parent:
136
- #
137
- # * `cloudtasks.queues.setIamPolicy`
138
- rpc :SetIamPolicy, Google::Iam::V1::SetIamPolicyRequest, Google::Iam::V1::Policy
139
- # Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta2.Queue].
140
- # If the resource does not exist, this will return an empty set of
141
- # permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
142
- #
143
- # Note: This operation is designed to be used for building permission-aware
144
- # UIs and command-line tools, not for authorization checking. This operation
145
- # may "fail open" without warning.
146
- rpc :TestIamPermissions, Google::Iam::V1::TestIamPermissionsRequest, Google::Iam::V1::TestIamPermissionsResponse
147
- # Lists the tasks in a queue.
148
- #
149
- # By default, only the [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC] view is retrieved
150
- # due to performance considerations;
151
- # [response_view][google.cloud.tasks.v2beta2.ListTasksRequest.response_view] controls the
152
- # subset of information which is returned.
153
- #
154
- # The tasks may be returned in any order. The ordering may change at any
155
- # time.
156
- rpc :ListTasks, ListTasksRequest, ListTasksResponse
157
- # Gets a task.
158
- rpc :GetTask, GetTaskRequest, Task
159
- # Creates a task and adds it to a queue.
160
- #
161
- # Tasks cannot be updated after creation; there is no UpdateTask command.
162
- #
163
- # * For [App Engine queues][google.cloud.tasks.v2beta2.AppEngineHttpTarget], the maximum task size is
164
- # 100KB.
165
- # * For [pull queues][google.cloud.tasks.v2beta2.PullTarget], the maximum task size is 1MB.
166
- rpc :CreateTask, CreateTaskRequest, Task
167
- # Deletes a task.
168
- #
169
- # A task can be deleted if it is scheduled or dispatched. A task
170
- # cannot be deleted if it has completed successfully or permanently
171
- # failed.
172
- rpc :DeleteTask, DeleteTaskRequest, Google::Protobuf::Empty
173
- # Leases tasks from a pull queue for
174
- # [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].
175
- #
176
- # This method is invoked by the worker to obtain a lease. The
177
- # worker must acknowledge the task via
178
- # [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] after they have
179
- # performed the work associated with the task.
180
- #
181
- # The [payload][google.cloud.tasks.v2beta2.PullMessage.payload] is intended to store data that
182
- # the worker needs to perform the work associated with the task. To
183
- # return the payloads in the [response][google.cloud.tasks.v2beta2.LeaseTasksResponse], set
184
- # [response_view][google.cloud.tasks.v2beta2.LeaseTasksRequest.response_view] to
185
- # [FULL][google.cloud.tasks.v2beta2.Task.View.FULL].
186
- #
187
- # A maximum of 10 qps of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks]
188
- # requests are allowed per
189
- # queue. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
190
- # is returned when this limit is
191
- # exceeded. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED]
192
- # is also returned when
193
- # [max_tasks_dispatched_per_second][google.cloud.tasks.v2beta2.RateLimits.max_tasks_dispatched_per_second]
194
- # is exceeded.
195
- rpc :LeaseTasks, LeaseTasksRequest, LeaseTasksResponse
196
- # Acknowledges a pull task.
197
- #
198
- # The worker, that is, the entity that
199
- # [leased][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] this task must call this method
200
- # to indicate that the work associated with the task has finished.
201
- #
202
- # The worker must acknowledge a task within the
203
- # [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration] or the lease
204
- # will expire and the task will become available to be leased
205
- # again. After the task is acknowledged, it will not be returned
206
- # by a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks],
207
- # [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask], or
208
- # [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].
209
- rpc :AcknowledgeTask, AcknowledgeTaskRequest, Google::Protobuf::Empty
210
- # Renew the current lease of a pull task.
211
- #
212
- # The worker can use this method to extend the lease by a new
213
- # duration, starting from now. The new task lease will be
214
- # returned in the task's [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time].
215
- rpc :RenewLease, RenewLeaseRequest, Task
216
- # Cancel a pull task's lease.
217
- #
218
- # The worker can use this method to cancel a task's lease by
219
- # setting its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] to now. This will
220
- # make the task available to be leased to the next caller of
221
- # [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
222
- rpc :CancelLease, CancelLeaseRequest, Task
223
- # Forces a task to run now.
224
- #
225
- # When this method is called, Cloud Tasks will dispatch the task, even if
226
- # the task is already running, the queue has reached its [RateLimits][google.cloud.tasks.v2beta2.RateLimits] or
227
- # is [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED].
228
- #
229
- # This command is meant to be used for manual debugging. For
230
- # example, [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] can be used to retry a failed
231
- # task after a fix has been made or to manually force a task to be
232
- # dispatched now.
233
- #
234
- # The dispatched task is returned. That is, the task that is returned
235
- # contains the [status][google.cloud.tasks.v2beta2.Task.status] after the task is dispatched but
236
- # before the task is received by its target.
237
- #
238
- # If Cloud Tasks receives a successful response from the task's
239
- # target, then the task will be deleted; otherwise the task's
240
- # [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] will be reset to the time that
241
- # [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] was called plus the retry delay specified
242
- # in the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig].
243
- #
244
- # [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] returns
245
- # [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
246
- # task that has already succeeded or permanently failed.
247
- #
248
- # [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] cannot be called on a
249
- # [pull task][google.cloud.tasks.v2beta2.PullMessage].
250
- rpc :RunTask, RunTaskRequest, Task
251
- end
252
-
253
- Stub = Service.rpc_stub_class
254
- end
255
- end
256
- end
257
- end
258
- end