google-cloud-tasks 0.2.3 → 0.2.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (19) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/lib/google/cloud/tasks.rb +4 -4
  4. data/lib/google/cloud/tasks/v2beta2.rb +4 -4
  5. data/lib/google/cloud/tasks/v2beta2/cloud_tasks_client.rb +61 -61
  6. data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb +38 -38
  7. data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/queue.rb +25 -25
  8. data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/target.rb +42 -42
  9. data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/task.rb +11 -11
  10. data/lib/google/cloud/tasks/v2beta2/doc/google/iam/v1/iam_policy.rb +13 -13
  11. data/lib/google/cloud/tasks/v2beta2/doc/google/iam/v1/policy.rb +28 -28
  12. data/lib/google/cloud/tasks/v2beta2/doc/google/protobuf/any.rb +8 -8
  13. data/lib/google/cloud/tasks/v2beta2/doc/google/protobuf/duration.rb +3 -3
  14. data/lib/google/cloud/tasks/v2beta2/doc/google/protobuf/empty.rb +1 -1
  15. data/lib/google/cloud/tasks/v2beta2/doc/google/protobuf/field_mask.rb +7 -7
  16. data/lib/google/cloud/tasks/v2beta2/doc/google/protobuf/timestamp.rb +7 -7
  17. data/lib/google/cloud/tasks/v2beta2/doc/google/rpc/status.rb +11 -11
  18. metadata +3 -4
  19. data/lib/google/cloud/tasks/v2beta2/doc/overview.rb +0 -80
data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/cloudtasks.rb CHANGED
@@ -23,12 +23,12 @@ module Google
23
23
  # Required.
24
24
  #
25
25
  # The location name.
26
- # For example: +projects/PROJECT_ID/locations/LOCATION_ID+
26
+ # For example: `projects/PROJECT_ID/locations/LOCATION_ID`
27
27
  # @!attribute [rw] filter
28
28
  # @return [String]
29
- # +filter+ can be used to specify a subset of queues. Any {Google::Cloud::Tasks::V2beta2::Queue Queue}
29
+ # `filter` can be used to specify a subset of queues. Any {Google::Cloud::Tasks::V2beta2::Queue Queue}
30
30
  # field can be used as a filter and several operators as supported.
31
- # For example: +<=, <, >=, >, !=, =, :+. The filter syntax is the same as
31
+ # For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
32
32
  # described in
33
33
  # [Stackdriver's Advanced Logs Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
34
34
  #
@@ -80,7 +80,7 @@ module Google
80
80
  # Required.
81
81
  #
82
82
  # The resource name of the queue. For example:
83
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID+
83
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
84
84
  class GetQueueRequest; end
85
85
 
86
86
  # Request message for {Google::Cloud::Tasks::V2beta2::CloudTasks::CreateQueue CreateQueue}.
@@ -89,7 +89,7 @@ module Google
89
89
  # Required.
90
90
  #
91
91
  # The location name in which the queue will be created.
92
- # For example: +projects/PROJECT_ID/locations/LOCATION_ID+
92
+ # For example: `projects/PROJECT_ID/locations/LOCATION_ID`
93
93
  #
94
94
  # The list of allowed locations can be obtained by calling Cloud
95
95
  # Tasks' implementation of
@@ -128,7 +128,7 @@ module Google
128
128
  # Required.
129
129
  #
130
130
  # The queue name. For example:
131
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID+
131
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
132
132
  class DeleteQueueRequest; end
133
133
 
134
134
  # Request message for {Google::Cloud::Tasks::V2beta2::CloudTasks::PurgeQueue PurgeQueue}.
@@ -137,7 +137,7 @@ module Google
137
137
  # Required.
138
138
  #
139
139
  # The queue name. For example:
140
- # +projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID+
140
+ # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
141
141
  class PurgeQueueRequest; end
142
142
 
