google-cloud-tasks-v2beta3 0.3.3 → 0.6.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/v2beta3/cloud_tasks/client.rb +63 -71
- data/lib/google/cloud/tasks/v2beta3/cloudtasks_pb.rb +2 -0
- data/lib/google/cloud/tasks/v2beta3/queue_pb.rb +11 -0
- data/lib/google/cloud/tasks/v2beta3/target_pb.rb +5 -0
- data/lib/google/cloud/tasks/v2beta3/task_pb.rb +1 -0
- data/lib/google/cloud/tasks/v2beta3/version.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +12 -0
- data/proto_docs/google/cloud/tasks/v2beta3/cloudtasks.rb +12 -0
- data/proto_docs/google/cloud/tasks/v2beta3/queue.rb +74 -12
- data/proto_docs/google/cloud/tasks/v2beta3/target.rb +27 -0
- data/proto_docs/google/cloud/tasks/v2beta3/task.rb +9 -0
- 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,90 +61,66 @@ 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: [4, 14]
|
71
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
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: [4, 14]
|
76
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
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: [4, 14]
|
85
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
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: [4, 14]
|
96
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
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: [4, 14]
|
103
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
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: [4, 14]
|
108
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
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: [4, 14]
|
113
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
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: [4, 14]
|
120
|
+
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
145
121
|
}
|
146
122
|
|
147
|
-
default_config.rpcs.run_task.timeout =
|
123
|
+
default_config.rpcs.run_task.timeout = 20.0
|
148
124
|
|
149
125
|
default_config
|
150
126
|
end
|
@@ -207,8 +183,14 @@ module Google
|
|
207
183
|
|
208
184
|
# Create credentials
|
209
185
|
credentials = @config.credentials
|
210
|
-
|
211
|
-
if
|
186
|
+
# Use self-signed JWT if the scope and endpoint are unchanged from default,
|
187
|
+
# but only if the default endpoint does not have a region prefix.
|
188
|
+
enable_self_signed_jwt = @config.scope == Client.configure.scope &&
|
189
|
+
@config.endpoint == Client.configure.endpoint &&
|
190
|
+
!@config.endpoint.split(".").first.include?("-")
|
191
|
+
credentials ||= Credentials.default scope: @config.scope,
|
192
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
193
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
212
194
|
credentials = Credentials.new credentials, scope: @config.scope
|
213
195
|
end
|
214
196
|
@quota_project_id = @config.quota_project
|
@@ -240,7 +222,7 @@ module Google
|
|
240
222
|
# @param options [::Gapic::CallOptions, ::Hash]
|
241
223
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
242
224
|
#
|
243
|
-
# @overload list_queues(parent: nil, filter: nil, page_size: nil, page_token: nil)
|
225
|
+
# @overload list_queues(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil)
|
244
226
|
# Pass arguments to `list_queues` via keyword arguments. Note that at
|
245
227
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
246
228
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -277,6 +259,11 @@ module Google
|
|
277
259
|
# from the previous call to {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#list_queues ListQueues}
|
278
260
|
# method. It is an error to switch the value of the
|
279
261
|
# {::Google::Cloud::Tasks::V2beta3::ListQueuesRequest#filter filter} while iterating through pages.
|
262
|
+
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
263
|
+
# Optional. Read mask is used for a more granular control over what the API returns.
|
264
|
+
# If the mask is not present all fields will be returned except
|
265
|
+
# [Queue.stats]. [Queue.stats] will be returned only if it was explicitly
|
266
|
+
# specified in the mask.
|
280
267
|
#
|
281
268
|
# @yield [response, operation] Access the result along with the RPC operation
|
282
269
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Tasks::V2beta3::Queue>]
|
@@ -337,7 +324,7 @@ module Google
|
|
337
324
|
# @param options [::Gapic::CallOptions, ::Hash]
|
338
325
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
339
326
|
#
|
340
|
-
# @overload get_queue(name: nil)
|
327
|
+
# @overload get_queue(name: nil, read_mask: nil)
|
341
328
|
# Pass arguments to `get_queue` via keyword arguments. Note that at
|
342
329
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
343
330
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -345,6 +332,11 @@ module Google
|
|
345
332
|
# @param name [::String]
|
346
333
|
# Required. The resource name of the queue. For example:
|
347
334
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
335
|
+
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
336
|
+
# Optional. Read mask is used for a more granular control over what the API returns.
|
337
|
+
# If the mask is not present all fields will be returned except
|
338
|
+
# [Queue.stats]. [Queue.stats] will be returned only if it was explicitly
|
339
|
+
# specified in the mask.
|
348
340
|
#
|
349
341
|
# @yield [response, operation] Access the result along with the RPC operation
|
350
342
|
# @yieldparam response [::Google::Cloud::Tasks::V2beta3::Queue]
|
@@ -1682,7 +1674,7 @@ module Google
|
|
1682
1674
|
config_attr :scope, nil, ::String, ::Array, nil
|
1683
1675
|
config_attr :lib_name, nil, ::String, nil
|
1684
1676
|
config_attr :lib_version, nil, ::String, nil
|
1685
|
-
config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
|
1677
|
+
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
1686
1678
|
config_attr :interceptors, nil, ::Array, nil
|
1687
1679
|
config_attr :timeout, nil, ::Numeric, nil
|
1688
1680
|
config_attr :metadata, nil, ::Hash, nil
|
@@ -1703,7 +1695,7 @@ module Google
|
|
1703
1695
|
def rpcs
|
1704
1696
|
@rpcs ||= begin
|
1705
1697
|
parent_rpcs = nil
|
1706
|
-
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config
|
1698
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
1707
1699
|
Rpcs.new parent_rpcs
|
1708
1700
|
end
|
1709
1701
|
end
|
@@ -1809,37 +1801,37 @@ module Google
|
|
1809
1801
|
|
1810
1802
|
# @private
|
1811
1803
|
def initialize parent_rpcs = nil
|
1812
|
-
list_queues_config = parent_rpcs
|
1804
|
+
list_queues_config = parent_rpcs.list_queues if parent_rpcs.respond_to? :list_queues
|
1813
1805
|
@list_queues = ::Gapic::Config::Method.new list_queues_config
|
1814
|
-
get_queue_config = parent_rpcs
|
1806
|
+
get_queue_config = parent_rpcs.get_queue if parent_rpcs.respond_to? :get_queue
|
1815
1807
|
@get_queue = ::Gapic::Config::Method.new get_queue_config
|
1816
|
-
create_queue_config = parent_rpcs
|
1808
|
+
create_queue_config = parent_rpcs.create_queue if parent_rpcs.respond_to? :create_queue
|
1817
1809
|
@create_queue = ::Gapic::Config::Method.new create_queue_config
|
1818
|
-
update_queue_config = parent_rpcs
|
1810
|
+
update_queue_config = parent_rpcs.update_queue if parent_rpcs.respond_to? :update_queue
|
1819
1811
|
@update_queue = ::Gapic::Config::Method.new update_queue_config
|
1820
|
-
delete_queue_config = parent_rpcs
|
1812
|
+
delete_queue_config = parent_rpcs.delete_queue if parent_rpcs.respond_to? :delete_queue
|
1821
1813
|
@delete_queue = ::Gapic::Config::Method.new delete_queue_config
|
1822
|
-
purge_queue_config = parent_rpcs
|
1814
|
+
purge_queue_config = parent_rpcs.purge_queue if parent_rpcs.respond_to? :purge_queue
|
1823
1815
|
@purge_queue = ::Gapic::Config::Method.new purge_queue_config
|
1824
|
-
pause_queue_config = parent_rpcs
|
1816
|
+
pause_queue_config = parent_rpcs.pause_queue if parent_rpcs.respond_to? :pause_queue
|
1825
1817
|
@pause_queue = ::Gapic::Config::Method.new pause_queue_config
|
1826
|
-
resume_queue_config = parent_rpcs
|
1818
|
+
resume_queue_config = parent_rpcs.resume_queue if parent_rpcs.respond_to? :resume_queue
|
1827
1819
|
@resume_queue = ::Gapic::Config::Method.new resume_queue_config
|
1828
|
-
get_iam_policy_config = parent_rpcs
|
1820
|
+
get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
|
1829
1821
|
@get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
|
1830
|
-
set_iam_policy_config = parent_rpcs
|
1822
|
+
set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
|
1831
1823
|
@set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
|
1832
|
-
test_iam_permissions_config = parent_rpcs
|
1824
|
+
test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
|
1833
1825
|
@test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
|
1834
|
-
list_tasks_config = parent_rpcs
|
1826
|
+
list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
|
1835
1827
|
@list_tasks = ::Gapic::Config::Method.new list_tasks_config
|
1836
|
-
get_task_config = parent_rpcs
|
1828
|
+
get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
|
1837
1829
|
@get_task = ::Gapic::Config::Method.new get_task_config
|
1838
|
-
create_task_config = parent_rpcs
|
1830
|
+
create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
|
1839
1831
|
@create_task = ::Gapic::Config::Method.new create_task_config
|
1840
|
-
delete_task_config = parent_rpcs
|
1832
|
+
delete_task_config = parent_rpcs.delete_task if parent_rpcs.respond_to? :delete_task
|
1841
1833
|
@delete_task = ::Gapic::Config::Method.new delete_task_config
|
1842
|
-
run_task_config = parent_rpcs
|
1834
|
+
run_task_config = parent_rpcs.run_task if parent_rpcs.respond_to? :run_task
|
1843
1835
|
@run_task = ::Gapic::Config::Method.new run_task_config
|
1844
1836
|
|
1845
1837
|
yield self if block_given?
|
@@ -20,6 +20,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
20
20
|
optional :filter, :string, 2
|
21
21
|
optional :page_size, :int32, 3
|
22
22
|
optional :page_token, :string, 4
|
23
|
+
optional :read_mask, :message, 5, "google.protobuf.FieldMask"
|
23
24
|
end
|
24
25
|
add_message "google.cloud.tasks.v2beta3.ListQueuesResponse" do
|
25
26
|
repeated :queues, :message, 1, "google.cloud.tasks.v2beta3.Queue"
|
@@ -27,6 +28,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
27
28
|
end
|
28
29
|
add_message "google.cloud.tasks.v2beta3.GetQueueRequest" do
|
29
30
|
optional :name, :string, 1
|
31
|
+
optional :read_mask, :message, 2, "google.protobuf.FieldMask"
|
30
32
|
end
|
31
33
|
add_message "google.cloud.tasks.v2beta3.CreateQueueRequest" do
|
32
34
|
optional :parent, :string, 1
|
@@ -17,8 +17,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
17
17
|
optional :retry_config, :message, 5, "google.cloud.tasks.v2beta3.RetryConfig"
|
18
18
|
optional :state, :enum, 6, "google.cloud.tasks.v2beta3.Queue.State"
|
19
19
|
optional :purge_time, :message, 7, "google.protobuf.Timestamp"
|
20
|
+
optional :task_ttl, :message, 8, "google.protobuf.Duration"
|
21
|
+
optional :tombstone_ttl, :message, 9, "google.protobuf.Duration"
|
20
22
|
optional :stackdriver_logging_config, :message, 10, "google.cloud.tasks.v2beta3.StackdriverLoggingConfig"
|
21
23
|
optional :type, :enum, 11, "google.cloud.tasks.v2beta3.Queue.Type"
|
24
|
+
optional :stats, :message, 12, "google.cloud.tasks.v2beta3.QueueStats"
|
22
25
|
oneof :queue_type do
|
23
26
|
optional :app_engine_http_queue, :message, 3, "google.cloud.tasks.v2beta3.AppEngineHttpQueue"
|
24
27
|
end
|
@@ -49,6 +52,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
49
52
|
add_message "google.cloud.tasks.v2beta3.StackdriverLoggingConfig" do
|
50
53
|
optional :sampling_ratio, :double, 1
|
51
54
|
end
|
55
|
+
add_message "google.cloud.tasks.v2beta3.QueueStats" do
|
56
|
+
optional :tasks_count, :int64, 1
|
57
|
+
optional :oldest_estimated_arrival_time, :message, 2, "google.protobuf.Timestamp"
|
58
|
+
optional :executed_last_minute_count, :int64, 3
|
59
|
+
optional :concurrent_dispatches_count, :int64, 4
|
60
|
+
optional :effective_execution_rate, :double, 5
|
61
|
+
end
|
52
62
|
end
|
53
63
|
end
|
54
64
|
|
@@ -62,6 +72,7 @@ module Google
|
|
62
72
|
RateLimits = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta3.RateLimits").msgclass
|
63
73
|
RetryConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta3.RetryConfig").msgclass
|
64
74
|
StackdriverLoggingConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta3.StackdriverLoggingConfig").msgclass
|
75
|
+
QueueStats = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta3.QueueStats").msgclass
|
65
76
|
end
|
66
77
|
end
|
67
78
|
end
|
@@ -6,6 +6,10 @@ require 'google/protobuf'
|
|
6
6
|
require 'google/api/annotations_pb'
|
7
7
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
8
8
|
add_file("google/cloud/tasks/v2beta3/target.proto", :syntax => :proto3) do
|
9
|
+
add_message "google.cloud.tasks.v2beta3.PullMessage" do
|
10
|
+
optional :payload, :bytes, 1
|
11
|
+
optional :tag, :string, 2
|
12
|
+
end
|
9
13
|
add_message "google.cloud.tasks.v2beta3.HttpRequest" do
|
10
14
|
optional :url, :string, 1
|
11
15
|
optional :http_method, :enum, 2, "google.cloud.tasks.v2beta3.HttpMethod"
|
@@ -57,6 +61,7 @@ module Google
|
|
57
61
|
module Cloud
|
58
62
|
module Tasks
|
59
63
|
module V2beta3
|
64
|
+
PullMessage = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta3.PullMessage").msgclass
|
60
65
|
HttpRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta3.HttpRequest").msgclass
|
61
66
|
AppEngineHttpQueue = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta3.AppEngineHttpQueue").msgclass
|
62
67
|
AppEngineHttpRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.tasks.v2beta3.AppEngineHttpRequest").msgclass
|
@@ -24,6 +24,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
24
24
|
oneof :payload_type do
|
25
25
|
optional :app_engine_http_request, :message, 3, "google.cloud.tasks.v2beta3.AppEngineHttpRequest"
|
26
26
|
optional :http_request, :message, 11, "google.cloud.tasks.v2beta3.HttpRequest"
|
27
|
+
optional :pull_message, :message, 13, "google.cloud.tasks.v2beta3.PullMessage"
|
27
28
|
end
|
28
29
|
end
|
29
30
|
add_enum "google.cloud.tasks.v2beta3.Task.View" do
|
@@ -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::V2beta3::CloudTasks::Client#list_queues ListQueues}
|
59
59
|
# method. It is an error to switch the value of the
|
60
60
|
# {::Google::Cloud::Tasks::V2beta3::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
|
@@ -92,7 +92,7 @@ module Google
|
|
92
92
|
# @return [::Google::Cloud::Tasks::V2beta3::Queue::State]
|
93
93
|
# Output only. The state of the queue.
|
94
94
|
#
|
95
|
-
# `state` can only be changed by
|
95
|
+
# `state` can only be changed by calling
|
96
96
|
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#pause_queue PauseQueue},
|
97
97
|
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#resume_queue ResumeQueue}, or uploading
|
98
98
|
# [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
|
@@ -110,6 +110,32 @@ module Google
|
|
110
110
|
#
|
111
111
|
# Purge time will be truncated to the nearest microsecond. Purge
|
112
112
|
# time will be unset if the queue has never been purged.
|
113
|
+
# @!attribute [rw] task_ttl
|
114
|
+
# @return [::Google::Protobuf::Duration]
|
115
|
+
# The maximum amount of time that a task will be retained in
|
116
|
+
# this queue.
|
117
|
+
#
|
118
|
+
# Queues created by Cloud Tasks have a default `task_ttl` of 31 days.
|
119
|
+
# After a task has lived for `task_ttl`, the task will be deleted
|
120
|
+
# regardless of whether it was dispatched or not.
|
121
|
+
#
|
122
|
+
# The `task_ttl` for queues created via queue.yaml/xml is equal to the
|
123
|
+
# maximum duration because there is a
|
124
|
+
# [storage quota](https://cloud.google.com/appengine/quotas#Task_Queue) for
|
125
|
+
# these queues. To view the maximum valid duration, see the documentation for
|
126
|
+
# {::Google::Protobuf::Duration Duration}.
|
127
|
+
# @!attribute [rw] tombstone_ttl
|
128
|
+
# @return [::Google::Protobuf::Duration]
|
129
|
+
# The task tombstone time to live (TTL).
|
130
|
+
#
|
131
|
+
# After a task is deleted or executed, the task's tombstone is
|
132
|
+
# retained for the length of time specified by `tombstone_ttl`.
|
133
|
+
# The tombstone is used by task de-duplication; another task with the same
|
134
|
+
# name can't be created until the tombstone has expired. For more information
|
135
|
+
# about task de-duplication, see the documentation for
|
136
|
+
# {::Google::Cloud::Tasks::V2beta3::CreateTaskRequest#task CreateTaskRequest}.
|
137
|
+
#
|
138
|
+
# Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour.
|
113
139
|
# @!attribute [rw] stackdriver_logging_config
|
114
140
|
# @return [::Google::Cloud::Tasks::V2beta3::StackdriverLoggingConfig]
|
115
141
|
# Configuration options for writing logs to
|
@@ -122,6 +148,11 @@ module Google
|
|
122
148
|
# `Queue.type` is an immutable property of the queue that is set at the queue
|
123
149
|
# creation time. When left unspecified, the default value of `PUSH` is
|
124
150
|
# selected.
|
151
|
+
# @!attribute [r] stats
|
152
|
+
# @return [::Google::Cloud::Tasks::V2beta3::QueueStats]
|
153
|
+
# Output only. The realtime, informational statistics for a queue. In order
|
154
|
+
# to receive the statistics the caller should include this field in the
|
155
|
+
# FieldMask.
|
125
156
|
class Queue
|
126
157
|
include ::Google::Protobuf::MessageExts
|
127
158
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -199,7 +230,7 @@ module Google
|
|
199
230
|
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
|
200
231
|
# @!attribute [rw] max_burst_size
|
201
232
|
# @return [::Integer]
|
202
|
-
#
|
233
|
+
# The max burst size.
|
203
234
|
#
|
204
235
|
# Max burst size limits how fast tasks in queue are processed when
|
205
236
|
# many tasks are in the queue and the rate is high. This field
|
@@ -216,21 +247,21 @@ module Google
|
|
216
247
|
# continuously refilled with new tokens based on
|
217
248
|
# {::Google::Cloud::Tasks::V2beta3::RateLimits#max_dispatches_per_second max_dispatches_per_second}.
|
218
249
|
#
|
219
|
-
#
|
220
|
-
# value of
|
250
|
+
# The default value of `max_burst_size` is picked by Cloud Tasks
|
251
|
+
# based on the value of
|
221
252
|
# {::Google::Cloud::Tasks::V2beta3::RateLimits#max_dispatches_per_second max_dispatches_per_second}.
|
222
253
|
#
|
254
|
+
# The maximum value of `max_burst_size` is 500.
|
255
|
+
#
|
223
256
|
# For App Engine queues that were created or updated using
|
224
257
|
# `queue.yaml/xml`, `max_burst_size` is equal to
|
225
258
|
# [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
|
226
|
-
#
|
227
|
-
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#update_queue UpdateQueue} is called on a queue
|
228
|
-
#
|
229
|
-
#
|
230
|
-
# {::Google::Cloud::Tasks::V2beta3::
|
231
|
-
#
|
232
|
-
# {::Google::Cloud::Tasks::V2beta3::RateLimits#max_dispatches_per_second max_dispatches_per_second}
|
233
|
-
# is updated.
|
259
|
+
# If
|
260
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#update_queue UpdateQueue} is called on a queue without
|
261
|
+
# explicitly setting a value for `max_burst_size`,
|
262
|
+
# `max_burst_size` value will get updated if
|
263
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#update_queue UpdateQueue} is updating
|
264
|
+
# {::Google::Cloud::Tasks::V2beta3::RateLimits#max_dispatches_per_second max_dispatches_per_second}.
|
234
265
|
# @!attribute [rw] max_concurrent_dispatches
|
235
266
|
# @return [::Integer]
|
236
267
|
# The maximum number of concurrent tasks that Cloud Tasks allows
|
@@ -371,6 +402,37 @@ module Google
|
|
371
402
|
include ::Google::Protobuf::MessageExts
|
372
403
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
373
404
|
end
|
405
|
+
|
406
|
+
# Statistics for a queue.
|
407
|
+
# @!attribute [r] tasks_count
|
408
|
+
# @return [::Integer]
|
409
|
+
# Output only. An estimation of the number of tasks in the queue, that is, the tasks in
|
410
|
+
# the queue that haven't been executed, the tasks in the queue which the
|
411
|
+
# queue has dispatched but has not yet received a reply for, and the failed
|
412
|
+
# tasks that the queue is retrying.
|
413
|
+
# @!attribute [r] oldest_estimated_arrival_time
|
414
|
+
# @return [::Google::Protobuf::Timestamp]
|
415
|
+
# Output only. An estimation of the nearest time in the future where a task in the queue
|
416
|
+
# is scheduled to be executed.
|
417
|
+
# @!attribute [r] executed_last_minute_count
|
418
|
+
# @return [::Integer]
|
419
|
+
# Output only. The number of tasks that the queue has dispatched and received a reply for
|
420
|
+
# during the last minute. This variable counts both successful and
|
421
|
+
# non-successful executions.
|
422
|
+
# @!attribute [r] concurrent_dispatches_count
|
423
|
+
# @return [::Integer]
|
424
|
+
# Output only. The number of requests that the queue has dispatched but has not received
|
425
|
+
# a reply for yet.
|
426
|
+
# @!attribute [r] effective_execution_rate
|
427
|
+
# @return [::Float]
|
428
|
+
# Output only. The current maximum number of tasks per second executed by the queue.
|
429
|
+
# The maximum value of this variable is controlled by the RateLimits of the
|
430
|
+
# Queue. However, this value could be less to avoid overloading the endpoints
|
431
|
+
# tasks in the queue are targeting.
|
432
|
+
class QueueStats
|
433
|
+
include ::Google::Protobuf::MessageExts
|
434
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
435
|
+
end
|
374
436
|
end
|
375
437
|
end
|
376
438
|
end
|