google-cloud-tasks-v2beta2 0.2.3 → 0.4.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/README.md +64 -0
- data/lib/google/cloud/tasks/v2beta2.rb +3 -0
- data/lib/google/cloud/tasks/v2beta2/cloud_tasks/client.rb +49 -33
- data/lib/google/cloud/tasks/v2beta2/cloudtasks_pb.rb +2 -0
- data/lib/google/cloud/tasks/v2beta2/cloudtasks_services_pb.rb +21 -22
- data/lib/google/cloud/tasks/v2beta2/old_target_pb.rb +20 -0
- 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 +6 -0
- data/proto_docs/google/api/resource.rb +50 -14
- data/proto_docs/google/cloud/tasks/v2beta2/cloudtasks.rb +12 -0
- data/proto_docs/google/cloud/tasks/v2beta2/queue.rb +76 -14
- 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
- metadata +9 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2440f2375e578df7cdcbc5fa24430f826fb7a3c8fcaeb834a364c9afb6e9f6a9
|
4
|
+
data.tar.gz: d5ce18b77d216ab95509558cacd36a74c1330983910d8291ed4243c4f9f90a23
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2ba881837cd776587eeb28ca99caabdb1e3eb429e683ed8984f21b173934bdb9d193fbb606e7ff942225c57da569955a43c5464bbab96f7137548da18e62f582
|
7
|
+
data.tar.gz: f526d2a3a188052b86ef424d6dc376675c62969b240100347f7d5b1870687daed32fc340dcf63b6c1f913cc206dd6d4aae0c447c6c61c68eb10441a5866bfe6d
|
data/README.md
CHANGED
@@ -6,6 +6,12 @@ Cloud Tasks is a fully managed service that allows you to manage the execution,
|
|
6
6
|
|
7
7
|
https://github.com/googleapis/google-cloud-ruby
|
8
8
|
|
9
|
+
This gem is a _versioned_ client. It provides basic client classes for a
|
10
|
+
specific version of the Cloud Tasks V2beta2 API. Most users should consider using
|
11
|
+
the main client gem,
|
12
|
+
[google-cloud-tasks](https://rubygems.org/gems/google-cloud-tasks).
|
13
|
+
See the section below titled *Which client should I use?* for more information.
|
14
|
+
|
9
15
|
## Installation
|
10
16
|
|
11
17
|
```
|
@@ -73,3 +79,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
|
|
73
79
|
and later. Older versions of Ruby _may_ still work, but are unsupported and not
|
74
80
|
recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
|
75
81
|
about the Ruby support schedule.
|
82
|
+
|
83
|
+
## Which client should I use?
|
84
|
+
|
85
|
+
Most modern Ruby client libraries for Google APIs come in two flavors: the main
|
86
|
+
client library with a name such as `google-cloud-tasks`,
|
87
|
+
and lower-level _versioned_ client libraries with names such as
|
88
|
+
`google-cloud-tasks-v2beta2`.
|
89
|
+
_In most cases, you should install the main client._
|
90
|
+
|
91
|
+
### What's the difference between the main client and a versioned client?
|
92
|
+
|
93
|
+
A _versioned client_ provides a basic set of data types and client classes for
|
94
|
+
a _single version_ of a specific service. (That is, for a service with multiple
|
95
|
+
versions, there might be a separate versioned client for each service version.)
|
96
|
+
Most versioned clients are written and maintained by a code generator.
|
97
|
+
|
98
|
+
The _main client_ is designed to provide you with the _recommended_ client
|
99
|
+
interfaces for the service. There will be only one main client for any given
|
100
|
+
service, even a service with multiple versions. The main client includes
|
101
|
+
factory methods for constructing the client objects we recommend for most
|
102
|
+
users. In some cases, those will be classes provided by an underlying versioned
|
103
|
+
client; in other cases, they will be handwritten higher-level client objects
|
104
|
+
with additional capabilities, convenience methods, or best practices built in.
|
105
|
+
Generally, the main client will default to a recommended service version,
|
106
|
+
although in some cases you can override this if you need to talk to a specific
|
107
|
+
service version.
|
108
|
+
|
109
|
+
### Why would I want to use the main client?
|
110
|
+
|
111
|
+
We recommend that most users install the main client gem for a service. You can
|
112
|
+
identify this gem as the one _without_ a version in its name, e.g.
|
113
|
+
`google-cloud-tasks`.
|
114
|
+
The main client is recommended because it will embody the best practices for
|
115
|
+
accessing the service, and may also provide more convenient interfaces or
|
116
|
+
tighter integration into frameworks and third-party libraries. In addition, the
|
117
|
+
documentation and samples published by Google will generally demonstrate use of
|
118
|
+
the main client.
|
119
|
+
|
120
|
+
### Why would I want to use a versioned client?
|
121
|
+
|
122
|
+
You can use a versioned client if you are content with a possibly lower-level
|
123
|
+
class interface, you explicitly want to avoid features provided by the main
|
124
|
+
client, or you want to access a specific service version not be covered by the
|
125
|
+
main client. You can identify versioned client gems because the service version
|
126
|
+
is part of the name, e.g. `google-cloud-tasks-v2beta2`.
|
127
|
+
|
128
|
+
### What about the google-apis-<name> clients?
|
129
|
+
|
130
|
+
Client library gems with names that begin with `google-apis-` are based on an
|
131
|
+
older code generation technology. They talk to a REST/JSON backend (whereas
|
132
|
+
most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
|
133
|
+
not offer the same performance, features, and ease of use provided by more
|
134
|
+
modern clients.
|
135
|
+
|
136
|
+
The `google-apis-` clients have wide coverage across Google services, so you
|
137
|
+
might need to use one if there is no modern client available for the service.
|
138
|
+
However, if a modern client is available, we generally recommend it over the
|
139
|
+
older `google-apis-` clients.
|
@@ -66,93 +66,93 @@ module Google
|
|
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
71
|
initial_delay: 0.1,
|
72
72
|
max_delay: 10.0,
|
73
73
|
multiplier: 1.3,
|
74
|
-
retry_codes: [
|
74
|
+
retry_codes: [14, 4]
|
75
75
|
}
|
76
76
|
|
77
|
-
default_config.rpcs.get_queue.timeout =
|
77
|
+
default_config.rpcs.get_queue.timeout = 20.0
|
78
78
|
default_config.rpcs.get_queue.retry_policy = {
|
79
79
|
initial_delay: 0.1,
|
80
80
|
max_delay: 10.0,
|
81
81
|
multiplier: 1.3,
|
82
|
-
retry_codes: [
|
82
|
+
retry_codes: [14, 4]
|
83
83
|
}
|
84
84
|
|
85
|
-
default_config.rpcs.create_queue.timeout =
|
85
|
+
default_config.rpcs.create_queue.timeout = 20.0
|
86
86
|
|
87
|
-
default_config.rpcs.update_queue.timeout =
|
87
|
+
default_config.rpcs.update_queue.timeout = 20.0
|
88
88
|
|
89
|
-
default_config.rpcs.delete_queue.timeout =
|
89
|
+
default_config.rpcs.delete_queue.timeout = 20.0
|
90
90
|
default_config.rpcs.delete_queue.retry_policy = {
|
91
91
|
initial_delay: 0.1,
|
92
92
|
max_delay: 10.0,
|
93
93
|
multiplier: 1.3,
|
94
|
-
retry_codes: [
|
94
|
+
retry_codes: [14, 4]
|
95
95
|
}
|
96
96
|
|
97
|
-
default_config.rpcs.purge_queue.timeout =
|
97
|
+
default_config.rpcs.purge_queue.timeout = 20.0
|
98
98
|
|
99
|
-
default_config.rpcs.pause_queue.timeout =
|
99
|
+
default_config.rpcs.pause_queue.timeout = 20.0
|
100
100
|
|
101
|
-
default_config.rpcs.resume_queue.timeout =
|
101
|
+
default_config.rpcs.resume_queue.timeout = 20.0
|
102
102
|
|
103
|
-
default_config.rpcs.get_iam_policy.timeout =
|
103
|
+
default_config.rpcs.get_iam_policy.timeout = 20.0
|
104
104
|
default_config.rpcs.get_iam_policy.retry_policy = {
|
105
105
|
initial_delay: 0.1,
|
106
106
|
max_delay: 10.0,
|
107
107
|
multiplier: 1.3,
|
108
|
-
retry_codes: [
|
108
|
+
retry_codes: [14, 4]
|
109
109
|
}
|
110
110
|
|
111
|
-
default_config.rpcs.set_iam_policy.timeout =
|
111
|
+
default_config.rpcs.set_iam_policy.timeout = 20.0
|
112
112
|
|
113
|
-
default_config.rpcs.test_iam_permissions.timeout =
|
113
|
+
default_config.rpcs.test_iam_permissions.timeout = 20.0
|
114
114
|
default_config.rpcs.test_iam_permissions.retry_policy = {
|
115
115
|
initial_delay: 0.1,
|
116
116
|
max_delay: 10.0,
|
117
117
|
multiplier: 1.3,
|
118
|
-
retry_codes: [
|
118
|
+
retry_codes: [14, 4]
|
119
119
|
}
|
120
120
|
|
121
|
-
default_config.rpcs.list_tasks.timeout =
|
121
|
+
default_config.rpcs.list_tasks.timeout = 20.0
|
122
122
|
default_config.rpcs.list_tasks.retry_policy = {
|
123
123
|
initial_delay: 0.1,
|
124
124
|
max_delay: 10.0,
|
125
125
|
multiplier: 1.3,
|
126
|
-
retry_codes: [
|
126
|
+
retry_codes: [14, 4]
|
127
127
|
}
|
128
128
|
|
129
|
-
default_config.rpcs.get_task.timeout =
|
129
|
+
default_config.rpcs.get_task.timeout = 20.0
|
130
130
|
default_config.rpcs.get_task.retry_policy = {
|
131
131
|
initial_delay: 0.1,
|
132
132
|
max_delay: 10.0,
|
133
133
|
multiplier: 1.3,
|
134
|
-
retry_codes: [
|
134
|
+
retry_codes: [14, 4]
|
135
135
|
}
|
136
136
|
|
137
|
-
default_config.rpcs.create_task.timeout =
|
137
|
+
default_config.rpcs.create_task.timeout = 20.0
|
138
138
|
|
139
|
-
default_config.rpcs.delete_task.timeout =
|
139
|
+
default_config.rpcs.delete_task.timeout = 20.0
|
140
140
|
default_config.rpcs.delete_task.retry_policy = {
|
141
141
|
initial_delay: 0.1,
|
142
142
|
max_delay: 10.0,
|
143
143
|
multiplier: 1.3,
|
144
|
-
retry_codes: [
|
144
|
+
retry_codes: [14, 4]
|
145
145
|
}
|
146
146
|
|
147
|
-
default_config.rpcs.lease_tasks.timeout =
|
147
|
+
default_config.rpcs.lease_tasks.timeout = 20.0
|
148
148
|
|
149
|
-
default_config.rpcs.acknowledge_task.timeout =
|
149
|
+
default_config.rpcs.acknowledge_task.timeout = 20.0
|
150
150
|
|
151
|
-
default_config.rpcs.renew_lease.timeout =
|
151
|
+
default_config.rpcs.renew_lease.timeout = 20.0
|
152
152
|
|
153
|
-
default_config.rpcs.cancel_lease.timeout =
|
153
|
+
default_config.rpcs.cancel_lease.timeout = 20.0
|
154
154
|
|
155
|
-
default_config.rpcs.run_task.timeout =
|
155
|
+
default_config.rpcs.run_task.timeout = 20.0
|
156
156
|
|
157
157
|
default_config
|
158
158
|
end
|
@@ -215,7 +215,13 @@ module Google
|
|
215
215
|
|
216
216
|
# Create credentials
|
217
217
|
credentials = @config.credentials
|
218
|
-
|
218
|
+
# Use self-signed JWT if the scope and endpoint are unchanged from default,
|
219
|
+
# but only if the default endpoint does not have a region prefix.
|
220
|
+
enable_self_signed_jwt = @config.scope == Client.configure.scope &&
|
221
|
+
@config.endpoint == Client.configure.endpoint &&
|
222
|
+
!@config.endpoint.split(".").first.include?("-")
|
223
|
+
credentials ||= Credentials.default scope: @config.scope,
|
224
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
219
225
|
if credentials.is_a?(String) || credentials.is_a?(Hash)
|
220
226
|
credentials = Credentials.new credentials, scope: @config.scope
|
221
227
|
end
|
@@ -248,7 +254,7 @@ module Google
|
|
248
254
|
# @param options [::Gapic::CallOptions, ::Hash]
|
249
255
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
250
256
|
#
|
251
|
-
# @overload list_queues(parent: nil, filter: nil, page_size: nil, page_token: nil)
|
257
|
+
# @overload list_queues(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil)
|
252
258
|
# Pass arguments to `list_queues` via keyword arguments. Note that at
|
253
259
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
254
260
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -285,6 +291,11 @@ module Google
|
|
285
291
|
# from the previous call to {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#list_queues ListQueues}
|
286
292
|
# method. It is an error to switch the value of the
|
287
293
|
# {::Google::Cloud::Tasks::V2beta2::ListQueuesRequest#filter filter} while iterating through pages.
|
294
|
+
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
295
|
+
# Optional. Read mask is used for a more granular control over what the API returns.
|
296
|
+
# If the mask is not present all fields will be returned except
|
297
|
+
# [Queue.stats]. [Queue.stats] will be returned only if it was explicitly
|
298
|
+
# specified in the mask.
|
288
299
|
#
|
289
300
|
# @yield [response, operation] Access the result along with the RPC operation
|
290
301
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Tasks::V2beta2::Queue>]
|
@@ -345,7 +356,7 @@ module Google
|
|
345
356
|
# @param options [::Gapic::CallOptions, ::Hash]
|
346
357
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
347
358
|
#
|
348
|
-
# @overload get_queue(name: nil)
|
359
|
+
# @overload get_queue(name: nil, read_mask: nil)
|
349
360
|
# Pass arguments to `get_queue` via keyword arguments. Note that at
|
350
361
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
351
362
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -353,6 +364,11 @@ module Google
|
|
353
364
|
# @param name [::String]
|
354
365
|
# Required. The resource name of the queue. For example:
|
355
366
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
367
|
+
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
368
|
+
# Optional. Read mask is used for a more granular control over what the API returns.
|
369
|
+
# If the mask is not present all fields will be returned except
|
370
|
+
# [Queue.stats]. [Queue.stats] will be returned only if it was explicitly
|
371
|
+
# specified in the mask.
|
356
372
|
#
|
357
373
|
# @yield [response, operation] Access the result along with the RPC operation
|
358
374
|
# @yieldparam response [::Google::Cloud::Tasks::V2beta2::Queue]
|
@@ -2122,7 +2138,7 @@ module Google
|
|
2122
2138
|
|
2123
2139
|
config_attr :endpoint, "cloudtasks.googleapis.com", ::String
|
2124
2140
|
config_attr :credentials, nil do |value|
|
2125
|
-
allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
2141
|
+
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
2126
2142
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
2127
2143
|
allowed.any? { |klass| klass === value }
|
2128
2144
|
end
|
@@ -2162,7 +2178,7 @@ module Google
|
|
2162
2178
|
# Each configuration object is of type `Gapic::Config::Method` and includes
|
2163
2179
|
# the following configuration fields:
|
2164
2180
|
#
|
2165
|
-
# * `timeout` (*type:* `Numeric`) - The call timeout in
|
2181
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
2166
2182
|
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
|
2167
2183
|
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
2168
2184
|
# include the following keys:
|
@@ -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'
|
@@ -38,9 +37,9 @@ module Google
|
|
38
37
|
# Lists queues.
|
39
38
|
#
|
40
39
|
# Queues are returned in lexicographical order.
|
41
|
-
rpc :ListQueues, ListQueuesRequest, ListQueuesResponse
|
40
|
+
rpc :ListQueues, ::Google::Cloud::Tasks::V2beta2::ListQueuesRequest, ::Google::Cloud::Tasks::V2beta2::ListQueuesResponse
|
42
41
|
# Gets a queue.
|
43
|
-
rpc :GetQueue, GetQueueRequest, Queue
|
42
|
+
rpc :GetQueue, ::Google::Cloud::Tasks::V2beta2::GetQueueRequest, ::Google::Cloud::Tasks::V2beta2::Queue
|
44
43
|
# Creates a queue.
|
45
44
|
#
|
46
45
|
# Queues created with this method allow tasks to live for a maximum of 31
|
@@ -53,7 +52,7 @@ module Google
|
|
53
52
|
# [Overview of Queue Management and
|
54
53
|
# queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
|
55
54
|
# this method.
|
56
|
-
rpc :CreateQueue, CreateQueueRequest, Queue
|
55
|
+
rpc :CreateQueue, ::Google::Cloud::Tasks::V2beta2::CreateQueueRequest, ::Google::Cloud::Tasks::V2beta2::Queue
|
57
56
|
# Updates a queue.
|
58
57
|
#
|
59
58
|
# This method creates the queue if it does not exist and updates
|
@@ -69,7 +68,7 @@ module Google
|
|
69
68
|
# [Overview of Queue Management and
|
70
69
|
# queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
|
71
70
|
# this method.
|
72
|
-
rpc :UpdateQueue, UpdateQueueRequest, Queue
|
71
|
+
rpc :UpdateQueue, ::Google::Cloud::Tasks::V2beta2::UpdateQueueRequest, ::Google::Cloud::Tasks::V2beta2::Queue
|
73
72
|
# Deletes a queue.
|
74
73
|
#
|
75
74
|
# This command will delete the queue even if it has tasks in it.
|
@@ -83,14 +82,14 @@ module Google
|
|
83
82
|
# [Overview of Queue Management and
|
84
83
|
# queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
|
85
84
|
# this method.
|
86
|
-
rpc :DeleteQueue, DeleteQueueRequest, Google::Protobuf::Empty
|
85
|
+
rpc :DeleteQueue, ::Google::Cloud::Tasks::V2beta2::DeleteQueueRequest, ::Google::Protobuf::Empty
|
87
86
|
# Purges a queue by deleting all of its tasks.
|
88
87
|
#
|
89
88
|
# All tasks created before this method is called are permanently deleted.
|
90
89
|
#
|
91
90
|
# Purge operations can take up to one minute to take effect. Tasks
|
92
91
|
# might be dispatched before the purge takes effect. A purge is irreversible.
|
93
|
-
rpc :PurgeQueue, PurgeQueueRequest, Queue
|
92
|
+
rpc :PurgeQueue, ::Google::Cloud::Tasks::V2beta2::PurgeQueueRequest, ::Google::Cloud::Tasks::V2beta2::Queue
|
94
93
|
# Pauses the queue.
|
95
94
|
#
|
96
95
|
# If a queue is paused then the system will stop dispatching tasks
|
@@ -98,7 +97,7 @@ module Google
|
|
98
97
|
# [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue]. Tasks can still be added
|
99
98
|
# when the queue is paused. A queue is paused if its
|
100
99
|
# [state][google.cloud.tasks.v2beta2.Queue.state] is [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED].
|
101
|
-
rpc :PauseQueue, PauseQueueRequest, Queue
|
100
|
+
rpc :PauseQueue, ::Google::Cloud::Tasks::V2beta2::PauseQueueRequest, ::Google::Cloud::Tasks::V2beta2::Queue
|
102
101
|
# Resume a queue.
|
103
102
|
#
|
104
103
|
# This method resumes a queue after it has been
|
@@ -112,7 +111,7 @@ module Google
|
|
112
111
|
# queues, follow the 500/50/5 pattern described in
|
113
112
|
# [Managing Cloud Tasks Scaling
|
114
113
|
# Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
|
115
|
-
rpc :ResumeQueue, ResumeQueueRequest, Queue
|
114
|
+
rpc :ResumeQueue, ::Google::Cloud::Tasks::V2beta2::ResumeQueueRequest, ::Google::Cloud::Tasks::V2beta2::Queue
|
116
115
|
# Gets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue].
|
117
116
|
# Returns an empty policy if the resource exists and does not have a policy
|
118
117
|
# set.
|
@@ -122,7 +121,7 @@ module Google
|
|
122
121
|
# resource parent:
|
123
122
|
#
|
124
123
|
# * `cloudtasks.queues.getIamPolicy`
|
125
|
-
rpc :GetIamPolicy, Google::Iam::V1::GetIamPolicyRequest, Google::Iam::V1::Policy
|
124
|
+
rpc :GetIamPolicy, ::Google::Iam::V1::GetIamPolicyRequest, ::Google::Iam::V1::Policy
|
126
125
|
# Sets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue]. Replaces any existing
|
127
126
|
# policy.
|
128
127
|
#
|
@@ -134,7 +133,7 @@ module Google
|
|
134
133
|
# resource parent:
|
135
134
|
#
|
136
135
|
# * `cloudtasks.queues.setIamPolicy`
|
137
|
-
rpc :SetIamPolicy, Google::Iam::V1::SetIamPolicyRequest, Google::Iam::V1::Policy
|
136
|
+
rpc :SetIamPolicy, ::Google::Iam::V1::SetIamPolicyRequest, ::Google::Iam::V1::Policy
|
138
137
|
# Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta2.Queue].
|
139
138
|
# If the resource does not exist, this will return an empty set of
|
140
139
|
# permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
|
@@ -142,7 +141,7 @@ module Google
|
|
142
141
|
# Note: This operation is designed to be used for building permission-aware
|
143
142
|
# UIs and command-line tools, not for authorization checking. This operation
|
144
143
|
# may "fail open" without warning.
|
145
|
-
rpc :TestIamPermissions, Google::Iam::V1::TestIamPermissionsRequest, Google::Iam::V1::TestIamPermissionsResponse
|
144
|
+
rpc :TestIamPermissions, ::Google::Iam::V1::TestIamPermissionsRequest, ::Google::Iam::V1::TestIamPermissionsResponse
|
146
145
|
# Lists the tasks in a queue.
|
147
146
|
#
|
148
147
|
# By default, only the [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC] view is retrieved
|
@@ -152,9 +151,9 @@ module Google
|
|
152
151
|
#
|
153
152
|
# The tasks may be returned in any order. The ordering may change at any
|
154
153
|
# time.
|
155
|
-
rpc :ListTasks, ListTasksRequest, ListTasksResponse
|
154
|
+
rpc :ListTasks, ::Google::Cloud::Tasks::V2beta2::ListTasksRequest, ::Google::Cloud::Tasks::V2beta2::ListTasksResponse
|
156
155
|
# Gets a task.
|
157
|
-
rpc :GetTask, GetTaskRequest, Task
|
156
|
+
rpc :GetTask, ::Google::Cloud::Tasks::V2beta2::GetTaskRequest, ::Google::Cloud::Tasks::V2beta2::Task
|
158
157
|
# Creates a task and adds it to a queue.
|
159
158
|
#
|
160
159
|
# Tasks cannot be updated after creation; there is no UpdateTask command.
|
@@ -162,13 +161,13 @@ module Google
|
|
162
161
|
# * For [App Engine queues][google.cloud.tasks.v2beta2.AppEngineHttpTarget], the maximum task size is
|
163
162
|
# 100KB.
|
164
163
|
# * For [pull queues][google.cloud.tasks.v2beta2.PullTarget], the maximum task size is 1MB.
|
165
|
-
rpc :CreateTask, CreateTaskRequest, Task
|
164
|
+
rpc :CreateTask, ::Google::Cloud::Tasks::V2beta2::CreateTaskRequest, ::Google::Cloud::Tasks::V2beta2::Task
|
166
165
|
# Deletes a task.
|
167
166
|
#
|
168
167
|
# A task can be deleted if it is scheduled or dispatched. A task
|
169
168
|
# cannot be deleted if it has completed successfully or permanently
|
170
169
|
# failed.
|
171
|
-
rpc :DeleteTask, DeleteTaskRequest, Google::Protobuf::Empty
|
170
|
+
rpc :DeleteTask, ::Google::Cloud::Tasks::V2beta2::DeleteTaskRequest, ::Google::Protobuf::Empty
|
172
171
|
# Leases tasks from a pull queue for
|
173
172
|
# [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].
|
174
173
|
#
|
@@ -191,7 +190,7 @@ module Google
|
|
191
190
|
# is also returned when
|
192
191
|
# [max_tasks_dispatched_per_second][google.cloud.tasks.v2beta2.RateLimits.max_tasks_dispatched_per_second]
|
193
192
|
# is exceeded.
|
194
|
-
rpc :LeaseTasks, LeaseTasksRequest, LeaseTasksResponse
|
193
|
+
rpc :LeaseTasks, ::Google::Cloud::Tasks::V2beta2::LeaseTasksRequest, ::Google::Cloud::Tasks::V2beta2::LeaseTasksResponse
|
195
194
|
# Acknowledges a pull task.
|
196
195
|
#
|
197
196
|
# The worker, that is, the entity that
|
@@ -205,20 +204,20 @@ module Google
|
|
205
204
|
# by a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks],
|
206
205
|
# [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask], or
|
207
206
|
# [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].
|
208
|
-
rpc :AcknowledgeTask, AcknowledgeTaskRequest, Google::Protobuf::Empty
|
207
|
+
rpc :AcknowledgeTask, ::Google::Cloud::Tasks::V2beta2::AcknowledgeTaskRequest, ::Google::Protobuf::Empty
|
209
208
|
# Renew the current lease of a pull task.
|
210
209
|
#
|
211
210
|
# The worker can use this method to extend the lease by a new
|
212
211
|
# duration, starting from now. The new task lease will be
|
213
212
|
# returned in the task's [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time].
|
214
|
-
rpc :RenewLease, RenewLeaseRequest, Task
|
213
|
+
rpc :RenewLease, ::Google::Cloud::Tasks::V2beta2::RenewLeaseRequest, ::Google::Cloud::Tasks::V2beta2::Task
|
215
214
|
# Cancel a pull task's lease.
|
216
215
|
#
|
217
216
|
# The worker can use this method to cancel a task's lease by
|
218
217
|
# setting its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] to now. This will
|
219
218
|
# make the task available to be leased to the next caller of
|
220
219
|
# [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
|
221
|
-
rpc :CancelLease, CancelLeaseRequest, Task
|
220
|
+
rpc :CancelLease, ::Google::Cloud::Tasks::V2beta2::CancelLeaseRequest, ::Google::Cloud::Tasks::V2beta2::Task
|
222
221
|
# Forces a task to run now.
|
223
222
|
#
|
224
223
|
# When this method is called, Cloud Tasks will dispatch the task, even if
|
@@ -246,7 +245,7 @@ module Google
|
|
246
245
|
#
|
247
246
|
# [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] cannot be called on a
|
248
247
|
# [pull task][google.cloud.tasks.v2beta2.PullMessage].
|
249
|
-
rpc :RunTask, RunTaskRequest, Task
|
248
|
+
rpc :RunTask, ::Google::Cloud::Tasks::V2beta2::RunTaskRequest, ::Google::Cloud::Tasks::V2beta2::Task
|
250
249
|
end
|
251
250
|
|
252
251
|
Stub = Service.rpc_stub_class
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# source: google/cloud/tasks/v2beta2/old_target.proto
|
3
|
+
|
4
|
+
require 'google/protobuf'
|
5
|
+
|
6
|
+
require 'google/cloud/tasks/v2beta2/target_pb'
|
7
|
+
require 'google/api/annotations_pb'
|
8
|
+
Google::Protobuf::DescriptorPool.generated_pool.build do
|
9
|
+
add_file("google/cloud/tasks/v2beta2/old_target.proto", :syntax => :proto3) do
|
10
|
+
end
|
11
|
+
end
|
12
|
+
|
13
|
+
module Google
|
14
|
+
module Cloud
|
15
|
+
module Tasks
|
16
|
+
module V2beta2
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
@@ -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,12 @@ 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
|
57
63
|
end
|
58
64
|
end
|
59
65
|
end
|
@@ -43,12 +43,12 @@ module Google
|
|
43
43
|
#
|
44
44
|
# The ResourceDescriptor Yaml config will look like:
|
45
45
|
#
|
46
|
-
#
|
47
|
-
#
|
48
|
-
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
#
|
46
|
+
# resources:
|
47
|
+
# - type: "pubsub.googleapis.com/Topic"
|
48
|
+
# name_descriptor:
|
49
|
+
# - pattern: "projects/{project}/topics/{topic}"
|
50
|
+
# parent_type: "cloudresourcemanager.googleapis.com/Project"
|
51
|
+
# parent_name_extractor: "projects/{project}"
|
52
52
|
#
|
53
53
|
# Sometimes, resources have multiple patterns, typically because they can
|
54
54
|
# live under multiple parents.
|
@@ -183,15 +183,24 @@ module Google
|
|
183
183
|
# }
|
184
184
|
# @!attribute [rw] plural
|
185
185
|
# @return [::String]
|
186
|
-
# The plural name used in the resource name, such as
|
187
|
-
# the name of 'projects/\\{project}'
|
188
|
-
#
|
186
|
+
# The plural name used in the resource name and permission names, such as
|
187
|
+
# 'projects' for the resource name of 'projects/\\{project}' and the permission
|
188
|
+
# name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
|
189
|
+
# concept of the `plural` field in k8s CRD spec
|
189
190
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
191
|
+
#
|
192
|
+
# Note: The plural form is required even for singleton resources. See
|
193
|
+
# https://aip.dev/156
|
190
194
|
# @!attribute [rw] singular
|
191
195
|
# @return [::String]
|
192
196
|
# The same concept of the `singular` field in k8s CRD spec
|
193
197
|
# https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
|
194
198
|
# Such as "project" for the `resourcemanager.googleapis.com/Project` type.
|
199
|
+
# @!attribute [rw] style
|
200
|
+
# @return [::Array<::Google::Api::ResourceDescriptor::Style>]
|
201
|
+
# Style flag(s) for this resource.
|
202
|
+
# These indicate that a resource is expected to conform to a given
|
203
|
+
# style. See the specific style flags for additional information.
|
195
204
|
class ResourceDescriptor
|
196
205
|
include ::Google::Protobuf::MessageExts
|
197
206
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -211,6 +220,22 @@ module Google
|
|
211
220
|
# that from being necessary once there are multiple patterns.)
|
212
221
|
FUTURE_MULTI_PATTERN = 2
|
213
222
|
end
|
223
|
+
|
224
|
+
# A flag representing a specific style that a resource claims to conform to.
|
225
|
+
module Style
|
226
|
+
# The unspecified value. Do not use.
|
227
|
+
STYLE_UNSPECIFIED = 0
|
228
|
+
|
229
|
+
# This resource is intended to be "declarative-friendly".
|
230
|
+
#
|
231
|
+
# Declarative-friendly resources must be more strictly consistent, and
|
232
|
+
# setting this to true communicates to tools that this resource should
|
233
|
+
# adhere to declarative-friendly expectations.
|
234
|
+
#
|
235
|
+
# Note: This is used by the API linter (linter.aip.dev) to enable
|
236
|
+
# additional checks.
|
237
|
+
DECLARATIVE_FRIENDLY = 1
|
238
|
+
end
|
214
239
|
end
|
215
240
|
|
216
241
|
# Defines a proto annotation that describes a string field that refers to
|
@@ -226,6 +251,17 @@ module Google
|
|
226
251
|
# type: "pubsub.googleapis.com/Topic"
|
227
252
|
# }];
|
228
253
|
# }
|
254
|
+
#
|
255
|
+
# Occasionally, a field may reference an arbitrary resource. In this case,
|
256
|
+
# APIs use the special value * in their resource reference.
|
257
|
+
#
|
258
|
+
# Example:
|
259
|
+
#
|
260
|
+
# message GetIamPolicyRequest {
|
261
|
+
# string resource = 2 [(google.api.resource_reference) = {
|
262
|
+
# type: "*"
|
263
|
+
# }];
|
264
|
+
# }
|
229
265
|
# @!attribute [rw] child_type
|
230
266
|
# @return [::String]
|
231
267
|
# The resource type of a child collection that the annotated field
|
@@ -234,11 +270,11 @@ module Google
|
|
234
270
|
#
|
235
271
|
# Example:
|
236
272
|
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
241
|
-
#
|
273
|
+
# message ListLogEntriesRequest {
|
274
|
+
# string parent = 1 [(google.api.resource_reference) = {
|
275
|
+
# child_type: "logging.googleapis.com/LogEntry"
|
276
|
+
# };
|
277
|
+
# }
|
242
278
|
class ResourceReference
|
243
279
|
include ::Google::Protobuf::MessageExts
|
244
280
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -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
|
@@ -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
|
@@ -119,10 +119,10 @@ module Google
|
|
119
119
|
# delivered to can be set at the queue-level or task-level:
|
120
120
|
#
|
121
121
|
# * If set,
|
122
|
-
#
|
123
|
-
#
|
124
|
-
#
|
125
|
-
#
|
122
|
+
# {::Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget#app_engine_routing_override app_engine_routing_override}
|
123
|
+
# is used for all tasks in the queue, no matter what the setting
|
124
|
+
# is for the
|
125
|
+
# {::Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest#app_engine_routing task-level app_engine_routing}.
|
126
126
|
#
|
127
127
|
#
|
128
128
|
# The `url` that the task will be sent to is:
|
@@ -156,14 +156,11 @@ module Google
|
|
156
156
|
# The HTTP method to use for the request. The default is POST.
|
157
157
|
#
|
158
158
|
# The app's request handler for the task's target URL must be able to handle
|
159
|
-
# HTTP requests with this http_method, otherwise the task attempt
|
160
|
-
#
|
161
|
-
# [Writing a push task request
|
159
|
+
# HTTP requests with this http_method, otherwise the task attempt fails with
|
160
|
+
# error code 405 (Method Not Allowed). See [Writing a push task request
|
162
161
|
# handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
|
163
|
-
# and the documentation for
|
164
|
-
#
|
165
|
-
# [Python Request
|
166
|
-
# Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
|
162
|
+
# and the App Engine documentation for your runtime on [How Requests are
|
163
|
+
# Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
|
167
164
|
# @!attribute [rw] app_engine_routing
|
168
165
|
# @return [::Google::Cloud::Tasks::V2beta2::AppEngineRouting]
|
169
166
|
# Task-level setting for App Engine routing.
|
@@ -57,10 +57,13 @@ module Google
|
|
57
57
|
# Example 4: Pack and unpack a message in Go
|
58
58
|
#
|
59
59
|
# foo := &pb.Foo{...}
|
60
|
-
# any, err :=
|
60
|
+
# any, err := anypb.New(foo)
|
61
|
+
# if err != nil {
|
62
|
+
# ...
|
63
|
+
# }
|
61
64
|
# ...
|
62
65
|
# foo := &pb.Foo{}
|
63
|
-
# if err :=
|
66
|
+
# if err := any.UnmarshalTo(foo); err != nil {
|
64
67
|
# ...
|
65
68
|
# }
|
66
69
|
#
|
@@ -70,7 +70,16 @@ module Google
|
|
70
70
|
# .setNanos((int) ((millis % 1000) * 1000000)).build();
|
71
71
|
#
|
72
72
|
#
|
73
|
-
# Example 5: Compute Timestamp from
|
73
|
+
# Example 5: Compute Timestamp from Java `Instant.now()`.
|
74
|
+
#
|
75
|
+
# Instant now = Instant.now();
|
76
|
+
#
|
77
|
+
# Timestamp timestamp =
|
78
|
+
# Timestamp.newBuilder().setSeconds(now.getEpochSecond())
|
79
|
+
# .setNanos(now.getNano()).build();
|
80
|
+
#
|
81
|
+
#
|
82
|
+
# Example 6: Compute Timestamp from current time in Python.
|
74
83
|
#
|
75
84
|
# timestamp = Timestamp()
|
76
85
|
# timestamp.GetCurrentTime()
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-tasks-v2beta2
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.4.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2021-02-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,14 +16,14 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - "~>"
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: '0.
|
19
|
+
version: '0.3'
|
20
20
|
type: :runtime
|
21
21
|
prerelease: false
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
23
23
|
requirements:
|
24
24
|
- - "~>"
|
25
25
|
- !ruby/object:Gem::Version
|
26
|
-
version: '0.
|
26
|
+
version: '0.3'
|
27
27
|
- !ruby/object:Gem::Dependency
|
28
28
|
name: google-cloud-errors
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
@@ -173,7 +173,9 @@ dependencies:
|
|
173
173
|
description: Cloud Tasks is a fully managed service that allows you to manage the
|
174
174
|
execution, dispatch and delivery of a large number of distributed tasks. You can
|
175
175
|
asynchronously perform work outside of a user request. Your tasks can be executed
|
176
|
-
on App Engine or any arbitrary HTTP endpoint.
|
176
|
+
on App Engine or any arbitrary HTTP endpoint. Note that google-cloud-tasks-v2beta2
|
177
|
+
is a version-specific client library. For most uses, we recommend installing the
|
178
|
+
main client library google-cloud-tasks instead. See the readme for more details.
|
177
179
|
email: googleapis-packages@google.com
|
178
180
|
executables: []
|
179
181
|
extensions: []
|
@@ -191,6 +193,7 @@ files:
|
|
191
193
|
- lib/google/cloud/tasks/v2beta2/cloud_tasks/paths.rb
|
192
194
|
- lib/google/cloud/tasks/v2beta2/cloudtasks_pb.rb
|
193
195
|
- lib/google/cloud/tasks/v2beta2/cloudtasks_services_pb.rb
|
196
|
+
- lib/google/cloud/tasks/v2beta2/old_target_pb.rb
|
194
197
|
- lib/google/cloud/tasks/v2beta2/queue_pb.rb
|
195
198
|
- lib/google/cloud/tasks/v2beta2/target_pb.rb
|
196
199
|
- lib/google/cloud/tasks/v2beta2/task_pb.rb
|
@@ -231,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
231
234
|
- !ruby/object:Gem::Version
|
232
235
|
version: '0'
|
233
236
|
requirements: []
|
234
|
-
rubygems_version: 3.
|
237
|
+
rubygems_version: 3.2.6
|
235
238
|
signing_key:
|
236
239
|
specification_version: 4
|
237
240
|
summary: API Client library for the Cloud Tasks V2beta2 API
|