143
143
  # Request message for {Google::Cloud::Tasks::V2beta2::CloudTasks::PauseQueue PauseQueue}.
@@ -146,7 +146,7 @@ module Google
146
146
  # Required.
147
147
  #
148
148
  # The queue name. For example:
149
- # +projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID+
149
+ # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
150
150
  class PauseQueueRequest; end
151
151
 
152
152
  # Request message for {Google::Cloud::Tasks::V2beta2::CloudTasks::ResumeQueue ResumeQueue}.
@@ -155,7 +155,7 @@ module Google
155
155
  # Required.
156
156
  #
157
157
  # The queue name. For example:
158
- # +projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID+
158
+ # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
159
159
  class ResumeQueueRequest; end
160
160
 
161
161
  # Request message for listing tasks using {Google::Cloud::Tasks::V2beta2::CloudTasks::ListTasks ListTasks}.
@@ -164,7 +164,7 @@ module Google
164
164
  # Required.
165
165
  #
166
166
  # The queue name. For example:
167
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID+
167
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
168
168
  # @!attribute [rw] response_view
169
169
  # @return [Google::Cloud::Tasks::V2beta2::Task::View]
170
170
  # The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
@@ -177,7 +177,7 @@ module Google
177
177
  # contains.
178
178
  #
179
179
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
180
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
180
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
181
181
  # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
182
182
  # @!attribute [rw] page_size
183
183
  # @return [Integer]
@@ -222,7 +222,7 @@ module Google
222
222
  # Required.
223
223
  #
224
224
  # The task name. For example:
225
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID+
225
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
226
226
  # @!attribute [rw] response_view
227
227
  # @return [Google::Cloud::Tasks::V2beta2::Task::View]
228
228
  # The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
@@ -235,7 +235,7 @@ module Google
235
235
  # contains.
236
236
  #
237
237
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
238
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
238
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
239
239
  # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
240
240
  class GetTaskRequest; end
241
241
 
@@ -245,7 +245,7 @@ module Google
245
245
  # Required.
246
246
  #
247
247
  # The queue name. For example:
248
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID+
248
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
249
249
  #
250
250
  # The queue must already exist.
251
251
  # @!attribute [rw] task
@@ -255,7 +255,7 @@ module Google
255
255
  # The task to add.
256
256
  #
257
257
  # Task names have the following format:
258
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID+.
258
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
259
259
  # The user can optionally specify a task {Google::Cloud::Tasks::V2beta2::Task#name name}. If a
260
260
  # name is not specified then the system will generate a random
261
261
  # unique task id, which will be set in the task returned in the
@@ -297,7 +297,7 @@ module Google
297
297
  # contains.
298
298
  #
299
299
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
300
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
300
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
301
301
  # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
302
302
  class CreateTaskRequest; end
303
303
 
@@ -308,7 +308,7 @@ module Google
308
308
  # Required.
309
309
  #
310
310
  # The task name. For example:
311
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID+
311
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
312
312
  class DeleteTaskRequest; end
313
313
 
314
314
  # Request message for leasing tasks using {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks}.
@@ -317,15 +317,15 @@ module Google
317
317
  # Required.
318
318
  #
319
319
  # The queue name. For example:
320
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID+
320
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
321
321
  # @!attribute [rw] max_tasks
322
322
  # @return [Integer]
323
323
  # The maximum number of tasks to lease.
324
324
  #
325
325
  # The system will make a best effort to return as close to as
326
- # +max_tasks+ as possible.
326
+ # `max_tasks` as possible.
327
327
  #
328
- # The largest that +max_tasks+ can be is 1000.
328
+ # The largest that `max_tasks` can be is 1000.
329
329
  # @!attribute [rw] lease_duration
330
330
  # @return [Google::Protobuf::Duration]
331
331
  # After the worker has successfully finished the work associated
@@ -336,7 +336,7 @@ module Google
336
336
  # that another worker can retry it.
337
337
  #
