google-cloud-tasks-v2 0.8.1 → 0.8.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/google/cloud/tasks/v2/bindings_override.rb +102 -0
- data/lib/google/cloud/tasks/v2/cloud_tasks/client.rb +108 -87
- data/lib/google/cloud/tasks/v2/cloud_tasks/rest/client.rb +116 -87
- data/lib/google/cloud/tasks/v2/cloud_tasks/rest.rb +1 -0
- data/lib/google/cloud/tasks/v2/cloudtasks_services_pb.rb +33 -29
- data/lib/google/cloud/tasks/v2/rest.rb +1 -0
- data/lib/google/cloud/tasks/v2/version.rb +1 -1
- data/proto_docs/google/cloud/tasks/v2/cloudtasks.rb +74 -60
- data/proto_docs/google/cloud/tasks/v2/queue.rb +3 -3
- data/proto_docs/google/cloud/tasks/v2/target.rb +12 -13
- data/proto_docs/google/cloud/tasks/v2/task.rb +3 -3
- data/proto_docs/google/iam/v1/policy.rb +8 -4
- metadata +23 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4fc458310d9519284809db91d4decce47c8590e7a44af2c444d6ba626d198e51
|
|
4
|
+
data.tar.gz: '0908a45fc002152c9e1259dfcc6680652efc79cd6ba11e2447d13124d328014d'
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 505427abd2604868628701d74666a47cc00961817c6bedf5dd5ccecca9bc78ad99c03a129aaf132c9ed343054bd086198c9837344a8f8eaea8f3f630cd881735
|
|
7
|
+
data.tar.gz: 495a3154f884a9b7ea3671530a6103bab8cab73e93b50360943e8802e85e505957e9edff8647aa8933f05642c622e919783f395e8ecc12a0e1e6efcf65052081
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2023 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
require "gapic/config"
|
|
20
|
+
|
|
21
|
+
module Google
|
|
22
|
+
module Cloud
|
|
23
|
+
module Tasks
|
|
24
|
+
##
|
|
25
|
+
# @example Loading just the REST part of this package, including all its services, and instantiating a REST client
|
|
26
|
+
#
|
|
27
|
+
# require "google/cloud/tasks/v2/rest"
|
|
28
|
+
# client = ::Google::Cloud::Tasks::V2::CloudTasks::Rest::Client.new
|
|
29
|
+
#
|
|
30
|
+
module V2
|
|
31
|
+
##
|
|
32
|
+
# @private
|
|
33
|
+
# Initialize the mixin bindings configuration
|
|
34
|
+
#
|
|
35
|
+
def self.configure
|
|
36
|
+
@configure ||= begin
|
|
37
|
+
namespace = ["Google", "Cloud", "Tasks"]
|
|
38
|
+
parent_config = while namespace.any?
|
|
39
|
+
parent_name = namespace.join "::"
|
|
40
|
+
parent_const = const_get parent_name
|
|
41
|
+
break parent_const.configure if parent_const.respond_to? :configure
|
|
42
|
+
namespace.pop
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
default_config = Configuration.new parent_config
|
|
46
|
+
default_config.bindings_override["google.cloud.location.Locations.GetLocation"] = [
|
|
47
|
+
Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
|
|
48
|
+
uri_method: :get,
|
|
49
|
+
uri_template: "/v2/{name}",
|
|
50
|
+
matches: [
|
|
51
|
+
["name", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
|
|
52
|
+
],
|
|
53
|
+
body: nil
|
|
54
|
+
)
|
|
55
|
+
]
|
|
56
|
+
default_config.bindings_override["google.cloud.location.Locations.ListLocations"] = [
|
|
57
|
+
|
|
58
|
+
Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
|
|
59
|
+
uri_method: :get,
|
|
60
|
+
uri_template: "/v2/{name}/locations",
|
|
61
|
+
matches: [
|
|
62
|
+
["name", %r{^projects/[^/]+/?$}, false]
|
|
63
|
+
],
|
|
64
|
+
body: nil
|
|
65
|
+
)
|
|
66
|
+
]
|
|
67
|
+
default_config
|
|
68
|
+
end
|
|
69
|
+
yield @configure if block_given?
|
|
70
|
+
@configure
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
##
|
|
74
|
+
# @private
|
|
75
|
+
# Configuration class for the google.cloud.tasks.v2 package.
|
|
76
|
+
#
|
|
77
|
+
# This class contains common configuration for all services
|
|
78
|
+
# of the google.cloud.tasks.v2 package.
|
|
79
|
+
#
|
|
80
|
+
# This configuration is for internal use of the client library classes,
|
|
81
|
+
# and it is not intended that the end-users will read or change it.
|
|
82
|
+
#
|
|
83
|
+
class Configuration
|
|
84
|
+
extend ::Gapic::Config
|
|
85
|
+
|
|
86
|
+
# @private
|
|
87
|
+
# Overrides for http bindings for the RPC of the mixins for this package.
|
|
88
|
+
# Services in this package should use these when creating clients for the mixin services.
|
|
89
|
+
# @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
|
|
90
|
+
config_attr :bindings_override, {}, ::Hash, nil
|
|
91
|
+
|
|
92
|
+
# @private
|
|
93
|
+
def initialize parent_config = nil
|
|
94
|
+
@parent_config = parent_config unless parent_config.nil?
|
|
95
|
+
|
|
96
|
+
yield self if block_given?
|
|
97
|
+
end
|
|
98
|
+
end
|
|
99
|
+
end
|
|
100
|
+
end
|
|
101
|
+
end
|
|
102
|
+
end
|
|
@@ -18,6 +18,7 @@
|
|
|
18
18
|
|
|
19
19
|
require "google/cloud/errors"
|
|
20
20
|
require "google/cloud/tasks/v2/cloudtasks_pb"
|
|
21
|
+
require "google/cloud/location"
|
|
21
22
|
|
|
22
23
|
module Google
|
|
23
24
|
module Cloud
|
|
@@ -65,61 +66,61 @@ module Google
|
|
|
65
66
|
end
|
|
66
67
|
default_config = Client::Configuration.new parent_config
|
|
67
68
|
|
|
68
|
-
default_config.rpcs.list_queues.timeout =
|
|
69
|
+
default_config.rpcs.list_queues.timeout = 20.0
|
|
69
70
|
default_config.rpcs.list_queues.retry_policy = {
|
|
70
71
|
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
|
71
72
|
}
|
|
72
73
|
|
|
73
|
-
default_config.rpcs.get_queue.timeout =
|
|
74
|
+
default_config.rpcs.get_queue.timeout = 20.0
|
|
74
75
|
default_config.rpcs.get_queue.retry_policy = {
|
|
75
76
|
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
|
76
77
|
}
|
|
77
78
|
|
|
78
|
-
default_config.rpcs.create_queue.timeout =
|
|
79
|
+
default_config.rpcs.create_queue.timeout = 20.0
|
|
79
80
|
|
|
80
|
-
default_config.rpcs.update_queue.timeout =
|
|
81
|
+
default_config.rpcs.update_queue.timeout = 20.0
|
|
81
82
|
|
|
82
|
-
default_config.rpcs.delete_queue.timeout =
|
|
83
|
+
default_config.rpcs.delete_queue.timeout = 20.0
|
|
83
84
|
default_config.rpcs.delete_queue.retry_policy = {
|
|
84
85
|
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
|
85
86
|
}
|
|
86
87
|
|
|
87
|
-
default_config.rpcs.purge_queue.timeout =
|
|
88
|
+
default_config.rpcs.purge_queue.timeout = 20.0
|
|
88
89
|
|
|
89
|
-
default_config.rpcs.pause_queue.timeout =
|
|
90
|
+
default_config.rpcs.pause_queue.timeout = 20.0
|
|
90
91
|
|
|
91
|
-
default_config.rpcs.resume_queue.timeout =
|
|
92
|
+
default_config.rpcs.resume_queue.timeout = 20.0
|
|
92
93
|
|
|
93
|
-
default_config.rpcs.get_iam_policy.timeout =
|
|
94
|
+
default_config.rpcs.get_iam_policy.timeout = 20.0
|
|
94
95
|
default_config.rpcs.get_iam_policy.retry_policy = {
|
|
95
96
|
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
|
96
97
|
}
|
|
97
98
|
|
|
98
|
-
default_config.rpcs.set_iam_policy.timeout =
|
|
99
|
+
default_config.rpcs.set_iam_policy.timeout = 20.0
|
|
99
100
|
|
|
100
|
-
default_config.rpcs.test_iam_permissions.timeout =
|
|
101
|
+
default_config.rpcs.test_iam_permissions.timeout = 20.0
|
|
101
102
|
default_config.rpcs.test_iam_permissions.retry_policy = {
|
|
102
103
|
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
|
103
104
|
}
|
|
104
105
|
|
|
105
|
-
default_config.rpcs.list_tasks.timeout =
|
|
106
|
+
default_config.rpcs.list_tasks.timeout = 20.0
|
|
106
107
|
default_config.rpcs.list_tasks.retry_policy = {
|
|
107
108
|
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
|
108
109
|
}
|
|
109
110
|
|
|
110
|
-
default_config.rpcs.get_task.timeout =
|
|
111
|
+
default_config.rpcs.get_task.timeout = 20.0
|
|
111
112
|
default_config.rpcs.get_task.retry_policy = {
|
|
112
113
|
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
|
113
114
|
}
|
|
114
115
|
|
|
115
|
-
default_config.rpcs.create_task.timeout =
|
|
116
|
+
default_config.rpcs.create_task.timeout = 20.0
|
|
116
117
|
|
|
117
|
-
default_config.rpcs.delete_task.timeout =
|
|
118
|
+
default_config.rpcs.delete_task.timeout = 20.0
|
|
118
119
|
default_config.rpcs.delete_task.retry_policy = {
|
|
119
120
|
initial_delay: 0.1, max_delay: 10.0, multiplier: 1.3, retry_codes: [4, 14]
|
|
120
121
|
}
|
|
121
122
|
|
|
122
|
-
default_config.rpcs.run_task.timeout =
|
|
123
|
+
default_config.rpcs.run_task.timeout = 20.0
|
|
123
124
|
|
|
124
125
|
default_config
|
|
125
126
|
end
|
|
@@ -190,6 +191,12 @@ module Google
|
|
|
190
191
|
@quota_project_id = @config.quota_project
|
|
191
192
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
192
193
|
|
|
194
|
+
@location_client = Google::Cloud::Location::Locations::Client.new do |config|
|
|
195
|
+
config.credentials = credentials
|
|
196
|
+
config.quota_project = @quota_project_id
|
|
197
|
+
config.endpoint = @config.endpoint
|
|
198
|
+
end
|
|
199
|
+
|
|
193
200
|
@cloud_tasks_stub = ::Gapic::ServiceStub.new(
|
|
194
201
|
::Google::Cloud::Tasks::V2::CloudTasks::Stub,
|
|
195
202
|
credentials: credentials,
|
|
@@ -199,6 +206,13 @@ module Google
|
|
|
199
206
|
)
|
|
200
207
|
end
|
|
201
208
|
|
|
209
|
+
##
|
|
210
|
+
# Get the associated client for mix-in of the Locations.
|
|
211
|
+
#
|
|
212
|
+
# @return [Google::Cloud::Location::Locations::Client]
|
|
213
|
+
#
|
|
214
|
+
attr_reader :location_client
|
|
215
|
+
|
|
202
216
|
# Service calls
|
|
203
217
|
|
|
204
218
|
##
|
|
@@ -225,11 +239,10 @@ module Google
|
|
|
225
239
|
# Required. The location name.
|
|
226
240
|
# For example: `projects/PROJECT_ID/locations/LOCATION_ID`
|
|
227
241
|
# @param filter [::String]
|
|
228
|
-
# `filter` can be used to specify a subset of queues. Any
|
|
229
|
-
# field can be used as a filter and
|
|
230
|
-
# For example: `<=, <, >=, >, !=, =, :`. The
|
|
231
|
-
# described in
|
|
232
|
-
# [Stackdriver's Advanced Logs
|
|
242
|
+
# `filter` can be used to specify a subset of queues. Any
|
|
243
|
+
# {::Google::Cloud::Tasks::V2::Queue Queue} field can be used as a filter and
|
|
244
|
+
# several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The
|
|
245
|
+
# filter syntax is the same as described in [Stackdriver's Advanced Logs
|
|
233
246
|
# Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
|
|
234
247
|
#
|
|
235
248
|
# Sample filter "state: PAUSED".
|
|
@@ -242,17 +255,19 @@ module Google
|
|
|
242
255
|
# The maximum page size is 9800. If unspecified, the page size will
|
|
243
256
|
# be the maximum. Fewer queues than requested might be returned,
|
|
244
257
|
# even if more queues exist; use the
|
|
245
|
-
# {::Google::Cloud::Tasks::V2::ListQueuesResponse#next_page_token next_page_token}
|
|
246
|
-
# response to determine if more queues exist.
|
|
258
|
+
# {::Google::Cloud::Tasks::V2::ListQueuesResponse#next_page_token next_page_token}
|
|
259
|
+
# in the response to determine if more queues exist.
|
|
247
260
|
# @param page_token [::String]
|
|
248
261
|
# A token identifying the page of results to return.
|
|
249
262
|
#
|
|
250
263
|
# To request the first page results, page_token must be empty. To
|
|
251
264
|
# request the next page of results, page_token must be the value of
|
|
252
|
-
# {::Google::Cloud::Tasks::V2::ListQueuesResponse#next_page_token next_page_token}
|
|
253
|
-
# from the previous call to
|
|
254
|
-
# method. It is an
|
|
255
|
-
#
|
|
265
|
+
# {::Google::Cloud::Tasks::V2::ListQueuesResponse#next_page_token next_page_token}
|
|
266
|
+
# returned from the previous call to
|
|
267
|
+
# {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_queues ListQueues} method. It is an
|
|
268
|
+
# error to switch the value of the
|
|
269
|
+
# {::Google::Cloud::Tasks::V2::ListQueuesRequest#filter filter} while iterating
|
|
270
|
+
# through pages.
|
|
256
271
|
#
|
|
257
272
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
258
273
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Tasks::V2::Queue>]
|
|
@@ -413,8 +428,8 @@ module Google
|
|
|
413
428
|
# Creates a queue.
|
|
414
429
|
#
|
|
415
430
|
# Queues created with this method allow tasks to live for a maximum of 31
|
|
416
|
-
# days. After a task is 31 days old, the task will be deleted regardless of
|
|
417
|
-
# it was dispatched or not.
|
|
431
|
+
# days. After a task is 31 days old, the task will be deleted regardless of
|
|
432
|
+
# whether it was dispatched or not.
|
|
418
433
|
#
|
|
419
434
|
# WARNING: Using this method may have unintended side effects if you are
|
|
420
435
|
# using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
|
|
@@ -444,11 +459,12 @@ module Google
|
|
|
444
459
|
#
|
|
445
460
|
# The list of allowed locations can be obtained by calling Cloud
|
|
446
461
|
# Tasks' implementation of
|
|
447
|
-
#
|
|
462
|
+
# `::Google::Cloud::Location::Locations::Client#list_locations`.
|
|
448
463
|
# @param queue [::Google::Cloud::Tasks::V2::Queue, ::Hash]
|
|
449
464
|
# Required. The queue to create.
|
|
450
465
|
#
|
|
451
|
-
# [Queue's name][google.cloud.tasks.v2.Queue.name] cannot be the same as an
|
|
466
|
+
# [Queue's name][google.cloud.tasks.v2.Queue.name] cannot be the same as an
|
|
467
|
+
# existing queue.
|
|
452
468
|
#
|
|
453
469
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
454
470
|
# @yieldparam response [::Google::Cloud::Tasks::V2::Queue]
|
|
@@ -521,8 +537,8 @@ module Google
|
|
|
521
537
|
# the queue if it does exist.
|
|
522
538
|
#
|
|
523
539
|
# Queues created with this method allow tasks to live for a maximum of 31
|
|
524
|
-
# days. After a task is 31 days old, the task will be deleted regardless of
|
|
525
|
-
# it was dispatched or not.
|
|
540
|
+
# days. After a task is 31 days old, the task will be deleted regardless of
|
|
541
|
+
# whether it was dispatched or not.
|
|
526
542
|
#
|
|
527
543
|
# WARNING: Using this method may have unintended side effects if you are
|
|
528
544
|
# using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
|
|
@@ -817,9 +833,10 @@ module Google
|
|
|
817
833
|
#
|
|
818
834
|
# If a queue is paused then the system will stop dispatching tasks
|
|
819
835
|
# until the queue is resumed via
|
|
820
|
-
# {::Google::Cloud::Tasks::V2::CloudTasks::Client#resume_queue ResumeQueue}. Tasks can
|
|
821
|
-
# when the queue is paused. A queue is paused if its
|
|
822
|
-
# {::Google::Cloud::Tasks::V2::Queue#state state} is
|
|
836
|
+
# {::Google::Cloud::Tasks::V2::CloudTasks::Client#resume_queue ResumeQueue}. Tasks can
|
|
837
|
+
# still be added when the queue is paused. A queue is paused if its
|
|
838
|
+
# {::Google::Cloud::Tasks::V2::Queue#state state} is
|
|
839
|
+
# {::Google::Cloud::Tasks::V2::Queue::State::PAUSED PAUSED}.
|
|
823
840
|
#
|
|
824
841
|
# @overload pause_queue(request, options = nil)
|
|
825
842
|
# Pass arguments to `pause_queue` via a request object, either of type
|
|
@@ -909,9 +926,10 @@ module Google
|
|
|
909
926
|
#
|
|
910
927
|
# This method resumes a queue after it has been
|
|
911
928
|
# {::Google::Cloud::Tasks::V2::Queue::State::PAUSED PAUSED} or
|
|
912
|
-
# {::Google::Cloud::Tasks::V2::Queue::State::DISABLED DISABLED}. The state of a
|
|
913
|
-
# in the queue's {::Google::Cloud::Tasks::V2::Queue#state state};
|
|
914
|
-
# will be set to
|
|
929
|
+
# {::Google::Cloud::Tasks::V2::Queue::State::DISABLED DISABLED}. The state of a
|
|
930
|
+
# queue is stored in the queue's {::Google::Cloud::Tasks::V2::Queue#state state};
|
|
931
|
+
# after calling this method it will be set to
|
|
932
|
+
# {::Google::Cloud::Tasks::V2::Queue::State::RUNNING RUNNING}.
|
|
915
933
|
#
|
|
916
934
|
# WARNING: Resuming many high-QPS queues at the same time can
|
|
917
935
|
# lead to target overloading. If you are resuming high-QPS
|
|
@@ -1100,8 +1118,8 @@ module Google
|
|
|
1100
1118
|
end
|
|
1101
1119
|
|
|
1102
1120
|
##
|
|
1103
|
-
# Sets the access control policy for a {::Google::Cloud::Tasks::V2::Queue Queue}.
|
|
1104
|
-
# policy.
|
|
1121
|
+
# Sets the access control policy for a {::Google::Cloud::Tasks::V2::Queue Queue}.
|
|
1122
|
+
# Replaces any existing policy.
|
|
1105
1123
|
#
|
|
1106
1124
|
# Note: The Cloud Console does not check queue-level IAM permissions yet.
|
|
1107
1125
|
# Project-level permissions are required to use the Cloud Console.
|
|
@@ -1207,9 +1225,10 @@ module Google
|
|
|
1207
1225
|
end
|
|
1208
1226
|
|
|
1209
1227
|
##
|
|
1210
|
-
# Returns permissions that a caller has on a
|
|
1211
|
-
# If the resource does not exist, this
|
|
1212
|
-
# permissions, not a
|
|
1228
|
+
# Returns permissions that a caller has on a
|
|
1229
|
+
# {::Google::Cloud::Tasks::V2::Queue Queue}. If the resource does not exist, this
|
|
1230
|
+
# will return an empty set of permissions, not a
|
|
1231
|
+
# [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
|
|
1213
1232
|
#
|
|
1214
1233
|
# Note: This operation is designed to be used for building permission-aware
|
|
1215
1234
|
# UIs and command-line tools, not for authorization checking. This operation
|
|
@@ -1306,10 +1325,10 @@ module Google
|
|
|
1306
1325
|
##
|
|
1307
1326
|
# Lists the tasks in a queue.
|
|
1308
1327
|
#
|
|
1309
|
-
# By default, only the {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC} view is
|
|
1310
|
-
# due to performance considerations;
|
|
1311
|
-
# {::Google::Cloud::Tasks::V2::ListTasksRequest#response_view response_view}
|
|
1312
|
-
# subset of information which is returned.
|
|
1328
|
+
# By default, only the {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC} view is
|
|
1329
|
+
# retrieved due to performance considerations;
|
|
1330
|
+
# {::Google::Cloud::Tasks::V2::ListTasksRequest#response_view response_view}
|
|
1331
|
+
# controls the subset of information which is returned.
|
|
1313
1332
|
#
|
|
1314
1333
|
# The tasks may be returned in any order. The ordering may change at any
|
|
1315
1334
|
# time.
|
|
@@ -1333,11 +1352,11 @@ module Google
|
|
|
1333
1352
|
# Required. The queue name. For example:
|
|
1334
1353
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
|
1335
1354
|
# @param response_view [::Google::Cloud::Tasks::V2::Task::View]
|
|
1336
|
-
# The response_view specifies which subset of the
|
|
1337
|
-
# returned.
|
|
1355
|
+
# The response_view specifies which subset of the
|
|
1356
|
+
# {::Google::Cloud::Tasks::V2::Task Task} will be returned.
|
|
1338
1357
|
#
|
|
1339
|
-
# By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC};
|
|
1340
|
-
# information is retrieved by default because some data, such as
|
|
1358
|
+
# By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC};
|
|
1359
|
+
# not all information is retrieved by default because some data, such as
|
|
1341
1360
|
# payloads, might be desirable to return only when needed because
|
|
1342
1361
|
# of its large size or because of the sensitivity of data that it
|
|
1343
1362
|
# contains.
|
|
@@ -1349,8 +1368,8 @@ module Google
|
|
|
1349
1368
|
# Maximum page size.
|
|
1350
1369
|
#
|
|
1351
1370
|
# Fewer tasks than requested might be returned, even if more tasks exist; use
|
|
1352
|
-
# {::Google::Cloud::Tasks::V2::ListTasksResponse#next_page_token next_page_token}
|
|
1353
|
-
# determine if more tasks exist.
|
|
1371
|
+
# {::Google::Cloud::Tasks::V2::ListTasksResponse#next_page_token next_page_token}
|
|
1372
|
+
# in the response to determine if more tasks exist.
|
|
1354
1373
|
#
|
|
1355
1374
|
# The maximum page size is 1000. If unspecified, the page size will be the
|
|
1356
1375
|
# maximum.
|
|
@@ -1359,9 +1378,9 @@ module Google
|
|
|
1359
1378
|
#
|
|
1360
1379
|
# To request the first page results, page_token must be empty. To
|
|
1361
1380
|
# request the next page of results, page_token must be the value of
|
|
1362
|
-
# {::Google::Cloud::Tasks::V2::ListTasksResponse#next_page_token next_page_token}
|
|
1363
|
-
# from the previous call to
|
|
1364
|
-
# method.
|
|
1381
|
+
# {::Google::Cloud::Tasks::V2::ListTasksResponse#next_page_token next_page_token}
|
|
1382
|
+
# returned from the previous call to
|
|
1383
|
+
# {::Google::Cloud::Tasks::V2::CloudTasks::Client#list_tasks ListTasks} method.
|
|
1365
1384
|
#
|
|
1366
1385
|
# The page token is valid for only 2 hours.
|
|
1367
1386
|
#
|
|
@@ -1456,11 +1475,11 @@ module Google
|
|
|
1456
1475
|
# Required. The task name. For example:
|
|
1457
1476
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
|
1458
1477
|
# @param response_view [::Google::Cloud::Tasks::V2::Task::View]
|
|
1459
|
-
# The response_view specifies which subset of the
|
|
1460
|
-
# returned.
|
|
1478
|
+
# The response_view specifies which subset of the
|
|
1479
|
+
# {::Google::Cloud::Tasks::V2::Task Task} will be returned.
|
|
1461
1480
|
#
|
|
1462
|
-
# By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC};
|
|
1463
|
-
# information is retrieved by default because some data, such as
|
|
1481
|
+
# By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC};
|
|
1482
|
+
# not all information is retrieved by default because some data, such as
|
|
1464
1483
|
# payloads, might be desirable to return only when needed because
|
|
1465
1484
|
# of its large size or because of the sensitivity of data that it
|
|
1466
1485
|
# contains.
|
|
@@ -1565,13 +1584,13 @@ module Google
|
|
|
1565
1584
|
#
|
|
1566
1585
|
# Task names have the following format:
|
|
1567
1586
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
|
|
1568
|
-
# The user can optionally specify a task
|
|
1569
|
-
# name is not specified then
|
|
1570
|
-
# unique task id, which will be set in the
|
|
1571
|
-
# {::Google::Cloud::Tasks::V2::Task#name response}.
|
|
1587
|
+
# The user can optionally specify a task
|
|
1588
|
+
# {::Google::Cloud::Tasks::V2::Task#name name}. If a name is not specified then
|
|
1589
|
+
# the system will generate a random unique task id, which will be set in the
|
|
1590
|
+
# task returned in the {::Google::Cloud::Tasks::V2::Task#name response}.
|
|
1572
1591
|
#
|
|
1573
|
-
# If {::Google::Cloud::Tasks::V2::Task#schedule_time schedule_time} is not set or
|
|
1574
|
-
# past then Cloud Tasks will set it to the current time.
|
|
1592
|
+
# If {::Google::Cloud::Tasks::V2::Task#schedule_time schedule_time} is not set or
|
|
1593
|
+
# is in the past then Cloud Tasks will set it to the current time.
|
|
1575
1594
|
#
|
|
1576
1595
|
# Task De-duplication:
|
|
1577
1596
|
#
|
|
@@ -1586,20 +1605,20 @@ module Google
|
|
|
1586
1605
|
# for ~9days after the original task was deleted or executed.
|
|
1587
1606
|
#
|
|
1588
1607
|
# Because there is an extra lookup cost to identify duplicate task
|
|
1589
|
-
# names, these {::Google::Cloud::Tasks::V2::CloudTasks::Client#create_task CreateTask}
|
|
1590
|
-
# increased latency. Using hashed strings for the
|
|
1591
|
-
# the prefix of the task id is recommended. Choosing task ids
|
|
1592
|
-
# are sequential or have sequential prefixes, for example using a
|
|
1608
|
+
# names, these {::Google::Cloud::Tasks::V2::CloudTasks::Client#create_task CreateTask}
|
|
1609
|
+
# calls have significantly increased latency. Using hashed strings for the
|
|
1610
|
+
# task id or for the prefix of the task id is recommended. Choosing task ids
|
|
1611
|
+
# that are sequential or have sequential prefixes, for example using a
|
|
1593
1612
|
# timestamp, causes an increase in latency and error rates in all
|
|
1594
1613
|
# task commands. The infrastructure relies on an approximately
|
|
1595
1614
|
# uniform distribution of task ids to store and serve tasks
|
|
1596
1615
|
# efficiently.
|
|
1597
1616
|
# @param response_view [::Google::Cloud::Tasks::V2::Task::View]
|
|
1598
|
-
# The response_view specifies which subset of the
|
|
1599
|
-
# returned.
|
|
1617
|
+
# The response_view specifies which subset of the
|
|
1618
|
+
# {::Google::Cloud::Tasks::V2::Task Task} will be returned.
|
|
1600
1619
|
#
|
|
1601
|
-
# By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC};
|
|
1602
|
-
# information is retrieved by default because some data, such as
|
|
1620
|
+
# By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC};
|
|
1621
|
+
# not all information is retrieved by default because some data, such as
|
|
1603
1622
|
# payloads, might be desirable to return only when needed because
|
|
1604
1623
|
# of its large size or because of the sensitivity of data that it
|
|
1605
1624
|
# contains.
|
|
@@ -1766,13 +1785,14 @@ module Google
|
|
|
1766
1785
|
# Forces a task to run now.
|
|
1767
1786
|
#
|
|
1768
1787
|
# When this method is called, Cloud Tasks will dispatch the task, even if
|
|
1769
|
-
# the task is already running, the queue has reached its
|
|
1770
|
-
#
|
|
1788
|
+
# the task is already running, the queue has reached its
|
|
1789
|
+
# {::Google::Cloud::Tasks::V2::RateLimits RateLimits} or is
|
|
1790
|
+
# {::Google::Cloud::Tasks::V2::Queue::State::PAUSED PAUSED}.
|
|
1771
1791
|
#
|
|
1772
1792
|
# This command is meant to be used for manual debugging. For
|
|
1773
|
-
# example, {::Google::Cloud::Tasks::V2::CloudTasks::Client#run_task RunTask} can be used to
|
|
1774
|
-
# task after a fix has been made or to manually force a task
|
|
1775
|
-
# dispatched now.
|
|
1793
|
+
# example, {::Google::Cloud::Tasks::V2::CloudTasks::Client#run_task RunTask} can be used to
|
|
1794
|
+
# retry a failed task after a fix has been made or to manually force a task
|
|
1795
|
+
# to be dispatched now.
|
|
1776
1796
|
#
|
|
1777
1797
|
# The dispatched task is returned. That is, the task that is returned
|
|
1778
1798
|
# contains the [status][Task.status] after the task is dispatched but
|
|
@@ -1780,9 +1800,10 @@ module Google
|
|
|
1780
1800
|
#
|
|
1781
1801
|
# If Cloud Tasks receives a successful response from the task's
|
|
1782
1802
|
# target, then the task will be deleted; otherwise the task's
|
|
1783
|
-
# {::Google::Cloud::Tasks::V2::Task#schedule_time schedule_time} will be reset to
|
|
1784
|
-
# {::Google::Cloud::Tasks::V2::CloudTasks::Client#run_task RunTask} was
|
|
1785
|
-
# in the queue's
|
|
1803
|
+
# {::Google::Cloud::Tasks::V2::Task#schedule_time schedule_time} will be reset to
|
|
1804
|
+
# the time that {::Google::Cloud::Tasks::V2::CloudTasks::Client#run_task RunTask} was
|
|
1805
|
+
# called plus the retry delay specified in the queue's
|
|
1806
|
+
# {::Google::Cloud::Tasks::V2::RetryConfig RetryConfig}.
|
|
1786
1807
|
#
|
|
1787
1808
|
# {::Google::Cloud::Tasks::V2::CloudTasks::Client#run_task RunTask} returns
|
|
1788
1809
|
# [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
|
|
@@ -1807,11 +1828,11 @@ module Google
|
|
|
1807
1828
|
# Required. The task name. For example:
|
|
1808
1829
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
|
1809
1830
|
# @param response_view [::Google::Cloud::Tasks::V2::Task::View]
|
|
1810
|
-
# The response_view specifies which subset of the
|
|
1811
|
-
# returned.
|
|
1831
|
+
# The response_view specifies which subset of the
|
|
1832
|
+
# {::Google::Cloud::Tasks::V2::Task Task} will be returned.
|
|
1812
1833
|
#
|
|
1813
|
-
# By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC};
|
|
1814
|
-
# information is retrieved by default because some data, such as
|
|
1834
|
+
# By default response_view is {::Google::Cloud::Tasks::V2::Task::View::BASIC BASIC};
|
|
1835
|
+
# not all information is retrieved by default because some data, such as
|
|
1815
1836
|
# payloads, might be desirable to return only when needed because
|
|
1816
1837
|
# of its large size or because of the sensitivity of data that it
|
|
1817
1838
|
# contains.
|