google-cloud-tasks-v2 0.6.0 → 0.8.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/AUTHENTICATION.md +1 -1
- data/README.md +3 -3
- data/lib/google/cloud/tasks/v2/cloud_tasks/client.rb +10 -14
- data/lib/google/cloud/tasks/v2/cloud_tasks/rest/client.rb +1751 -0
- data/lib/google/cloud/tasks/v2/cloud_tasks/rest/service_stub.rb +1002 -0
- data/lib/google/cloud/tasks/v2/cloud_tasks/rest.rb +53 -0
- data/lib/google/cloud/tasks/v2/cloud_tasks.rb +7 -1
- data/lib/google/cloud/tasks/v2/cloudtasks_pb.rb +27 -60
- data/lib/google/cloud/tasks/v2/queue_pb.rb +27 -31
- data/lib/google/cloud/tasks/v2/rest.rb +37 -0
- data/lib/google/cloud/tasks/v2/target_pb.rb +24 -42
- data/lib/google/cloud/tasks/v2/task_pb.rb +28 -27
- data/lib/google/cloud/tasks/v2/version.rb +1 -1
- data/lib/google/cloud/tasks/v2.rb +7 -2
- data/proto_docs/google/api/client.rb +381 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/cloud/tasks/v2/queue.rb +56 -44
- data/proto_docs/google/cloud/tasks/v2/target.rb +49 -37
- data/proto_docs/google/cloud/tasks/v2/task.rb +17 -10
- data/proto_docs/google/iam/v1/policy.rb +8 -4
- data/proto_docs/google/protobuf/any.rb +7 -4
- data/proto_docs/google/protobuf/empty.rb +0 -2
- data/proto_docs/google/protobuf/timestamp.rb +1 -3
- data/proto_docs/google/rpc/status.rb +4 -2
- metadata +14 -8
@@ -0,0 +1,381 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 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
|
+
|
20
|
+
module Google
|
21
|
+
module Api
|
22
|
+
# Required information for every language.
|
23
|
+
# @!attribute [rw] reference_docs_uri
|
24
|
+
# @return [::String]
|
25
|
+
# Link to automatically generated reference documentation. Example:
|
26
|
+
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
27
|
+
# @!attribute [rw] destinations
|
28
|
+
# @return [::Array<::Google::Api::ClientLibraryDestination>]
|
29
|
+
# The destination where API teams want this client library to be published.
|
30
|
+
class CommonLanguageSettings
|
31
|
+
include ::Google::Protobuf::MessageExts
|
32
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
33
|
+
end
|
34
|
+
|
35
|
+
# Details about how and where to publish client libraries.
|
36
|
+
# @!attribute [rw] version
|
37
|
+
# @return [::String]
|
38
|
+
# Version of the API to apply these settings to. This is the full protobuf
|
39
|
+
# package for the API, ending in the version element.
|
40
|
+
# Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
|
41
|
+
# @!attribute [rw] launch_stage
|
42
|
+
# @return [::Google::Api::LaunchStage]
|
43
|
+
# Launch stage of this version of the API.
|
44
|
+
# @!attribute [rw] rest_numeric_enums
|
45
|
+
# @return [::Boolean]
|
46
|
+
# When using transport=rest, the client request will encode enums as
|
47
|
+
# numbers rather than strings.
|
48
|
+
# @!attribute [rw] java_settings
|
49
|
+
# @return [::Google::Api::JavaSettings]
|
50
|
+
# Settings for legacy Java features, supported in the Service YAML.
|
51
|
+
# @!attribute [rw] cpp_settings
|
52
|
+
# @return [::Google::Api::CppSettings]
|
53
|
+
# Settings for C++ client libraries.
|
54
|
+
# @!attribute [rw] php_settings
|
55
|
+
# @return [::Google::Api::PhpSettings]
|
56
|
+
# Settings for PHP client libraries.
|
57
|
+
# @!attribute [rw] python_settings
|
58
|
+
# @return [::Google::Api::PythonSettings]
|
59
|
+
# Settings for Python client libraries.
|
60
|
+
# @!attribute [rw] node_settings
|
61
|
+
# @return [::Google::Api::NodeSettings]
|
62
|
+
# Settings for Node client libraries.
|
63
|
+
# @!attribute [rw] dotnet_settings
|
64
|
+
# @return [::Google::Api::DotnetSettings]
|
65
|
+
# Settings for .NET client libraries.
|
66
|
+
# @!attribute [rw] ruby_settings
|
67
|
+
# @return [::Google::Api::RubySettings]
|
68
|
+
# Settings for Ruby client libraries.
|
69
|
+
# @!attribute [rw] go_settings
|
70
|
+
# @return [::Google::Api::GoSettings]
|
71
|
+
# Settings for Go client libraries.
|
72
|
+
class ClientLibrarySettings
|
73
|
+
include ::Google::Protobuf::MessageExts
|
74
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
75
|
+
end
|
76
|
+
|
77
|
+
# This message configures the settings for publishing [Google Cloud Client
|
78
|
+
# libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
|
79
|
+
# generated from the service config.
|
80
|
+
# @!attribute [rw] method_settings
|
81
|
+
# @return [::Array<::Google::Api::MethodSettings>]
|
82
|
+
# A list of API method settings, e.g. the behavior for methods that use the
|
83
|
+
# long-running operation pattern.
|
84
|
+
# @!attribute [rw] new_issue_uri
|
85
|
+
# @return [::String]
|
86
|
+
# Link to a *public* URI where users can report issues. Example:
|
87
|
+
# https://issuetracker.google.com/issues/new?component=190865&template=1161103
|
88
|
+
# @!attribute [rw] documentation_uri
|
89
|
+
# @return [::String]
|
90
|
+
# Link to product home page. Example:
|
91
|
+
# https://cloud.google.com/asset-inventory/docs/overview
|
92
|
+
# @!attribute [rw] api_short_name
|
93
|
+
# @return [::String]
|
94
|
+
# Used as a tracking tag when collecting data about the APIs developer
|
95
|
+
# relations artifacts like docs, packages delivered to package managers,
|
96
|
+
# etc. Example: "speech".
|
97
|
+
# @!attribute [rw] github_label
|
98
|
+
# @return [::String]
|
99
|
+
# GitHub label to apply to issues and pull requests opened for this API.
|
100
|
+
# @!attribute [rw] codeowner_github_teams
|
101
|
+
# @return [::Array<::String>]
|
102
|
+
# GitHub teams to be added to CODEOWNERS in the directory in GitHub
|
103
|
+
# containing source code for the client libraries for this API.
|
104
|
+
# @!attribute [rw] doc_tag_prefix
|
105
|
+
# @return [::String]
|
106
|
+
# A prefix used in sample code when demarking regions to be included in
|
107
|
+
# documentation.
|
108
|
+
# @!attribute [rw] organization
|
109
|
+
# @return [::Google::Api::ClientLibraryOrganization]
|
110
|
+
# For whom the client library is being published.
|
111
|
+
# @!attribute [rw] library_settings
|
112
|
+
# @return [::Array<::Google::Api::ClientLibrarySettings>]
|
113
|
+
# Client library settings. If the same version string appears multiple
|
114
|
+
# times in this list, then the last one wins. Settings from earlier
|
115
|
+
# settings with the same version string are discarded.
|
116
|
+
# @!attribute [rw] proto_reference_documentation_uri
|
117
|
+
# @return [::String]
|
118
|
+
# Optional link to proto reference documentation. Example:
|
119
|
+
# https://cloud.google.com/pubsub/lite/docs/reference/rpc
|
120
|
+
class Publishing
|
121
|
+
include ::Google::Protobuf::MessageExts
|
122
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
123
|
+
end
|
124
|
+
|
125
|
+
# Settings for Java client libraries.
|
126
|
+
# @!attribute [rw] library_package
|
127
|
+
# @return [::String]
|
128
|
+
# The package name to use in Java. Clobbers the java_package option
|
129
|
+
# set in the protobuf. This should be used **only** by APIs
|
130
|
+
# who have already set the language_settings.java.package_name" field
|
131
|
+
# in gapic.yaml. API teams should use the protobuf java_package option
|
132
|
+
# where possible.
|
133
|
+
#
|
134
|
+
# Example of a YAML configuration::
|
135
|
+
#
|
136
|
+
# publishing:
|
137
|
+
# java_settings:
|
138
|
+
# library_package: com.google.cloud.pubsub.v1
|
139
|
+
# @!attribute [rw] service_class_names
|
140
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
141
|
+
# Configure the Java class name to use instead of the service's for its
|
142
|
+
# corresponding generated GAPIC client. Keys are fully-qualified
|
143
|
+
# service names as they appear in the protobuf (including the full
|
144
|
+
# the language_settings.java.interface_names" field in gapic.yaml. API
|
145
|
+
# teams should otherwise use the service name as it appears in the
|
146
|
+
# protobuf.
|
147
|
+
#
|
148
|
+
# Example of a YAML configuration::
|
149
|
+
#
|
150
|
+
# publishing:
|
151
|
+
# java_settings:
|
152
|
+
# service_class_names:
|
153
|
+
# - google.pubsub.v1.Publisher: TopicAdmin
|
154
|
+
# - google.pubsub.v1.Subscriber: SubscriptionAdmin
|
155
|
+
# @!attribute [rw] common
|
156
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
157
|
+
# Some settings.
|
158
|
+
class JavaSettings
|
159
|
+
include ::Google::Protobuf::MessageExts
|
160
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
161
|
+
|
162
|
+
# @!attribute [rw] key
|
163
|
+
# @return [::String]
|
164
|
+
# @!attribute [rw] value
|
165
|
+
# @return [::String]
|
166
|
+
class ServiceClassNamesEntry
|
167
|
+
include ::Google::Protobuf::MessageExts
|
168
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
169
|
+
end
|
170
|
+
end
|
171
|
+
|
172
|
+
# Settings for C++ client libraries.
|
173
|
+
# @!attribute [rw] common
|
174
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
175
|
+
# Some settings.
|
176
|
+
class CppSettings
|
177
|
+
include ::Google::Protobuf::MessageExts
|
178
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
179
|
+
end
|
180
|
+
|
181
|
+
# Settings for Php client libraries.
|
182
|
+
# @!attribute [rw] common
|
183
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
184
|
+
# Some settings.
|
185
|
+
class PhpSettings
|
186
|
+
include ::Google::Protobuf::MessageExts
|
187
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
188
|
+
end
|
189
|
+
|
190
|
+
# Settings for Python client libraries.
|
191
|
+
# @!attribute [rw] common
|
192
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
193
|
+
# Some settings.
|
194
|
+
class PythonSettings
|
195
|
+
include ::Google::Protobuf::MessageExts
|
196
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
197
|
+
end
|
198
|
+
|
199
|
+
# Settings for Node client libraries.
|
200
|
+
# @!attribute [rw] common
|
201
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
202
|
+
# Some settings.
|
203
|
+
class NodeSettings
|
204
|
+
include ::Google::Protobuf::MessageExts
|
205
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
206
|
+
end
|
207
|
+
|
208
|
+
# Settings for Dotnet client libraries.
|
209
|
+
# @!attribute [rw] common
|
210
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
211
|
+
# Some settings.
|
212
|
+
# @!attribute [rw] renamed_services
|
213
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
214
|
+
# Map from original service names to renamed versions.
|
215
|
+
# This is used when the default generated types
|
216
|
+
# would cause a naming conflict. (Neither name is
|
217
|
+
# fully-qualified.)
|
218
|
+
# Example: Subscriber to SubscriberServiceApi.
|
219
|
+
# @!attribute [rw] renamed_resources
|
220
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
221
|
+
# Map from full resource types to the effective short name
|
222
|
+
# for the resource. This is used when otherwise resource
|
223
|
+
# named from different services would cause naming collisions.
|
224
|
+
# Example entry:
|
225
|
+
# "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
|
226
|
+
# @!attribute [rw] ignored_resources
|
227
|
+
# @return [::Array<::String>]
|
228
|
+
# List of full resource types to ignore during generation.
|
229
|
+
# This is typically used for API-specific Location resources,
|
230
|
+
# which should be handled by the generator as if they were actually
|
231
|
+
# the common Location resources.
|
232
|
+
# Example entry: "documentai.googleapis.com/Location"
|
233
|
+
# @!attribute [rw] forced_namespace_aliases
|
234
|
+
# @return [::Array<::String>]
|
235
|
+
# Namespaces which must be aliased in snippets due to
|
236
|
+
# a known (but non-generator-predictable) naming collision
|
237
|
+
# @!attribute [rw] handwritten_signatures
|
238
|
+
# @return [::Array<::String>]
|
239
|
+
# Method signatures (in the form "service.method(signature)")
|
240
|
+
# which are provided separately, so shouldn't be generated.
|
241
|
+
# Snippets *calling* these methods are still generated, however.
|
242
|
+
class DotnetSettings
|
243
|
+
include ::Google::Protobuf::MessageExts
|
244
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
245
|
+
|
246
|
+
# @!attribute [rw] key
|
247
|
+
# @return [::String]
|
248
|
+
# @!attribute [rw] value
|
249
|
+
# @return [::String]
|
250
|
+
class RenamedServicesEntry
|
251
|
+
include ::Google::Protobuf::MessageExts
|
252
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
253
|
+
end
|
254
|
+
|
255
|
+
# @!attribute [rw] key
|
256
|
+
# @return [::String]
|
257
|
+
# @!attribute [rw] value
|
258
|
+
# @return [::String]
|
259
|
+
class RenamedResourcesEntry
|
260
|
+
include ::Google::Protobuf::MessageExts
|
261
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
262
|
+
end
|
263
|
+
end
|
264
|
+
|
265
|
+
# Settings for Ruby client libraries.
|
266
|
+
# @!attribute [rw] common
|
267
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
268
|
+
# Some settings.
|
269
|
+
class RubySettings
|
270
|
+
include ::Google::Protobuf::MessageExts
|
271
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
272
|
+
end
|
273
|
+
|
274
|
+
# Settings for Go client libraries.
|
275
|
+
# @!attribute [rw] common
|
276
|
+
# @return [::Google::Api::CommonLanguageSettings]
|
277
|
+
# Some settings.
|
278
|
+
class GoSettings
|
279
|
+
include ::Google::Protobuf::MessageExts
|
280
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
281
|
+
end
|
282
|
+
|
283
|
+
# Describes the generator configuration for a method.
|
284
|
+
# @!attribute [rw] selector
|
285
|
+
# @return [::String]
|
286
|
+
# The fully qualified name of the method, for which the options below apply.
|
287
|
+
# This is used to find the method to apply the options.
|
288
|
+
# @!attribute [rw] long_running
|
289
|
+
# @return [::Google::Api::MethodSettings::LongRunning]
|
290
|
+
# Describes settings to use for long-running operations when generating
|
291
|
+
# API methods for RPCs. Complements RPCs that use the annotations in
|
292
|
+
# google/longrunning/operations.proto.
|
293
|
+
#
|
294
|
+
# Example of a YAML configuration::
|
295
|
+
#
|
296
|
+
# publishing:
|
297
|
+
# method_settings:
|
298
|
+
# - selector: google.cloud.speech.v2.Speech.BatchRecognize
|
299
|
+
# long_running:
|
300
|
+
# initial_poll_delay:
|
301
|
+
# seconds: 60 # 1 minute
|
302
|
+
# poll_delay_multiplier: 1.5
|
303
|
+
# max_poll_delay:
|
304
|
+
# seconds: 360 # 6 minutes
|
305
|
+
# total_poll_timeout:
|
306
|
+
# seconds: 54000 # 90 minutes
|
307
|
+
class MethodSettings
|
308
|
+
include ::Google::Protobuf::MessageExts
|
309
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
310
|
+
|
311
|
+
# Describes settings to use when generating API methods that use the
|
312
|
+
# long-running operation pattern.
|
313
|
+
# All default values below are from those used in the client library
|
314
|
+
# generators (e.g.
|
315
|
+
# [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
|
316
|
+
# @!attribute [rw] initial_poll_delay
|
317
|
+
# @return [::Google::Protobuf::Duration]
|
318
|
+
# Initial delay after which the first poll request will be made.
|
319
|
+
# Default value: 5 seconds.
|
320
|
+
# @!attribute [rw] poll_delay_multiplier
|
321
|
+
# @return [::Float]
|
322
|
+
# Multiplier to gradually increase delay between subsequent polls until it
|
323
|
+
# reaches max_poll_delay.
|
324
|
+
# Default value: 1.5.
|
325
|
+
# @!attribute [rw] max_poll_delay
|
326
|
+
# @return [::Google::Protobuf::Duration]
|
327
|
+
# Maximum time between two subsequent poll requests.
|
328
|
+
# Default value: 45 seconds.
|
329
|
+
# @!attribute [rw] total_poll_timeout
|
330
|
+
# @return [::Google::Protobuf::Duration]
|
331
|
+
# Total polling timeout.
|
332
|
+
# Default value: 5 minutes.
|
333
|
+
class LongRunning
|
334
|
+
include ::Google::Protobuf::MessageExts
|
335
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
336
|
+
end
|
337
|
+
end
|
338
|
+
|
339
|
+
# The organization for which the client libraries are being published.
|
340
|
+
# Affects the url where generated docs are published, etc.
|
341
|
+
module ClientLibraryOrganization
|
342
|
+
# Not useful.
|
343
|
+
CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
|
344
|
+
|
345
|
+
# Google Cloud Platform Org.
|
346
|
+
CLOUD = 1
|
347
|
+
|
348
|
+
# Ads (Advertising) Org.
|
349
|
+
ADS = 2
|
350
|
+
|
351
|
+
# Photos Org.
|
352
|
+
PHOTOS = 3
|
353
|
+
|
354
|
+
# Street View Org.
|
355
|
+
STREET_VIEW = 4
|
356
|
+
|
357
|
+
# Shopping Org.
|
358
|
+
SHOPPING = 5
|
359
|
+
|
360
|
+
# Geo Org.
|
361
|
+
GEO = 6
|
362
|
+
|
363
|
+
# Generative AI - https://developers.generativeai.google
|
364
|
+
GENERATIVE_AI = 7
|
365
|
+
end
|
366
|
+
|
367
|
+
# To where should client libraries be published?
|
368
|
+
module ClientLibraryDestination
|
369
|
+
# Client libraries will neither be generated nor published to package
|
370
|
+
# managers.
|
371
|
+
CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
|
372
|
+
|
373
|
+
# Generate the client library in a repo under github.com/googleapis,
|
374
|
+
# but don't publish it to package managers.
|
375
|
+
GITHUB = 10
|
376
|
+
|
377
|
+
# Publish the library to package managers like nuget.org and npmjs.com.
|
378
|
+
PACKAGE_MANAGER = 20
|
379
|
+
end
|
380
|
+
end
|
381
|
+
end
|
@@ -0,0 +1,71 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 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
|
+
|
20
|
+
module Google
|
21
|
+
module Api
|
22
|
+
# The launch stage as defined by [Google Cloud Platform
|
23
|
+
# Launch Stages](https://cloud.google.com/terms/launch-stages).
|
24
|
+
module LaunchStage
|
25
|
+
# Do not use this default value.
|
26
|
+
LAUNCH_STAGE_UNSPECIFIED = 0
|
27
|
+
|
28
|
+
# The feature is not yet implemented. Users can not use it.
|
29
|
+
UNIMPLEMENTED = 6
|
30
|
+
|
31
|
+
# Prelaunch features are hidden from users and are only visible internally.
|
32
|
+
PRELAUNCH = 7
|
33
|
+
|
34
|
+
# Early Access features are limited to a closed group of testers. To use
|
35
|
+
# these features, you must sign up in advance and sign a Trusted Tester
|
36
|
+
# agreement (which includes confidentiality provisions). These features may
|
37
|
+
# be unstable, changed in backward-incompatible ways, and are not
|
38
|
+
# guaranteed to be released.
|
39
|
+
EARLY_ACCESS = 1
|
40
|
+
|
41
|
+
# Alpha is a limited availability test for releases before they are cleared
|
42
|
+
# for widespread use. By Alpha, all significant design issues are resolved
|
43
|
+
# and we are in the process of verifying functionality. Alpha customers
|
44
|
+
# need to apply for access, agree to applicable terms, and have their
|
45
|
+
# projects allowlisted. Alpha releases don't have to be feature complete,
|
46
|
+
# no SLAs are provided, and there are no technical support obligations, but
|
47
|
+
# they will be far enough along that customers can actually use them in
|
48
|
+
# test environments or for limited-use tests -- just like they would in
|
49
|
+
# normal production cases.
|
50
|
+
ALPHA = 2
|
51
|
+
|
52
|
+
# Beta is the point at which we are ready to open a release for any
|
53
|
+
# customer to use. There are no SLA or technical support obligations in a
|
54
|
+
# Beta release. Products will be complete from a feature perspective, but
|
55
|
+
# may have some open outstanding issues. Beta releases are suitable for
|
56
|
+
# limited production use cases.
|
57
|
+
BETA = 3
|
58
|
+
|
59
|
+
# GA features are open to all developers and are considered stable and
|
60
|
+
# fully qualified for production use.
|
61
|
+
GA = 4
|
62
|
+
|
63
|
+
# Deprecated features are scheduled to be shut down and removed. For more
|
64
|
+
# information, see the "Deprecation Policy" section of our [Terms of
|
65
|
+
# Service](https://cloud.google.com/terms/)
|
66
|
+
# and the [Google Cloud Platform Subject to the Deprecation
|
67
|
+
# Policy](https://cloud.google.com/terms/deprecation) documentation.
|
68
|
+
DEPRECATED = 5
|
69
|
+
end
|
70
|
+
end
|
71
|
+
end
|
@@ -26,8 +26,9 @@ module Google
|
|
26
26
|
# retry options, queue types, and others.
|
27
27
|
# @!attribute [rw] name
|
28
28
|
# @return [::String]
|
29
|
-
# Caller-specified and required in
|
30
|
-
# after which it
|
29
|
+
# Caller-specified and required in
|
30
|
+
# {::Google::Cloud::Tasks::V2::CloudTasks::Client#create_queue CreateQueue}, after which it
|
31
|
+
# becomes output only.
|
31
32
|
#
|
32
33
|
# The queue name.
|
33
34
|
#
|
@@ -48,36 +49,41 @@ module Google
|
|
48
49
|
# @!attribute [rw] app_engine_routing_override
|
49
50
|
# @return [::Google::Cloud::Tasks::V2::AppEngineRouting]
|
50
51
|
# Overrides for
|
51
|
-
#
|
52
|
+
# [task-level
|
53
|
+
# app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
|
52
54
|
# These settings apply only to
|
53
|
-
# {::Google::Cloud::Tasks::V2::AppEngineHttpRequest App Engine tasks} in this
|
54
|
-
# {::Google::Cloud::Tasks::V2::HttpRequest Http tasks} are not affected.
|
55
|
+
# {::Google::Cloud::Tasks::V2::AppEngineHttpRequest App Engine tasks} in this
|
56
|
+
# queue. {::Google::Cloud::Tasks::V2::HttpRequest Http tasks} are not affected.
|
55
57
|
#
|
56
58
|
# If set, `app_engine_routing_override` is used for all
|
57
|
-
# {::Google::Cloud::Tasks::V2::AppEngineHttpRequest App Engine tasks} in the
|
58
|
-
# setting is for the
|
59
|
-
#
|
59
|
+
# {::Google::Cloud::Tasks::V2::AppEngineHttpRequest App Engine tasks} in the
|
60
|
+
# queue, no matter what the setting is for the [task-level
|
61
|
+
# app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
|
60
62
|
# @!attribute [rw] rate_limits
|
61
63
|
# @return [::Google::Cloud::Tasks::V2::RateLimits]
|
62
64
|
# Rate limits for task dispatches.
|
63
65
|
#
|
64
|
-
# {::Google::Cloud::Tasks::V2::Queue#rate_limits rate_limits} and
|
65
|
-
#
|
66
|
-
# attempts
|
66
|
+
# {::Google::Cloud::Tasks::V2::Queue#rate_limits rate_limits} and
|
67
|
+
# {::Google::Cloud::Tasks::V2::Queue#retry_config retry_config} are related
|
68
|
+
# because they both control task attempts. However they control task attempts
|
69
|
+
# in different ways:
|
67
70
|
#
|
68
|
-
# * {::Google::Cloud::Tasks::V2::Queue#rate_limits rate_limits} controls the total
|
71
|
+
# * {::Google::Cloud::Tasks::V2::Queue#rate_limits rate_limits} controls the total
|
72
|
+
# rate of
|
69
73
|
# dispatches from a queue (i.e. all traffic dispatched from the
|
70
74
|
# queue, regardless of whether the dispatch is from a first
|
71
75
|
# attempt or a retry).
|
72
|
-
# * {::Google::Cloud::Tasks::V2::Queue#retry_config retry_config} controls what
|
76
|
+
# * {::Google::Cloud::Tasks::V2::Queue#retry_config retry_config} controls what
|
77
|
+
# happens to
|
73
78
|
# particular a task after its first attempt fails. That is,
|
74
|
-
# {::Google::Cloud::Tasks::V2::Queue#retry_config retry_config} controls task
|
75
|
-
# second attempt, third attempt, etc).
|
79
|
+
# {::Google::Cloud::Tasks::V2::Queue#retry_config retry_config} controls task
|
80
|
+
# retries (the second attempt, third attempt, etc).
|
76
81
|
#
|
77
82
|
# The queue's actual dispatch rate is the result of:
|
78
83
|
#
|
79
84
|
# * Number of tasks in the queue
|
80
|
-
# * User-specified throttling:
|
85
|
+
# * User-specified throttling:
|
86
|
+
# {::Google::Cloud::Tasks::V2::Queue#rate_limits rate_limits},
|
81
87
|
# {::Google::Cloud::Tasks::V2::Queue#retry_config retry_config}, and the
|
82
88
|
# [queue's state][google.cloud.tasks.v2.Queue.state].
|
83
89
|
# * System throttling due to `429` (Too Many Requests) or `503` (Service
|
@@ -103,16 +109,18 @@ module Google
|
|
103
109
|
# {::Google::Cloud::Tasks::V2::CloudTasks::Client#pause_queue PauseQueue},
|
104
110
|
# {::Google::Cloud::Tasks::V2::CloudTasks::Client#resume_queue ResumeQueue}, or uploading
|
105
111
|
# [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
|
106
|
-
# {::Google::Cloud::Tasks::V2::CloudTasks::Client#update_queue UpdateQueue} cannot be used
|
112
|
+
# {::Google::Cloud::Tasks::V2::CloudTasks::Client#update_queue UpdateQueue} cannot be used
|
113
|
+
# to change `state`.
|
107
114
|
# @!attribute [rw] purge_time
|
108
115
|
# @return [::Google::Protobuf::Timestamp]
|
109
116
|
# Output only. The last time this queue was purged.
|
110
117
|
#
|
111
|
-
# All tasks that were {::Google::Cloud::Tasks::V2::Task#create_time created}
|
112
|
-
# were purged.
|
118
|
+
# All tasks that were {::Google::Cloud::Tasks::V2::Task#create_time created}
|
119
|
+
# before this time were purged.
|
113
120
|
#
|
114
|
-
# A queue can be purged using
|
115
|
-
#
|
121
|
+
# A queue can be purged using
|
122
|
+
# {::Google::Cloud::Tasks::V2::CloudTasks::Client#purge_queue PurgeQueue}, the [App Engine
|
123
|
+
# Task Queue SDK, or the Cloud
|
116
124
|
# Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
|
117
125
|
#
|
118
126
|
# Purge time will be truncated to the nearest microsecond. Purge
|
@@ -169,8 +177,9 @@ module Google
|
|
169
177
|
# This message determines the maximum rate that tasks can be dispatched by a
|
170
178
|
# queue, regardless of whether the dispatch is a first task attempt or a retry.
|
171
179
|
#
|
172
|
-
# Note: The debugging command,
|
173
|
-
#
|
180
|
+
# Note: The debugging command,
|
181
|
+
# {::Google::Cloud::Tasks::V2::CloudTasks::Client#run_task RunTask}, will run a task even if
|
182
|
+
# the queue has reached its {::Google::Cloud::Tasks::V2::RateLimits RateLimits}.
|
174
183
|
# @!attribute [rw] max_dispatches_per_second
|
175
184
|
# @return [::Float]
|
176
185
|
# The maximum rate at which tasks are dispatched from this queue.
|
@@ -211,9 +220,9 @@ module Google
|
|
211
220
|
# `queue.yaml/xml`, `max_burst_size` is equal to
|
212
221
|
# [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
|
213
222
|
# Since `max_burst_size` is output only, if
|
214
|
-
# {::Google::Cloud::Tasks::V2::CloudTasks::Client#update_queue UpdateQueue} is called on a
|
215
|
-
# created by `queue.yaml/xml`, `max_burst_size` will be reset based
|
216
|
-
#
|
223
|
+
# {::Google::Cloud::Tasks::V2::CloudTasks::Client#update_queue UpdateQueue} is called on a
|
224
|
+
# queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on
|
225
|
+
# the value of
|
217
226
|
# {::Google::Cloud::Tasks::V2::RateLimits#max_dispatches_per_second max_dispatches_per_second},
|
218
227
|
# regardless of whether
|
219
228
|
# {::Google::Cloud::Tasks::V2::RateLimits#max_dispatches_per_second max_dispatches_per_second}
|
@@ -264,9 +273,9 @@ module Google
|
|
264
273
|
# If positive, `max_retry_duration` specifies the time limit for
|
265
274
|
# retrying a failed task, measured from when the task was first
|
266
275
|
# attempted. Once `max_retry_duration` time has passed *and* the
|
267
|
-
# task has been attempted
|
268
|
-
# times, no
|
269
|
-
# deleted.
|
276
|
+
# task has been attempted
|
277
|
+
# {::Google::Cloud::Tasks::V2::RetryConfig#max_attempts max_attempts} times, no
|
278
|
+
# further attempts will be made and the task will be deleted.
|
270
279
|
#
|
271
280
|
# If zero, then the task age is unlimited.
|
272
281
|
#
|
@@ -281,11 +290,12 @@ module Google
|
|
281
290
|
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
|
282
291
|
# @!attribute [rw] min_backoff
|
283
292
|
# @return [::Google::Protobuf::Duration]
|
284
|
-
# A task will be {::Google::Cloud::Tasks::V2::Task#schedule_time scheduled} for
|
285
|
-
# {::Google::Cloud::Tasks::V2::RetryConfig#min_backoff min_backoff}
|
286
|
-
# {::Google::Cloud::Tasks::V2::RetryConfig#max_backoff max_backoff} duration
|
287
|
-
# if the queue's
|
288
|
-
#
|
293
|
+
# A task will be {::Google::Cloud::Tasks::V2::Task#schedule_time scheduled} for
|
294
|
+
# retry between {::Google::Cloud::Tasks::V2::RetryConfig#min_backoff min_backoff}
|
295
|
+
# and {::Google::Cloud::Tasks::V2::RetryConfig#max_backoff max_backoff} duration
|
296
|
+
# after it fails, if the queue's
|
297
|
+
# {::Google::Cloud::Tasks::V2::RetryConfig RetryConfig} specifies that the task
|
298
|
+
# should be retried.
|
289
299
|
#
|
290
300
|
# If unspecified when the queue is created, Cloud Tasks will pick the
|
291
301
|
# default.
|
@@ -298,11 +308,12 @@ module Google
|
|
298
308
|
# queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
|
299
309
|
# @!attribute [rw] max_backoff
|
300
310
|
# @return [::Google::Protobuf::Duration]
|
301
|
-
# A task will be {::Google::Cloud::Tasks::V2::Task#schedule_time scheduled} for
|
302
|
-
# {::Google::Cloud::Tasks::V2::RetryConfig#min_backoff min_backoff}
|
303
|
-
# {::Google::Cloud::Tasks::V2::RetryConfig#max_backoff max_backoff} duration
|
304
|
-
# if the queue's
|
305
|
-
#
|
311
|
+
# A task will be {::Google::Cloud::Tasks::V2::Task#schedule_time scheduled} for
|
312
|
+
# retry between {::Google::Cloud::Tasks::V2::RetryConfig#min_backoff min_backoff}
|
313
|
+
# and {::Google::Cloud::Tasks::V2::RetryConfig#max_backoff max_backoff} duration
|
314
|
+
# after it fails, if the queue's
|
315
|
+
# {::Google::Cloud::Tasks::V2::RetryConfig RetryConfig} specifies that the task
|
316
|
+
# should be retried.
|
306
317
|
#
|
307
318
|
# If unspecified when the queue is created, Cloud Tasks will pick the
|
308
319
|
# default.
|
@@ -324,15 +335,16 @@ module Google
|
|
324
335
|
# {::Google::Cloud::Tasks::V2::RetryConfig#max_backoff max_backoff} up to
|
325
336
|
# {::Google::Cloud::Tasks::V2::RetryConfig#max_attempts max_attempts} times.
|
326
337
|
#
|
327
|
-
# For example, if
|
338
|
+
# For example, if
|
339
|
+
# {::Google::Cloud::Tasks::V2::RetryConfig#min_backoff min_backoff} is 10s,
|
328
340
|
# {::Google::Cloud::Tasks::V2::RetryConfig#max_backoff max_backoff} is 300s, and
|
329
341
|
# `max_doublings` is 3, then the a task will first be retried in
|
330
342
|
# 10s. The retry interval will double three times, and then
|
331
343
|
# increase linearly by 2^3 * 10s. Finally, the task will retry at
|
332
|
-
# intervals of {::Google::Cloud::Tasks::V2::RetryConfig#max_backoff max_backoff}
|
333
|
-
# task has been attempted
|
334
|
-
# times. Thus,
|
335
|
-
# 240s, 300s, 300s, ....
|
344
|
+
# intervals of {::Google::Cloud::Tasks::V2::RetryConfig#max_backoff max_backoff}
|
345
|
+
# until the task has been attempted
|
346
|
+
# {::Google::Cloud::Tasks::V2::RetryConfig#max_attempts max_attempts} times. Thus,
|
347
|
+
# the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
|
336
348
|
#
|
337
349
|
# If unspecified when the queue is created, Cloud Tasks will pick the
|
338
350
|
# default.
|