338
338
  # The maximum lease duration is 1 week.
339
- # +lease_duration+ will be truncated to the nearest second.
339
+ # `lease_duration` will be truncated to the nearest second.
340
340
  # @!attribute [rw] response_view
341
341
  # @return [Google::Cloud::Tasks::V2beta2::Task::View]
342
342
  # The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
@@ -349,30 +349,30 @@ module Google
349
349
  # contains.
350
350
  #
351
351
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
352
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
352
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
353
353
  # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
354
354
  # @!attribute [rw] filter
355
355
  # @return [String]
356
- # +filter+ can be used to specify a subset of tasks to lease.
356
+ # `filter` can be used to specify a subset of tasks to lease.
357
357
  #
358
- # When +filter+ is set to +tag=<my-tag>+ then the
358
+ # When `filter` is set to `tag=<my-tag>` then the
359
359
  # {Google::Cloud::Tasks::V2beta2::LeaseTasksResponse response} will contain only tasks whose
360
- # {Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} is equal to +<my-tag>+. +<my-tag>+ must be
360
+ # {Google::Cloud::Tasks::V2beta2::PullMessage#tag tag} is equal to `<my-tag>`. `<my-tag>` must be
361
361
  # less than 500 characters.
362
362
  #
363
- # When +filter+ is set to +tag_function=oldest_tag()+, only tasks which have
363
+ # When `filter` is set to `tag_function=oldest_tag()`, only tasks which have
364
364
  # the same tag as the task with the oldest
365
365
  # {Google::Cloud::Tasks::V2beta2::Task#schedule_time schedule_time} will be returned.
366
366
  #
367
367
  # Grammar Syntax:
368
368
  #
369
- # * +filter = "tag=" tag | "tag_function=" function+
369
+ # * `filter = "tag=" tag | "tag_function=" function`
370
370
  #
371
- # * +tag = string+
371
+ # * `tag = string`
372
372
  #
373
- # * +function = "oldest_tag()"+
373
+ # * `function = "oldest_tag()"`
374
374
  #
375
- # The +oldest_tag()+ function returns tasks which have the same tag as the
375
+ # The `oldest_tag()` function returns tasks which have the same tag as the
376
376
  # oldest task (ordered by schedule time).
377
377
  #
378
378
  # SDK compatibility: Although the SDK allows tags to be either
@@ -397,7 +397,7 @@ module Google
397
397
  # Required.
398
398
  #
399
399
  # The task name. For example:
400
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID+
400
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
401
401
  # @!attribute [rw] schedule_time
402
402
  # @return [Google::Protobuf::Timestamp]
403
403
  # Required.
@@ -416,7 +416,7 @@ module Google
416
416
  # Required.
417
417
  #
418
418
  # The task name. For example:
419
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID+
419
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
420
420
  # @!attribute [rw] schedule_time
421
421
  # @return [Google::Protobuf::Timestamp]
422
422
  # Required.
@@ -434,7 +434,7 @@ module Google
434
434
  #
435
435
  #
436
436
  # The maximum lease duration is 1 week.
437
- # +lease_duration+ will be truncated to the nearest second.
437
+ # `lease_duration` will be truncated to the nearest second.
438
438
  # @!attribute [rw] response_view
439
439
  # @return [Google::Cloud::Tasks::V2beta2::Task::View]
440
440
  # The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
@@ -447,7 +447,7 @@ module Google
447
447
  # contains.
448
448
  #
449
449
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
450
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
450
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
451
451
  # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
452
452
  class RenewLeaseRequest; end
453
453
 
@@ -458,7 +458,7 @@ module Google
458
458
  # Required.
459
459
  #
460
460
  # The task name. For example:
461
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID+
461
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
462
462
  # @!attribute [rw] schedule_time
463
463
  # @return [Google::Protobuf::Timestamp]
464
464
  # Required.
@@ -480,7 +480,7 @@ module Google
480
480
  # contains.
