google-cloud-tasks-v2beta3 0.3.0 → 0.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +64 -0
- data/lib/google/cloud/tasks/v2beta3.rb +3 -0
- data/lib/google/cloud/tasks/v2beta3/cloud_tasks/client.rb +45 -29
- data/lib/google/cloud/tasks/v2beta3/cloudtasks_pb.rb +2 -0
- data/lib/google/cloud/tasks/v2beta3/cloudtasks_services_pb.rb +16 -16
- 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 +6 -0
- data/proto_docs/google/api/resource.rb +50 -14
- data/proto_docs/google/cloud/tasks/v2beta3/cloudtasks.rb +12 -0
- data/proto_docs/google/cloud/tasks/v2beta3/queue.rb +73 -11
- 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
- metadata +6 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c0e3212ceb3d851ea3a2c31734e6d7ab87d6dd89e7b36b24d9b50d9535ce6883
|
4
|
+
data.tar.gz: fd7dd723c42b373356c69dad40a27bdd05389e66c92f92b434c4c73c1974c6c3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6d7f523c6619e818d387c52985256cc0aaf1e00c82ea4159245ab4612e71576b55f8cb5e3c799fc4875acec1d60a88c828768d80246b4151ab5c9e10096fb5b8
|
7
|
+
data.tar.gz: b68c1b63dd37acb20dad16266bba6d724ca7bbe246ed856a26eeb6a93a4dd5115400739c47cacd5780dde7aa147ffd5af844ce80f58843098e1d7aef88830c1d
|
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 V2beta3 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-v2beta3`.
|
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-v2beta3`.
|
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,85 +66,85 @@ 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: [4, 14]
|
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: [4, 14]
|
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: [4, 14]
|
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: [4, 14]
|
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: [4, 14]
|
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: [4, 14]
|
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: [4, 14]
|
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: [4, 14]
|
145
145
|
}
|
146
146
|
|
147
|
-
default_config.rpcs.run_task.timeout =
|
147
|
+
default_config.rpcs.run_task.timeout = 20.0
|
148
148
|
|
149
149
|
default_config
|
150
150
|
end
|
@@ -207,7 +207,13 @@ module Google
|
|
207
207
|
|
208
208
|
# Create credentials
|
209
209
|
credentials = @config.credentials
|
210
|
-
|
210
|
+
# Use self-signed JWT if the scope and endpoint are unchanged from default,
|
211
|
+
# but only if the default endpoint does not have a region prefix.
|
212
|
+
enable_self_signed_jwt = @config.scope == Client.configure.scope &&
|
213
|
+
@config.endpoint == Client.configure.endpoint &&
|
214
|
+
!@config.endpoint.split(".").first.include?("-")
|
215
|
+
credentials ||= Credentials.default scope: @config.scope,
|
216
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
211
217
|
if credentials.is_a?(String) || credentials.is_a?(Hash)
|
212
218
|
credentials = Credentials.new credentials, scope: @config.scope
|
213
219
|
end
|
@@ -240,7 +246,7 @@ module Google
|
|
240
246
|
# @param options [::Gapic::CallOptions, ::Hash]
|
241
247
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
242
248
|
#
|
243
|
-
# @overload list_queues(parent: nil, filter: nil, page_size: nil, page_token: nil)
|
249
|
+
# @overload list_queues(parent: nil, filter: nil, page_size: nil, page_token: nil, read_mask: nil)
|
244
250
|
# Pass arguments to `list_queues` via keyword arguments. Note that at
|
245
251
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
246
252
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -277,6 +283,11 @@ module Google
|
|
277
283
|
# from the previous call to {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#list_queues ListQueues}
|
278
284
|
# method. It is an error to switch the value of the
|
279
285
|
# {::Google::Cloud::Tasks::V2beta3::ListQueuesRequest#filter filter} while iterating through pages.
|
286
|
+
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
287
|
+
# Optional. Read mask is used for a more granular control over what the API returns.
|
288
|
+
# If the mask is not present all fields will be returned except
|
289
|
+
# [Queue.stats]. [Queue.stats] will be returned only if it was explicitly
|
290
|
+
# specified in the mask.
|
280
291
|
#
|
281
292
|
# @yield [response, operation] Access the result along with the RPC operation
|
282
293
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Tasks::V2beta3::Queue>]
|
@@ -337,7 +348,7 @@ module Google
|
|
337
348
|
# @param options [::Gapic::CallOptions, ::Hash]
|
338
349
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
339
350
|
#
|
340
|
-
# @overload get_queue(name: nil)
|
351
|
+
# @overload get_queue(name: nil, read_mask: nil)
|
341
352
|
# Pass arguments to `get_queue` via keyword arguments. Note that at
|
342
353
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
343
354
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -345,6 +356,11 @@ module Google
|
|
345
356
|
# @param name [::String]
|
346
357
|
# Required. The resource name of the queue. For example:
|
347
358
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
359
|
+
# @param read_mask [::Google::Protobuf::FieldMask, ::Hash]
|
360
|
+
# Optional. Read mask is used for a more granular control over what the API returns.
|
361
|
+
# If the mask is not present all fields will be returned except
|
362
|
+
# [Queue.stats]. [Queue.stats] will be returned only if it was explicitly
|
363
|
+
# specified in the mask.
|
348
364
|
#
|
349
365
|
# @yield [response, operation] Access the result along with the RPC operation
|
350
366
|
# @yieldparam response [::Google::Cloud::Tasks::V2beta3::Queue]
|
@@ -1675,7 +1691,7 @@ module Google
|
|
1675
1691
|
|
1676
1692
|
config_attr :endpoint, "cloudtasks.googleapis.com", ::String
|
1677
1693
|
config_attr :credentials, nil do |value|
|
1678
|
-
allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
1694
|
+
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
1679
1695
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
1680
1696
|
allowed.any? { |klass| klass === value }
|
1681
1697
|
end
|
@@ -1715,7 +1731,7 @@ module Google
|
|
1715
1731
|
# Each configuration object is of type `Gapic::Config::Method` and includes
|
1716
1732
|
# the following configuration fields:
|
1717
1733
|
#
|
1718
|
-
# * `timeout` (*type:* `Numeric`) - The call timeout in
|
1734
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
1719
1735
|
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
|
1720
1736
|
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
1721
1737
|
# include the following keys:
|
@@ -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
|
@@ -37,9 +37,9 @@ module Google
|
|
37
37
|
# Lists queues.
|
38
38
|
#
|
39
39
|
# Queues are returned in lexicographical order.
|
40
|
-
rpc :ListQueues, ListQueuesRequest, ListQueuesResponse
|
40
|
+
rpc :ListQueues, ::Google::Cloud::Tasks::V2beta3::ListQueuesRequest, ::Google::Cloud::Tasks::V2beta3::ListQueuesResponse
|
41
41
|
# Gets a queue.
|
42
|
-
rpc :GetQueue, GetQueueRequest, Queue
|
42
|
+
rpc :GetQueue, ::Google::Cloud::Tasks::V2beta3::GetQueueRequest, ::Google::Cloud::Tasks::V2beta3::Queue
|
43
43
|
# Creates a queue.
|
44
44
|
#
|
45
45
|
# Queues created with this method allow tasks to live for a maximum of 31
|
@@ -52,7 +52,7 @@ module Google
|
|
52
52
|
# [Overview of Queue Management and
|
53
53
|
# queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
|
54
54
|
# this method.
|
55
|
-
rpc :CreateQueue, CreateQueueRequest, Queue
|
55
|
+
rpc :CreateQueue, ::Google::Cloud::Tasks::V2beta3::CreateQueueRequest, ::Google::Cloud::Tasks::V2beta3::Queue
|
56
56
|
# Updates a queue.
|
57
57
|
#
|
58
58
|
# This method creates the queue if it does not exist and updates
|
@@ -68,7 +68,7 @@ module Google
|
|
68
68
|
# [Overview of Queue Management and
|
69
69
|
# queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
|
70
70
|
# this method.
|
71
|
-
rpc :UpdateQueue, UpdateQueueRequest, Queue
|
71
|
+
rpc :UpdateQueue, ::Google::Cloud::Tasks::V2beta3::UpdateQueueRequest, ::Google::Cloud::Tasks::V2beta3::Queue
|
72
72
|
# Deletes a queue.
|
73
73
|
#
|
74
74
|
# This command will delete the queue even if it has tasks in it.
|
@@ -82,14 +82,14 @@ module Google
|
|
82
82
|
# [Overview of Queue Management and
|
83
83
|
# queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
|
84
84
|
# this method.
|
85
|
-
rpc :DeleteQueue, DeleteQueueRequest, Google::Protobuf::Empty
|
85
|
+
rpc :DeleteQueue, ::Google::Cloud::Tasks::V2beta3::DeleteQueueRequest, ::Google::Protobuf::Empty
|
86
86
|
# Purges a queue by deleting all of its tasks.
|
87
87
|
#
|
88
88
|
# All tasks created before this method is called are permanently deleted.
|
89
89
|
#
|
90
90
|
# Purge operations can take up to one minute to take effect. Tasks
|
91
91
|
# might be dispatched before the purge takes effect. A purge is irreversible.
|
92
|
-
rpc :PurgeQueue, PurgeQueueRequest, Queue
|
92
|
+
rpc :PurgeQueue, ::Google::Cloud::Tasks::V2beta3::PurgeQueueRequest, ::Google::Cloud::Tasks::V2beta3::Queue
|
93
93
|
# Pauses the queue.
|
94
94
|
#
|
95
95
|
# If a queue is paused then the system will stop dispatching tasks
|
@@ -97,7 +97,7 @@ module Google
|
|
97
97
|
# [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue]. Tasks can still be added
|
98
98
|
# when the queue is paused. A queue is paused if its
|
99
99
|
# [state][google.cloud.tasks.v2beta3.Queue.state] is [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED].
|
100
|
-
rpc :PauseQueue, PauseQueueRequest, Queue
|
100
|
+
rpc :PauseQueue, ::Google::Cloud::Tasks::V2beta3::PauseQueueRequest, ::Google::Cloud::Tasks::V2beta3::Queue
|
101
101
|
# Resume a queue.
|
102
102
|
#
|
103
103
|
# This method resumes a queue after it has been
|
@@ -111,7 +111,7 @@ module Google
|
|
111
111
|
# queues, follow the 500/50/5 pattern described in
|
112
112
|
# [Managing Cloud Tasks Scaling
|
113
113
|
# Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
|
114
|
-
rpc :ResumeQueue, ResumeQueueRequest, Queue
|
114
|
+
rpc :ResumeQueue, ::Google::Cloud::Tasks::V2beta3::ResumeQueueRequest, ::Google::Cloud::Tasks::V2beta3::Queue
|
115
115
|
# Gets the access control policy for a [Queue][google.cloud.tasks.v2beta3.Queue].
|
116
116
|
# Returns an empty policy if the resource exists and does not have a policy
|
117
117
|
# set.
|
@@ -121,7 +121,7 @@ module Google
|
|
121
121
|
# resource parent:
|
122
122
|
#
|
123
123
|
# * `cloudtasks.queues.getIamPolicy`
|
124
|
-
rpc :GetIamPolicy, Google::Iam::V1::GetIamPolicyRequest, Google::Iam::V1::Policy
|
124
|
+
rpc :GetIamPolicy, ::Google::Iam::V1::GetIamPolicyRequest, ::Google::Iam::V1::Policy
|
125
125
|
# Sets the access control policy for a [Queue][google.cloud.tasks.v2beta3.Queue]. Replaces any existing
|
126
126
|
# policy.
|
127
127
|
#
|
@@ -133,7 +133,7 @@ module Google
|
|
133
133
|
# resource parent:
|
134
134
|
#
|
135
135
|
# * `cloudtasks.queues.setIamPolicy`
|
136
|
-
rpc :SetIamPolicy, Google::Iam::V1::SetIamPolicyRequest, Google::Iam::V1::Policy
|
136
|
+
rpc :SetIamPolicy, ::Google::Iam::V1::SetIamPolicyRequest, ::Google::Iam::V1::Policy
|
137
137
|
# Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta3.Queue].
|
138
138
|
# If the resource does not exist, this will return an empty set of
|
139
139
|
# permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
|
@@ -141,7 +141,7 @@ module Google
|
|
141
141
|
# Note: This operation is designed to be used for building permission-aware
|
142
142
|
# UIs and command-line tools, not for authorization checking. This operation
|
143
143
|
# may "fail open" without warning.
|
144
|
-
rpc :TestIamPermissions, Google::Iam::V1::TestIamPermissionsRequest, Google::Iam::V1::TestIamPermissionsResponse
|
144
|
+
rpc :TestIamPermissions, ::Google::Iam::V1::TestIamPermissionsRequest, ::Google::Iam::V1::TestIamPermissionsResponse
|
145
145
|
# Lists the tasks in a queue.
|
146
146
|
#
|
147
147
|
# By default, only the [BASIC][google.cloud.tasks.v2beta3.Task.View.BASIC] view is retrieved
|
@@ -151,21 +151,21 @@ module Google
|
|
151
151
|
#
|
152
152
|
# The tasks may be returned in any order. The ordering may change at any
|
153
153
|
# time.
|
154
|
-
rpc :ListTasks, ListTasksRequest, ListTasksResponse
|
154
|
+
rpc :ListTasks, ::Google::Cloud::Tasks::V2beta3::ListTasksRequest, ::Google::Cloud::Tasks::V2beta3::ListTasksResponse
|
155
155
|
# Gets a task.
|
156
|
-
rpc :GetTask, GetTaskRequest, Task
|
156
|
+
rpc :GetTask, ::Google::Cloud::Tasks::V2beta3::GetTaskRequest, ::Google::Cloud::Tasks::V2beta3::Task
|
157
157
|
# Creates a task and adds it to a queue.
|
158
158
|
#
|
159
159
|
# Tasks cannot be updated after creation; there is no UpdateTask command.
|
160
160
|
#
|
161
161
|
# * The maximum task size is 100KB.
|
162
|
-
rpc :CreateTask, CreateTaskRequest, Task
|
162
|
+
rpc :CreateTask, ::Google::Cloud::Tasks::V2beta3::CreateTaskRequest, ::Google::Cloud::Tasks::V2beta3::Task
|
163
163
|
# Deletes a task.
|
164
164
|
#
|
165
165
|
# A task can be deleted if it is scheduled or dispatched. A task
|
166
166
|
# cannot be deleted if it has executed successfully or permanently
|
167
167
|
# failed.
|
168
|
-
rpc :DeleteTask, DeleteTaskRequest, Google::Protobuf::Empty
|
168
|
+
rpc :DeleteTask, ::Google::Cloud::Tasks::V2beta3::DeleteTaskRequest, ::Google::Protobuf::Empty
|
169
169
|
# Forces a task to run now.
|
170
170
|
#
|
171
171
|
# When this method is called, Cloud Tasks will dispatch the task, even if
|
@@ -190,7 +190,7 @@ module Google
|
|
190
190
|
# [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] returns
|
191
191
|
# [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
|
192
192
|
# task that has already succeeded or permanently failed.
|
193
|
-
rpc :RunTask, RunTaskRequest, Task
|
193
|
+
rpc :RunTask, ::Google::Cloud::Tasks::V2beta3::RunTaskRequest, ::Google::Cloud::Tasks::V2beta3::Task
|
194
194
|
end
|
195
195
|
|
196
196
|
Stub = Service.rpc_stub_class
|
@@ -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,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::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
|
@@ -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
|
@@ -21,6 +21,33 @@ module Google
|
|
21
21
|
module Cloud
|
22
22
|
module Tasks
|
23
23
|
module V2beta3
|
24
|
+
# Pull Message.
|
25
|
+
#
|
26
|
+
# This proto can only be used for tasks in a queue which has
|
27
|
+
# {::Google::Cloud::Tasks::V2beta3::Queue#type PULL} type. It currently exists for backwards compatibility with
|
28
|
+
# the App Engine Task Queue SDK. This message type maybe returned with methods
|
29
|
+
# [list][google.cloud.tasks.v2beta3.CloudTask.ListTasks] and
|
30
|
+
# [get][google.cloud.tasks.v2beta3.CloudTask.ListTasks], when the response view
|
31
|
+
# is [FULL][google.cloud.tasks.v2beta3.Task.View.Full].
|
32
|
+
# @!attribute [rw] payload
|
33
|
+
# @return [::String]
|
34
|
+
# A data payload consumed by the worker to execute the task.
|
35
|
+
# @!attribute [rw] tag
|
36
|
+
# @return [::String]
|
37
|
+
# The tasks's tag.
|
38
|
+
#
|
39
|
+
# The tag is less than 500 characters.
|
40
|
+
#
|
41
|
+
# SDK compatibility: Although the SDK allows tags to be either
|
42
|
+
# string or
|
43
|
+
# [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-),
|
44
|
+
# only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8
|
45
|
+
# encoded, the tag will be empty when the task is returned by Cloud Tasks.
|
46
|
+
class PullMessage
|
47
|
+
include ::Google::Protobuf::MessageExts
|
48
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
49
|
+
end
|
50
|
+
|
24
51
|
# HTTP request.
|
25
52
|
#
|
26
53
|
# The task will be pushed to the worker as an HTTP request. If the worker
|
@@ -54,6 +54,15 @@ module Google
|
|
54
54
|
# HTTP request that is sent to the task's target.
|
55
55
|
#
|
56
56
|
# An HTTP task is a task that has {::Google::Cloud::Tasks::V2beta3::HttpRequest HttpRequest} set.
|
57
|
+
# @!attribute [rw] pull_message
|
58
|
+
# @return [::Google::Cloud::Tasks::V2beta3::PullMessage]
|
59
|
+
# Pull Message contained in a task in a {::Google::Cloud::Tasks::V2beta3::Queue#type PULL} queue type. This
|
60
|
+
# payload type cannot be explicitly set through Cloud Tasks API. Its
|
61
|
+
# purpose, currently is to provide backward compatibility with App Engine
|
62
|
+
# Task Queue
|
63
|
+
# [pull](https://cloud.google.com/appengine/docs/standard/java/taskqueue/pull/)
|
64
|
+
# queues to provide a way to inspect contents of pull tasks through the
|
65
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#get_task CloudTasks.GetTask}.
|
57
66
|
# @!attribute [rw] schedule_time
|
58
67
|
# @return [::Google::Protobuf::Timestamp]
|
59
68
|
# The time when the task is scheduled to be attempted.
|
@@ -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-v2beta3
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.5.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
|
@@ -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-v2beta3
|
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: []
|
@@ -231,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
231
233
|
- !ruby/object:Gem::Version
|
232
234
|
version: '0'
|
233
235
|
requirements: []
|
234
|
-
rubygems_version: 3.
|
236
|
+
rubygems_version: 3.2.6
|
235
237
|
signing_key:
|
236
238
|
specification_version: 4
|
237
239
|
summary: API Client library for the Cloud Tasks V2beta3 API
|