google-cloud-tasks-v2beta2 0.2.6 → 0.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +8 -8
- data/LICENSE.md +188 -190
- data/README.md +67 -3
- data/lib/google/cloud/tasks/v2beta2/cloud_tasks/client.rb +71 -79
- data/lib/google/cloud/tasks/v2beta2/cloudtasks_pb.rb +2 -0
- data/lib/google/cloud/tasks/v2beta2/cloudtasks_services_pb.rb +1 -2
- data/lib/google/cloud/tasks/v2beta2/queue_pb.rb +12 -0
- data/lib/google/cloud/tasks/v2beta2/version.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +12 -0
- data/proto_docs/google/cloud/tasks/v2beta2/cloudtasks.rb +12 -0
- data/proto_docs/google/cloud/tasks/v2beta2/queue.rb +77 -15
- data/proto_docs/google/cloud/tasks/v2beta2/target.rb +8 -11
- data/proto_docs/google/protobuf/any.rb +5 -2
- data/proto_docs/google/protobuf/timestamp.rb +10 -1
- data/proto_docs/google/type/expr.rb +35 -12
- metadata +21 -13
@@ -61,98 +61,74 @@ module Google
|
|
61
61
|
parent_config = while namespace.any?
|
62
62
|
parent_name = namespace.join "::"
|
63
63
|
parent_const = const_get parent_name
|
64
|
-
break parent_const.configure if parent_const
|
64
|
+
break parent_const.configure if parent_const.respond_to? :configure
|
65
65
|
namespace.pop
|
66
66
|
end
|
67
67
|
default_config = Client::Configuration.new parent_config
|
68
68
|
|
69
|
-
default_config.rpcs.list_queues.timeout =
|
69
|
+
default_config.rpcs.list_queues.timeout = 20.0
|
70
70
|
default_config.rpcs.list_queues.retry_policy = {
|
71
|
-
initial_delay: 0.1,
|
72
|
-
max_delay: 10.0,
|
73
|
-
multiplier: 1.3,
|
74
|
-
retry_codes: [14, 4]
|
71
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
|
75
72
|
}
|
76
73
|
|
77
|
-
default_config.rpcs.get_queue.timeout =
|
74
|
+
default_config.rpcs.get_queue.timeout = 20.0
|
78
75
|
default_config.rpcs.get_queue.retry_policy = {
|
79
|
-
initial_delay: 0.1,
|
80
|
-
max_delay: 10.0,
|
81
|
-
multiplier: 1.3,
|
82
|
-
retry_codes: [14, 4]
|
76
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
|
83
77
|
}
|
84
78
|
|
85
|
-
default_config.rpcs.create_queue.timeout =
|
79
|
+
default_config.rpcs.create_queue.timeout = 20.0
|
86
80
|
|
87
|
-
default_config.rpcs.update_queue.timeout =
|
81
|
+
default_config.rpcs.update_queue.timeout = 20.0
|
88
82
|
|
89
|
-
default_config.rpcs.delete_queue.timeout =
|
83
|
+
default_config.rpcs.delete_queue.timeout = 20.0
|
90
84
|
default_config.rpcs.delete_queue.retry_policy = {
|
91
|
-
initial_delay: 0.1,
|
92
|
-
max_delay: 10.0,
|
93
|
-
multiplier: 1.3,
|
94
|
-
retry_codes: [14, 4]
|
85
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
|
95
86
|
}
|
96
87
|
|
97
|
-
default_config.rpcs.purge_queue.timeout =
|
88
|
+
default_config.rpcs.purge_queue.timeout = 20.0
|
98
89
|
|
99
|
-
default_config.rpcs.pause_queue.timeout =
|
90
|
+
default_config.rpcs.pause_queue.timeout = 20.0
|
100
91
|
|
101
|
-
default_config.rpcs.resume_queue.timeout =
|
92
|
+
default_config.rpcs.resume_queue.timeout = 20.0
|
102
93
|
|
103
|
-
default_config.rpcs.get_iam_policy.timeout =
|
94
|
+
default_config.rpcs.get_iam_policy.timeout = 20.0
|
104
95
|
default_config.rpcs.get_iam_policy.retry_policy = {
|
105
|
-
initial_delay: 0.1,
|
106
|
-
max_delay: 10.0,
|
107
|
-
multiplier: 1.3,
|
108
|
-
retry_codes: [14, 4]
|
96
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
|
109
97
|
}
|
110
98
|
|
111
|
-
default_config.rpcs.set_iam_policy.timeout =
|
99
|
+
default_config.rpcs.set_iam_policy.timeout = 20.0
|
112
100
|
|
113
|
-
default_config.rpcs.test_iam_permissions.timeout =
|
101
|
+
default_config.rpcs.test_iam_permissions.timeout = 20.0
|
114
102
|
default_config.rpcs.test_iam_permissions.retry_policy = {
|
115
|
-
initial_delay: 0.1,
|
116
|
-
max_delay: 10.0,
|
117
|
-
multiplier: 1.3,
|
118
|
-
retry_codes: [14, 4]
|
103
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
|
119
104
|
}
|
120
105
|
|
121
|
-
default_config.rpcs.list_tasks.timeout =
|
106
|
+
default_config.rpcs.list_tasks.timeout = 20.0
|
122
107
|
default_config.rpcs.list_tasks.retry_policy = {
|
123
|
-
initial_delay: 0.1,
|
124
|
-
max_delay: 10.0,
|
125
|
-
multiplier: 1.3,
|
126
|
-
retry_codes: [14, 4]
|
108
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
|
127
109
|
}
|
128
110
|
|
129
|
-
default_config.rpcs.get_task.timeout =
|
111
|
+
default_config.rpcs.get_task.timeout = 20.0
|
130
112
|
default_config.rpcs.get_task.retry_policy = {
|
131
|
-
initial_delay: 0.1,
|
132
|
-
max_delay: 10.0,
|
133
|
-
multiplier: 1.3,
|
134
|
-
retry_codes: [14, 4]
|
113
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
|
135
114
|
}
|
136
115
|
|
137
|
-
default_config.rpcs.create_task.timeout =
|
116
|
+
default_config.rpcs.create_task.timeout = 20.0
|
138
117
|
|
139
|
-
default_config.rpcs.delete_task.timeout =
|
118
|
+
default_config.rpcs.delete_task.timeout = 20.0
|
140
119
|
default_config.rpcs.delete_task.retry_policy = {
|
141
|
-
initial_delay: 0.1,
|
142
|
-
max_delay: 10.0,
|
143
|
-
multiplier: 1.3,
|
144
|
-
retry_codes: [14, 4]
|
120
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
|
145
121
|
}
|
146
122
|
|
147
|
-
default_config.rpcs.lease_tasks.timeout =
|
123
|
+
default_config.rpcs.lease_tasks.timeout = 20.0
|
148
124
|
|
149
|
-
default_config.rpcs.acknowledge_task.timeout =
|
125
|
+
default_config.rpcs.acknowledge_task.timeout = 20.0
|
150
126
|
|
151
|
-
default_config.rpcs.renew_lease.timeout =
|
127
|
+
default_config.rpcs.renew_lease.timeout = 20.0
|
152
128
|
|
153
|
-
default_config.rpcs.cancel_lease.timeout =
|
129
|
+
default_config.rpcs.cancel_lease.timeout = 20.0
|
154
130
|
|
155
|
-
default_config.rpcs.run_task.timeout =
|
131
|
+
default_config.rpcs.run_task.timeout = 20.0
|
156
132
|
|
157
133
|
default_config
|
158
134
|
end
|
@@ -215,8 +191,14 @@ module Google
|
|
215
191
|
|
216
192
|
# Create credentials
|
217
193
|
credentials = @config.credentials
|
218
|
-
|
219
|
-
if
|
194
|
+
# Use self-signed JWT if the scope and endpoint are unchanged from default,
|
195
|
+
# but only if the default endpoint does not have a region prefix.
|
196
|
+
enable_self_signed_jwt = @config.scope == Client.configure.scope &&
|
197
|
+
@config.endpoint == Client.configure.endpoint &&
|
198
|
+
!@config.endpoint.split(".").first.include?("-")
|
199
|
+
credentials ||= Credentials.default scope: @config.scope,
|
200
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
201
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
220
202
|
credentials = Credentials.new credentials, scope: @config.scope
|
221
203
|
end
|
222
204
|
@quota_project_id = @config.quota_project
|
@@ -248,7 +230,7 @@ module Google
|
|
248
230
|
# @param options [::Gapic::CallOptions, ::Hash]
|
249
231
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
250
232
|
#
|
251
|
-
# @overload list_queues(parent: nil, filter: nil, page_size: nil, page_token: nil)
|
233
|
+
# @overload list_queues(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil)
|
252
234
|
# Pass arguments to `list_queues` via keyword arguments. Note that at
|
253
235
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
254
236
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -285,6 +267,11 @@ module Google
|
|
285
267
|
# from the previous call to {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_queues ListQueues}
|
286
268
|
# method. It is an error to switch the value of the
|
287
269
|
# {::Google::Cloud::Tasks::V2beta2::ListQueuesRequest#filter filter} while iterating through pages.
|
270
|
+
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
271
|
+
# Optional. Read mask is used for a more granular control over what the API returns.
|
272
|
+
# If the mask is not present all fields will be returned except
|
273
|
+
# [Queue.stats]. [Queue.stats] will be returned only if it was explicitly
|
274
|
+
# specified in the mask.
|
288
275
|
#
|
289
276
|
# @yield [response, operation] Access the result along with the RPC operation
|
290
277
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Tasks::V2beta2::Queue>]
|
@@ -345,7 +332,7 @@ module Google
|
|
345
332
|
# @param options [::Gapic::CallOptions, ::Hash]
|
346
333
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
347
334
|
#
|
348
|
-
# @overload get_queue(name: nil)
|
335
|
+
# @overload get_queue(name: nil, read_mask: nil)
|
349
336
|
# Pass arguments to `get_queue` via keyword arguments. Note that at
|
350
337
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
351
338
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -353,6 +340,11 @@ module Google
|
|
353
340
|
# @param name [::String]
|
354
341
|
# Required. The resource name of the queue. For example:
|
355
342
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
343
|
+
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
344
|
+
# Optional. Read mask is used for a more granular control over what the API returns.
|
345
|
+
# If the mask is not present all fields will be returned except
|
346
|
+
# [Queue.stats]. [Queue.stats] will be returned only if it was explicitly
|
347
|
+
# specified in the mask.
|
356
348
|
#
|
357
349
|
# @yield [response, operation] Access the result along with the RPC operation
|
358
350
|
# @yieldparam response [::Google::Cloud::Tasks::V2beta2::Queue]
|
@@ -2129,7 +2121,7 @@ module Google
|
|
2129
2121
|
config_attr :scope, nil, ::String, ::Array, nil
|
2130
2122
|
config_attr :lib_name, nil, ::String, nil
|
2131
2123
|
config_attr :lib_version, nil, ::String, nil
|
2132
|
-
config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
|
2124
|
+
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
2133
2125
|
config_attr :interceptors, nil, ::Array, nil
|
2134
2126
|
config_attr :timeout, nil, ::Numeric, nil
|
2135
2127
|
config_attr :metadata, nil, ::Hash, nil
|
@@ -2150,7 +2142,7 @@ module Google
|
|
2150
2142
|
def rpcs
|
2151
2143
|
@rpcs ||= begin
|
2152
2144
|
parent_rpcs = nil
|
2153
|
-
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config
|
2145
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
2154
2146
|
Rpcs.new parent_rpcs
|
2155
2147
|
end
|
2156
2148
|
end
|
@@ -2276,45 +2268,45 @@ module Google
|
|
2276
2268
|
|
2277
2269
|
# @private
|
2278
2270
|
def initialize parent_rpcs = nil
|
2279
|
-
list_queues_config = parent_rpcs
|
2271
|
+
list_queues_config = parent_rpcs.list_queues if parent_rpcs.respond_to? :list_queues
|
2280
2272
|
@list_queues = ::Gapic::Config::Method.new list_queues_config
|
2281
|
-
get_queue_config = parent_rpcs
|
2273
|
+
get_queue_config = parent_rpcs.get_queue if parent_rpcs.respond_to? :get_queue
|
2282
2274
|
@get_queue = ::Gapic::Config::Method.new get_queue_config
|
2283
|
-
create_queue_config = parent_rpcs
|
2275
|
+
create_queue_config = parent_rpcs.create_queue if parent_rpcs.respond_to? :create_queue
|
2284
2276
|
@create_queue = ::Gapic::Config::Method.new create_queue_config
|
2285
|
-
update_queue_config = parent_rpcs
|
2277
|
+
update_queue_config = parent_rpcs.update_queue if parent_rpcs.respond_to? :update_queue
|
2286
2278
|
@update_queue = ::Gapic::Config::Method.new update_queue_config
|
2287
|
-
delete_queue_config = parent_rpcs
|
2279
|
+
delete_queue_config = parent_rpcs.delete_queue if parent_rpcs.respond_to? :delete_queue
|
2288
2280
|
@delete_queue = ::Gapic::Config::Method.new delete_queue_config
|
2289
|
-
purge_queue_config = parent_rpcs
|
2281
|
+
purge_queue_config = parent_rpcs.purge_queue if parent_rpcs.respond_to? :purge_queue
|
2290
2282
|
@purge_queue = ::Gapic::Config::Method.new purge_queue_config
|
2291
|
-
pause_queue_config = parent_rpcs
|
2283
|
+
pause_queue_config = parent_rpcs.pause_queue if parent_rpcs.respond_to? :pause_queue
|
2292
2284
|
@pause_queue = ::Gapic::Config::Method.new pause_queue_config
|
2293
|
-
resume_queue_config = parent_rpcs
|
2285
|
+
resume_queue_config = parent_rpcs.resume_queue if parent_rpcs.respond_to? :resume_queue
|
2294
2286
|
@resume_queue = ::Gapic::Config::Method.new resume_queue_config
|
2295
|
-
get_iam_policy_config = parent_rpcs
|
2287
|
+
get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
|
2296
2288
|
@get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
|
2297
|
-
set_iam_policy_config = parent_rpcs
|
2289
|
+
set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
|
2298
2290
|
@set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
|
2299
|
-
test_iam_permissions_config = parent_rpcs
|
2291
|
+
test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
|
2300
2292
|
@test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
|
2301
|
-
list_tasks_config = parent_rpcs
|
2293
|
+
list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
|
2302
2294
|
@list_tasks = ::Gapic::Config::Method.new list_tasks_config
|
2303
|
-
get_task_config = parent_rpcs
|
2295
|
+
get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
|
2304
2296
|
@get_task = ::Gapic::Config::Method.new get_task_config
|
2305
|
-
create_task_config = parent_rpcs
|
2297
|
+
create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
|
2306
2298
|
@create_task = ::Gapic::Config::Method.new create_task_config
|
2307
|
-
delete_task_config = parent_rpcs
|
2299
|
+
delete_task_config = parent_rpcs.delete_task if parent_rpcs.respond_to? :delete_task
|
2308
2300
|
@delete_task = ::Gapic::Config::Method.new delete_task_config
|
2309
|
-
lease_tasks_config = parent_rpcs
|
2301
|
+
lease_tasks_config = parent_rpcs.lease_tasks if parent_rpcs.respond_to? :lease_tasks
|
2310
2302
|
@lease_tasks = ::Gapic::Config::Method.new lease_tasks_config
|
2311
|
-
acknowledge_task_config = parent_rpcs
|
2303
|
+
acknowledge_task_config = parent_rpcs.acknowledge_task if parent_rpcs.respond_to? :acknowledge_task
|
2312
2304
|
@acknowledge_task = ::Gapic::Config::Method.new acknowledge_task_config
|
2313
|
-
renew_lease_config = parent_rpcs
|
2305
|
+
renew_lease_config = parent_rpcs.renew_lease if parent_rpcs.respond_to? :renew_lease
|
2314
2306
|
@renew_lease = ::Gapic::Config::Method.new renew_lease_config
|
2315
|
-
cancel_lease_config = parent_rpcs
|
2307
|
+
cancel_lease_config = parent_rpcs.cancel_lease if parent_rpcs.respond_to? :cancel_lease
|
2316
2308
|
@cancel_lease = ::Gapic::Config::Method.new cancel_lease_config
|
2317
|
-
run_task_config = parent_rpcs
|
2309
|
+
run_task_config = parent_rpcs.run_task if parent_rpcs.respond_to? :run_task
|
2318
2310
|
@run_task = ::Gapic::Config::Method.new run_task_config
|
2319
2311
|
|
2320
2312
|
yield self if block_given?
|
@@ -22,6 +22,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
22
22
|
optional :filter, :string, 2
|
23
23
|
optional :page_size, :int32, 3
|
24
24
|
optional :page_token, :string, 4
|
25
|
+
optional :read_mask, :message, 5, "google.protobuf.FieldMask"
|
25
26
|
end
|
26
27
|
add_message "google.cloud.tasks.v2beta2.ListQueuesResponse" do
|
27
28
|
repeated :queues, :message, 1, "google.cloud.tasks.v2beta2.Queue"
|
@@ -29,6 +30,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
29
30
|
end
|
30
31
|
add_message "google.cloud.tasks.v2beta2.GetQueueRequest" do
|
31
32
|
optional :name, :string, 1
|
33
|
+
optional :read_mask, :message, 2, "google.protobuf.FieldMask"
|
32
34
|
end
|
33
35
|
add_message "google.cloud.tasks.v2beta2.CreateQueueRequest" do
|
34
36
|
optional :parent, :string, 1
|
@@ -1,7 +1,7 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# Source: google/cloud/tasks/v2beta2/cloudtasks.proto for package 'google.cloud.tasks.v2beta2'
|
3
3
|
# Original file comments:
|
4
|
-
# Copyright
|
4
|
+
# Copyright 2020 Google LLC
|
5
5
|
#
|
6
6
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
7
7
|
# you may not use this file except in compliance with the License.
|
@@ -15,7 +15,6 @@
|
|
15
15
|
# See the License for the specific language governing permissions and
|
16
16
|
# limitations under the License.
|
17
17
|
#
|
18
|
-
#
|
19
18
|
|
20
19
|
require 'grpc'
|
21
20
|
require 'google/cloud/tasks/v2beta2/cloudtasks_pb'
|
@@ -3,6 +3,7 @@
|
|
3
3
|
|
4
4
|
require 'google/protobuf'
|
5
5
|
|
6
|
+
require 'google/api/field_behavior_pb'
|
6
7
|
require 'google/api/resource_pb'
|
7
8
|
require 'google/cloud/tasks/v2beta2/target_pb'
|
8
9
|
require 'google/protobuf/duration_pb'
|
@@ -16,6 +17,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
16
17
|
optional :retry_config, :message, 6, "google.cloud.tasks.v2beta2.RetryConfig"
|
17
18
|
optional :state, :enum, 7, "google.cloud.tasks.v2beta2.Queue.State"
|
18
19
|
optional :purge_time, :message, 8, "google.protobuf.Timestamp"
|
20
|
+
optional :task_ttl, :message, 9, "google.protobuf.Duration"
|
21
|
+
optional :tombstone_ttl, :message, 10, "google.protobuf.Duration"
|
22
|
+
optional :stats, :message, 16, "google.cloud.tasks.v2beta2.QueueStats"
|
19
23
|
oneof :target_type do
|
20
24
|
optional :app_engine_http_target, :message, 3, "google.cloud.tasks.v2beta2.AppEngineHttpTarget"
|
21
25
|
optional :pull_target, :message, 4, "google.cloud.tasks.v2beta2.PullTarget"
|
@@ -42,6 +46,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
42
46
|
optional :unlimited_attempts, :bool, 2
|
43
47
|
end
|
44
48
|
end
|
49
|
+
add_message "google.cloud.tasks.v2beta2.QueueStats" do
|
50
|
+
optional :tasks_count, :int64, 1
|
51
|
+
optional :oldest_estimated_arrival_time, :message, 2, "google.protobuf.Timestamp"
|
52
|
+
optional :executed_last_minute_count, :int64, 3
|
53
|
+
optional :concurrent_dispatches_count, :int64, 4
|
54
|
+
optional :effective_execution_rate, :double, 5
|
55
|
+
end
|
45
56
|
end
|
46
57
|
end
|
47
58
|
|
@@ -53,6 +64,7 @@ module Google
|
|
53
64
|
Queue::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.Queue.State").enummodule
|
54
65
|
RateLimits = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.RateLimits").msgclass
|
55
66
|
RetryConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.RetryConfig").msgclass
|
67
|
+
QueueStats = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta2.QueueStats").msgclass
|
56
68
|
end
|
57
69
|
end
|
58
70
|
end
|
@@ -54,6 +54,18 @@ module Google
|
|
54
54
|
# This indicates that the field may be set once in a request to create a
|
55
55
|
# resource, but may not be changed thereafter.
|
56
56
|
IMMUTABLE = 5
|
57
|
+
|
58
|
+
# Denotes that a (repeated) field is an unordered list.
|
59
|
+
# This indicates that the service may provide the elements of the list
|
60
|
+
# in any arbitrary order, rather than the order the user originally
|
61
|
+
# provided. Additionally, the list's order may or may not be stable.
|
62
|
+
UNORDERED_LIST = 6
|
63
|
+
|
64
|
+
# Denotes that this field returns a non-empty default value if not set.
|
65
|
+
# This indicates that if the user provides the empty value in a request,
|
66
|
+
# a non-empty value will be returned. The user will not be aware of what
|
67
|
+
# non-empty value to expect.
|
68
|
+
NON_EMPTY_DEFAULT = 7
|
57
69
|
end
|
58
70
|
end
|
59
71
|
end
|
@@ -58,6 +58,12 @@ module Google
|
|
58
58
|
# from the previous call to {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_queues ListQueues}
|
59
59
|
# method. It is an error to switch the value of the
|
60
60
|
# {::Google::Cloud::Tasks::V2beta2::ListQueuesRequest#filter filter} while iterating through pages.
|
61
|
+
# @!attribute [rw] read_mask
|
62
|
+
# @return [::Google::Protobuf::FieldMask]
|
63
|
+
# Optional. Read mask is used for a more granular control over what the API returns.
|
64
|
+
# If the mask is not present all fields will be returned except
|
65
|
+
# [Queue.stats]. [Queue.stats] will be returned only if it was explicitly
|
66
|
+
# specified in the mask.
|
61
67
|
class ListQueuesRequest
|
62
68
|
include ::Google::Protobuf::MessageExts
|
63
69
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -88,6 +94,12 @@ module Google
|
|
88
94
|
# @return [::String]
|
89
95
|
# Required. The resource name of the queue. For example:
|
90
96
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
97
|
+
# @!attribute [rw] read_mask
|
98
|
+
# @return [::Google::Protobuf::FieldMask]
|
99
|
+
# Optional. Read mask is used for a more granular control over what the API returns.
|
100
|
+
# If the mask is not present all fields will be returned except
|
101
|
+
# [Queue.stats]. [Queue.stats] will be returned only if it was explicitly
|
102
|
+
# specified in the mask.
|
91
103
|
class GetQueueRequest
|
92
104
|
include ::Google::Protobuf::MessageExts
|
93
105
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -88,7 +88,7 @@ module Google
|
|
88
88
|
# @return [::Google::Cloud::Tasks::V2beta2::Queue::State]
|
89
89
|
# Output only. The state of the queue.
|
90
90
|
#
|
91
|
-
# `state` can only be changed by
|
91
|
+
# `state` can only be changed by calling
|
92
92
|
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#pause_queue PauseQueue},
|
93
93
|
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#resume_queue ResumeQueue}, or uploading
|
94
94
|
# [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
|
@@ -106,6 +106,37 @@ module Google
|
|
106
106
|
#
|
107
107
|
# Purge time will be truncated to the nearest microsecond. Purge
|
108
108
|
# time will be unset if the queue has never been purged.
|
109
|
+
# @!attribute [rw] task_ttl
|
110
|
+
# @return [::Google::Protobuf::Duration]
|
111
|
+
# The maximum amount of time that a task will be retained in
|
112
|
+
# this queue.
|
113
|
+
#
|
114
|
+
# Queues created by Cloud Tasks have a default `task_ttl` of 31 days.
|
115
|
+
# After a task has lived for `task_ttl`, the task will be deleted
|
116
|
+
# regardless of whether it was dispatched or not.
|
117
|
+
#
|
118
|
+
# The `task_ttl` for queues created via queue.yaml/xml is equal to the
|
119
|
+
# maximum duration because there is a
|
120
|
+
# [storage quota](https://cloud.google.com/appengine/quotas#Task_Queue) for
|
121
|
+
# these queues. To view the maximum valid duration, see the documentation for
|
122
|
+
# {::Google::Protobuf::Duration Duration}.
|
123
|
+
# @!attribute [rw] tombstone_ttl
|
124
|
+
# @return [::Google::Protobuf::Duration]
|
125
|
+
# The task tombstone time to live (TTL).
|
126
|
+
#
|
127
|
+
# After a task is deleted or completed, the task's tombstone is
|
128
|
+
# retained for the length of time specified by `tombstone_ttl`.
|
129
|
+
# The tombstone is used by task de-duplication; another task with the same
|
130
|
+
# name can't be created until the tombstone has expired. For more information
|
131
|
+
# about task de-duplication, see the documentation for
|
132
|
+
# {::Google::Cloud::Tasks::V2beta2::CreateTaskRequest#task CreateTaskRequest}.
|
133
|
+
#
|
134
|
+
# Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour.
|
135
|
+
# @!attribute [r] stats
|
136
|
+
# @return [::Google::Cloud::Tasks::V2beta2::QueueStats]
|
137
|
+
# Output only. The realtime, informational statistics for a queue. In order
|
138
|
+
# to receive the statistics the caller should include this field in the
|
139
|
+
# FieldMask.
|
109
140
|
class Queue
|
110
141
|
include ::Google::Protobuf::MessageExts
|
111
142
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -178,7 +209,7 @@ module Google
|
|
178
209
|
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
|
179
210
|
# @!attribute [rw] max_burst_size
|
180
211
|
# @return [::Integer]
|
181
|
-
#
|
212
|
+
# The max burst size.
|
182
213
|
#
|
183
214
|
# Max burst size limits how fast tasks in queue are processed when
|
184
215
|
# many tasks are in the queue and the rate is high. This field
|
@@ -193,23 +224,23 @@ module Google
|
|
193
224
|
# token is removed from the bucket. Tasks will be dispatched until
|
194
225
|
# the queue's bucket runs out of tokens. The bucket will be
|
195
226
|
# continuously refilled with new tokens based on
|
196
|
-
#
|
227
|
+
# [max_dispatches_per_second][RateLimits.max_dispatches_per_second].
|
228
|
+
#
|
229
|
+
# The default value of `max_burst_size` is picked by Cloud Tasks
|
230
|
+
# based on the value of
|
231
|
+
# [max_dispatches_per_second][RateLimits.max_dispatches_per_second].
|
197
232
|
#
|
198
|
-
#
|
199
|
-
# value of
|
200
|
-
# {::Google::Cloud::Tasks::V2beta2::RateLimits#max_tasks_dispatched_per_second max_tasks_dispatched_per_second}.
|
233
|
+
# The maximum value of `max_burst_size` is 500.
|
201
234
|
#
|
202
235
|
# For App Engine queues that were created or updated using
|
203
236
|
# `queue.yaml/xml`, `max_burst_size` is equal to
|
204
237
|
# [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
|
205
|
-
#
|
206
|
-
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#update_queue UpdateQueue} is called on a queue
|
207
|
-
#
|
208
|
-
#
|
209
|
-
# {::Google::Cloud::Tasks::V2beta2::
|
210
|
-
#
|
211
|
-
# {::Google::Cloud::Tasks::V2beta2::RateLimits#max_tasks_dispatched_per_second max_tasks_dispatched_per_second}
|
212
|
-
# is updated.
|
238
|
+
# If
|
239
|
+
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#update_queue UpdateQueue} is called on a queue without
|
240
|
+
# explicitly setting a value for `max_burst_size`,
|
241
|
+
# `max_burst_size` value will get updated if
|
242
|
+
# {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#update_queue UpdateQueue} is updating
|
243
|
+
# [max_dispatches_per_second][RateLimits.max_dispatches_per_second].
|
213
244
|
# @!attribute [rw] max_concurrent_tasks
|
214
245
|
# @return [::Integer]
|
215
246
|
# The maximum number of concurrent tasks that Cloud Tasks allows
|
@@ -316,7 +347,7 @@ module Google
|
|
316
347
|
# A task's retry interval starts at
|
317
348
|
# {::Google::Cloud::Tasks::V2beta2::RetryConfig#min_backoff min_backoff}, then doubles
|
318
349
|
# `max_doublings` times, then increases linearly, and finally
|
319
|
-
# retries
|
350
|
+
# retries at intervals of
|
320
351
|
# {::Google::Cloud::Tasks::V2beta2::RetryConfig#max_backoff max_backoff} up to
|
321
352
|
# {::Google::Cloud::Tasks::V2beta2::RetryConfig#max_attempts max_attempts} times.
|
322
353
|
#
|
@@ -343,6 +374,37 @@ module Google
|
|
343
374
|
include ::Google::Protobuf::MessageExts
|
344
375
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
345
376
|
end
|
377
|
+
|
378
|
+
# Statistics for a queue.
|
379
|
+
# @!attribute [r] tasks_count
|
380
|
+
# @return [::Integer]
|
381
|
+
# Output only. An estimation of the number of tasks in the queue, that is, the tasks in
|
382
|
+
# the queue that haven't been executed, the tasks in the queue which the
|
383
|
+
# queue has dispatched but has not yet received a reply for, and the failed
|
384
|
+
# tasks that the queue is retrying.
|
385
|
+
# @!attribute [r] oldest_estimated_arrival_time
|
386
|
+
# @return [::Google::Protobuf::Timestamp]
|
387
|
+
# Output only. An estimation of the nearest time in the future where a task in the queue
|
388
|
+
# is scheduled to be executed.
|
389
|
+
# @!attribute [r] executed_last_minute_count
|
390
|
+
# @return [::Integer]
|
391
|
+
# Output only. The number of tasks that the queue has dispatched and received a reply for
|
392
|
+
# during the last minute. This variable counts both successful and
|
393
|
+
# non-successful executions.
|
394
|
+
# @!attribute [r] concurrent_dispatches_count
|
395
|
+
# @return [::Integer]
|
396
|
+
# Output only. The number of requests that the queue has dispatched but has not received
|
397
|
+
# a reply for yet.
|
398
|
+
# @!attribute [r] effective_execution_rate
|
399
|
+
# @return [::Float]
|
400
|
+
# Output only. The current maximum number of tasks per second executed by the queue.
|
401
|
+
# The maximum value of this variable is controlled by the RateLimits of the
|
402
|
+
# Queue. However, this value could be less to avoid overloading the endpoints
|
403
|
+
# tasks in the queue are targeting.
|
404
|
+
class QueueStats
|
405
|
+
include ::Google::Protobuf::MessageExts
|
406
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
407
|
+
end
|
346
408
|
end
|
347
409
|
end
|
348
410
|
end
|