481
481
  #
482
482
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
483
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
483
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
484
484
  # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
485
485
  class CancelLeaseRequest; end
486
486
 
@@ -491,7 +491,7 @@ module Google
491
491
  # Required.
492
492
  #
493
493
  # The task name. For example:
494
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID+
494
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
495
495
  # @!attribute [rw] response_view
496
496
  # @return [Google::Cloud::Tasks::V2beta2::Task::View]
497
497
  # The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta2::Task Task} will be
@@ -504,7 +504,7 @@ module Google
504
504
  # contains.
505
505
  #
506
506
  # Authorization for {Google::Cloud::Tasks::V2beta2::Task::View::FULL FULL} requires
507
- # +cloudtasks.tasks.fullView+ [Google IAM](https://cloud.google.com/iam/)
507
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
508
508
  # permission on the {Google::Cloud::Tasks::V2beta2::Task Task} resource.
509
509
  class RunTaskRequest; end
510
510
  end
data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/queue.rb CHANGED
@@ -28,17 +28,17 @@ module Google
28
28
  # The queue name.
29
29
  #
30
30
  # The queue name must have the following format:
31
- # +projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID+
31
+ # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
32
32
  #
33
- # * +PROJECT_ID+ can contain letters ([A-Za-z]), numbers ([0-9]),
33
+ # * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),
34
34
  # hyphens (-), colons (:), or periods (.).
35
35
  # For more information, see
36
36
  # [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
37
- # * +LOCATION_ID+ is the canonical ID for the queue's location.
37
+ # * `LOCATION_ID` is the canonical ID for the queue's location.
38
38
  # The list of available locations can be obtained by calling
39
39
  # {Google::Cloud::Location::Locations::ListLocations ListLocations}.
40
40
  # For more information, see https://cloud.google.com/about/locations/.
41
- # * +QUEUE_ID+ can contain letters ([A-Za-z]), numbers ([0-9]), or
41
+ # * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
42
42
  # hyphens (-). The maximum length is 100 characters.
43
43
  # @!attribute [rw] app_engine_http_target
44
44
  # @return [Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget]
@@ -82,11 +82,11 @@ module Google
82
82
  # @return [Google::Cloud::Tasks::V2beta2::Queue::State]
83
83
  # Output only. The state of the queue.
84
84
  #
85
- # +state+ can only be changed by called
85
+ # `state` can only be changed by called
86
86
  # {Google::Cloud::Tasks::V2beta2::CloudTasks::PauseQueue PauseQueue},
87
87
  # {Google::Cloud::Tasks::V2beta2::CloudTasks::ResumeQueue ResumeQueue}, or uploading
88
88
  # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
89
- # {Google::Cloud::Tasks::V2beta2::CloudTasks::UpdateQueue UpdateQueue} cannot be used to change +state+.
89
+ # {Google::Cloud::Tasks::V2beta2::CloudTasks::UpdateQueue UpdateQueue} cannot be used to change `state`.
90
90
  # @!attribute [rw] purge_time
91
91
  # @return [Google::Protobuf::Timestamp]
92
92
  # Output only. The last time this queue was purged.
@@ -124,7 +124,7 @@ module Google
124
124
 
125
125
  # The queue is disabled.
126
126
  #
127
- # A queue becomes +DISABLED+ when
127
+ # A queue becomes `DISABLED` when
128
128
  # [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref) or
129
129
  # [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref) is uploaded
130
130
  # which does not contain the queue. You cannot directly disable a queue.
@@ -132,7 +132,7 @@ module Google
132
132
  # When a queue is disabled, tasks can still be added to a queue
133
133
  # but the tasks are not dispatched and
134
134
  # {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} calls return a
135
- # +FAILED_PRECONDITION+ error.
135
+ # `FAILED_PRECONDITION` error.
136
136
  #
137
137
  # To permanently delete this queue and all of its tasks, call
138
138
  # {Google::Cloud::Tasks::V2beta2::CloudTasks::DeleteQueue DeleteQueue}.
@@ -157,7 +157,7 @@ module Google
157
157
  # * For {Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget App Engine queues}, the maximum allowed value
158
158
  # is 500.
159
159
  # * This field is output only for {Google::Cloud::Tasks::V2beta2::PullTarget pull queues}. In addition to the
160
- # +max_tasks_dispatched_per_second+ limit, a maximum of 10 QPS of
160
+ # `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of
161
161
  # {Google::Cloud::Tasks::V2beta2::CloudTasks::LeaseTasks LeaseTasks} requests are allowed per pull queue.
162
162
  #
163
163
  #
@@ -176,22 +176,22 @@ module Google
176
176
  # The [token bucket](https://wikipedia.org/wiki/Token_Bucket)
177
177
  # algorithm is used to control the rate of task dispatches. Each
178
178
  # queue has a token bucket that holds tokens, up to the maximum
179
- # specified by +max_burst_size+. Each time a task is dispatched, a
179
+ # specified by `max_burst_size`. Each time a task is dispatched, a
180
180
  # token is removed from the bucket. Tasks will be dispatched until
181
181
  # the queue's bucket runs out of tokens. The bucket will be
182
182
  # continuously refilled with new tokens based on
183
183
  # {Google::Cloud::Tasks::V2beta2::RateLimits#max_tasks_dispatched_per_second max_tasks_dispatched_per_second}.
184
184
  #
185
- # Cloud Tasks will pick the value of +max_burst_size+ based on the
185
+ # Cloud Tasks will pick the value of `max_burst_size` based on the
186
186
  # value of
187
187
  # {Google::Cloud::Tasks::V2beta2::RateLimits#max_tasks_dispatched_per_second max_tasks_dispatched_per_second}.
188
188
  #
189
189
  # For App Engine queues that were created or updated using
190
- # +queue.yaml/xml+, +max_burst_size+ is equal to
190
+ # `queue.yaml/xml`, `max_burst_size` is equal to
191
191
  # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
192
- # Since +max_burst_size+ is output only, if
192
+ # Since `max_burst_size` is output only, if
193
193
  # {Google::Cloud::Tasks::V2beta2::CloudTasks::UpdateQueue UpdateQueue} is called on a queue
194
- # created by +queue.yaml/xml+, +max_burst_size+ will be reset based
194
+ # created by `queue.yaml/xml`, `max_burst_size` will be reset based
195
195
  # on the value of
196
196
  # {Google::Cloud::Tasks::V2beta2::RateLimits#max_tasks_dispatched_per_second max_tasks_dispatched_per_second},
197
197
  # regardless of whether
@@ -212,7 +212,7 @@ module Google
212
212
  #
213
213
  # This field is output only for
214
214
  # {Google::Cloud::Tasks::V2beta2::PullTarget pull queues} and always -1, which indicates no limit. No other
215
- # queue types can have +max_concurrent_tasks+ set to -1.
215
+ # queue types can have `max_concurrent_tasks` set to -1.
216
216
  #
217
217
  #
218
218
  # This field has the same meaning as
@@ -226,17 +226,17 @@ module Google
226
226
  # @return [Integer]
227
227
  # The maximum number of attempts for a task.
228
228
  #
229
- # Cloud Tasks will attempt the task +max_attempts+ times (that
229
+ # Cloud Tasks will attempt the task `max_attempts` times (that
230
230
  # is, if the first attempt fails, then there will be
231
- # +max_attempts - 1+ retries). Must be > 0.
231
+ # `max_attempts - 1` retries). Must be > 0.
232
232
  # @!attribute [rw] unlimited_attempts
233
233
  # @return [true, false]
234
234
  # If true, then the number of attempts is unlimited.
235
235
  # @!attribute [rw] max_retry_duration
236
236
  # @return [Google::Protobuf::Duration]
237
- # If positive, +max_retry_duration+ specifies the time limit for
237
+ # If positive, `max_retry_duration` specifies the time limit for
238
238
  # retrying a failed task, measured from when the task was first
239
- # attempted. Once +max_retry_duration+ time has passed *and* the
239
+ # attempted. Once `max_retry_duration` time has passed *and* the
240
240
  # task has been attempted {Google::Cloud::Tasks::V2beta2::RetryConfig#max_attempts max_attempts}
241
241
  # times, no further attempts will be made and the task will be
242
242
  # deleted.
@@ -249,7 +249,7 @@ module Google
249
249
  # This field is output only for {Google::Cloud::Tasks::V2beta2::PullTarget pull queues}.
250
250
  #
251
251
  #
252
- # +max_retry_duration+ will be truncated to the nearest second.
252
+ # `max_retry_duration` will be truncated to the nearest second.
253
253
  #
254
254
  # This field has the same meaning as
255
255
  # [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
@@ -267,7 +267,7 @@ module Google
267
267
  # This field is output only for {Google::Cloud::Tasks::V2beta2::PullTarget pull queues}.
268
268
  #
269
269
  #
270
- # +min_backoff+ will be truncated to the nearest second.
270
+ # `min_backoff` will be truncated to the nearest second.
271
271
  #
272
272
  # This field has the same meaning as
273
273
  # [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
@@ -285,24 +285,24 @@ module Google
285
285
  # This field is output only for {Google::Cloud::Tasks::V2beta2::PullTarget pull queues}.
286
286
  #
287
287
  #
288
- # +max_backoff+ will be truncated to the nearest second.
288
+ # `max_backoff` will be truncated to the nearest second.
289
289
  #
290
290
  # This field has the same meaning as
291
291
  # [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
292
292
  # @!attribute [rw] max_doublings
293
293
  # @return [Integer]
294
- # The time between retries will double +max_doublings+ times.
294
+ # The time between retries will double `max_doublings` times.
295
295
  #
296
296
  # A task's retry interval starts at
297
297
  # {Google::Cloud::Tasks::V2beta2::RetryConfig#min_backoff min_backoff}, then doubles
298
- # +max_doublings+ times, then increases linearly, and finally
298
+ # `max_doublings` times, then increases linearly, and finally
299
299
  # retries retries at intervals of
300
300
  # {Google::Cloud::Tasks::V2beta2::RetryConfig#max_backoff max_backoff} up to
301
301
  # {Google::Cloud::Tasks::V2beta2::RetryConfig#max_attempts max_attempts} times.
302
302
  #
303
303
  # For example, if {Google::Cloud::Tasks::V2beta2::RetryConfig#min_backoff min_backoff} is 10s,
304
304
  # {Google::Cloud::Tasks::V2beta2::RetryConfig#max_backoff max_backoff} is 300s, and
305
- # +max_doublings+ is 3, then the a task will first be retried in
305
+ # `max_doublings` is 3, then the a task will first be retried in
306
306
  # 10s. The retry interval will double three times, and then
307
307
  # increase linearly by 2^3 * 10s. Finally, the task will retry at
308
308
  # intervals of {Google::Cloud::Tasks::V2beta2::RetryConfig#max_backoff max_backoff} until the
data/lib/google/cloud/tasks/v2beta2/doc/google/cloud/tasks/v2beta2/target.rb CHANGED
@@ -58,17 +58,17 @@ module Google
58
58
  # task's host URL is constructed.
59
59
  #
60
60
  # Using {Google::Cloud::Tasks::V2beta2::AppEngineHttpTarget AppEngineHttpTarget} requires
61
- # [+appengine.applications.get+](https://cloud.google.com/appengine/docs/admin-api/access-control)
61
+ # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
62
62
  # Google IAM permission for the project
63
63
  # and the following scope:
64
64
  #
65
- # +https://www.googleapis.com/auth/cloud-platform+
65
+ # `https://www.googleapis.com/auth/cloud-platform`
66
66
  # @!attribute [rw] app_engine_routing_override
67
67
  # @return [Google::Cloud::Tasks::V2beta2::AppEngineRouting]
68
68
  # Overrides for the
69
69
  # {Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest#app_engine_routing task-level app_engine_routing}.
70
70
  #
71
- # If set, +app_engine_routing_override+ is used for all tasks in
71
+ # If set, `app_engine_routing_override` is used for all tasks in
72
72
  # the queue, no matter what the setting is for the
73
73
  # {Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest#app_engine_routing task-level app_engine_routing}.
74
74
  class AppEngineHttpTarget; end
@@ -82,11 +82,11 @@ module Google
82
82
  # {Google::Cloud::Tasks::V2beta2::Queue#app_engine_http_target app_engine_http_target} set.
83
83
  #
84
84
  # Using {Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest AppEngineHttpRequest} requires
85
- # [+appengine.applications.get+](https://cloud.google.com/appengine/docs/admin-api/access-control)
85
+ # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
86
86
  # Google IAM permission for the project
87
87
  # and the following scope:
88
88
  #
89
- # +https://www.googleapis.com/auth/cloud-platform+
89
+ # `https://www.googleapis.com/auth/cloud-platform`
90
90
  #
91
91
  # The task will be delivered to the App Engine app which belongs to the same
92
92
  # project as the queue. For more information, see
@@ -104,15 +104,15 @@ module Google
104
104
  # {Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest#app_engine_routing task-level app_engine_routing}.
105
105
  #
106
106
  #
107
- # The +url+ that the task will be sent to is:
107
+ # The `url` that the task will be sent to is:
108
108
  #
109
- # * +url =+ {Google::Cloud::Tasks::V2beta2::AppEngineRouting#host host} +++
109
+ # * `url =` {Google::Cloud::Tasks::V2beta2::AppEngineRouting#host host} `+`
110
110
  # {Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest#relative_url relative_url}
111
111
  #
112
112
  # The task attempt has succeeded if the app's request handler returns
113
- # an HTTP response code in the range [+200+ - +299+]. +503+ is
113
+ # an HTTP response code in the range [`200` - `299`]. `503` is
114
114
  # considered an App Engine system error instead of an application
115
- # error. Requests returning error +503+ will be retried regardless of
115
+ # error. Requests returning error `503` will be retried regardless of
116
116
  # retry configuration and not counted against retry counts.
117
117
  # Any other response code or a failure to receive a response before the
118
118
  # deadline is a failed attempt.
@@ -154,28 +154,28 @@ module Google
154
154
  #
155
155
  # Cloud Tasks sets some headers to default values:
156
156
  #
157
- # * +User-Agent+: By default, this header is
158
- # +"AppEngine-Google; (+http://code.google.com/appengine)"+.
157
+ # * `User-Agent`: By default, this header is
158
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"`.
159
159
  # This header can be modified, but Cloud Tasks will append
160
- # +"AppEngine-Google; (+http://code.google.com/appengine)"+ to the
161
- # modified +User-Agent+.
160
+ # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
161
+ # modified `User-Agent`.
162
162
  #
163
163
  # If the task has a {Google::Cloud::Tasks::V2beta2::AppEngineHttpRequest#payload payload}, Cloud
164
164
  # Tasks sets the following headers:
165
165
  #
166
- # * +Content-Type+: By default, the +Content-Type+ header is set to
167
- # +"application/octet-stream"+. The default can be overridden by explicitly
168
- # setting +Content-Type+ to a particular media type when the
166
+ # * `Content-Type`: By default, the `Content-Type` header is set to
167
+ # `"application/octet-stream"`. The default can be overridden by explicitly
168
+ # setting `Content-Type` to a particular media type when the
169
169
  # {Google::Cloud::Tasks::V2beta2::CloudTasks::CreateTask task is created}.
170
- # For example, +Content-Type+ can be set to +"application/json"+.
171
- # * +Content-Length+: This is computed by Cloud Tasks. This value is
170
+ # For example, `Content-Type` can be set to `"application/json"`.
171
+ # * `Content-Length`: This is computed by Cloud Tasks. This value is
172
172
  # output only. It cannot be changed.
173
173
  #
174
174
  # The headers below cannot be set or overridden:
175
175
  #
176
- # * +Host+
177
- # * +X-Google-*+
178
- # * +X-AppEngine-*+
176
+ # * `Host`
177
+ # * `X-Google-*`
178
+ # * `X-AppEngine-*`
179
179
  #
180
180
  # In addition, Cloud Tasks sets some headers when the task is dispatched,
181
181
  # such as headers containing information about the task; see
@@ -261,41 +261,41 @@ module Google
261
261
  # The host is constructed as:
262
262
  #
263
263
  #
264
- # * +host = [application_domain_name]+</br>
265
- # +| [service] + '.' + [application_domain_name]+</br>
266
- # +| [version] + '.' + [application_domain_name]+</br>
267
- # +| [version_dot_service]+ '.' + [application_domain_name]+</br>
268
- # +| [instance] + '.' + [application_domain_name]+</br>
269
- # +| [instance_dot_service] + '.' + [application_domain_name]+</br>
270
- # +| [instance_dot_version] + '.' + [application_domain_name]+</br>
271
- # +| [instance_dot_version_dot_service] + '.' + [application_domain_name]+
264
+ # * `host = [application_domain_name]`</br>
265
+ # `| [service] + '.' + [application_domain_name]`</br>
266
+ # `| [version] + '.' + [application_domain_name]`</br>
267
+ # `| [version_dot_service]+ '.' + [application_domain_name]`</br>
268
+ # `| [instance] + '.' + [application_domain_name]`</br>
269
+ # `| [instance_dot_service] + '.' + [application_domain_name]`</br>
270
+ # `| [instance_dot_version] + '.' + [application_domain_name]`</br>
271
+ # `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
272
272
  #
273
- # * +application_domain_name+ = The domain name of the app, for
273
+ # * `application_domain_name` = The domain name of the app, for
274
274
  # example <app-id>.appspot.com, which is associated with the
275
275
  # queue's project ID. Some tasks which were created using the App Engine
276
276
  # SDK use a custom domain name.
277
277
  #
278
- # * +service =+ {Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service}
278
+ # * `service =` {Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service}
279
279
  #
280
- # * +version =+ {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version}
280
+ # * `version =` {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version}
281
281
  #
282
- # * +version_dot_service =+
283
- # {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version} ++ '.' ++
282
+ # * `version_dot_service =`
283
+ # {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version} `+ '.' +`
284
284
  # {Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service}
285
285
  #
286
- # * +instance =+ {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance}
286
+ # * `instance =` {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance}
287
287
  #
288
- # * +instance_dot_service =+
289
- # {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} ++ '.' ++
288
+ # * `instance_dot_service =`
289
+ # {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} `+ '.' +`
290
290
  # {Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service}
291
291
  #
292
- # * +instance_dot_version =+
293
- # {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} ++ '.' ++
292
+ # * `instance_dot_version =`
293
+ # {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} `+ '.' +`
294
294
  # {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version}
295
295
  #
296
- # * +instance_dot_version_dot_service =+
297
- # {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} ++ '.' ++
298
- # {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version} ++ '.' ++
296
+ # * `instance_dot_version_dot_service =`
297
+ # {Google::Cloud::Tasks::V2beta2::AppEngineRouting#instance instance} `+ '.' +`
298
+ # {Google::Cloud::Tasks::V2beta2::AppEngineRouting#version version} `+ '.' +`
299
299
  # {Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service}
300
300
  #
301
301
  # If {Google::Cloud::Tasks::V2beta2::AppEngineRouting#service service} is empty, then the task will be sent