google-cloud-tasks 0.6.0 → 0.7.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.
Files changed (12) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/tasks/v2beta3/cloud_tasks_client.rb +104 -123
  3. data/lib/google/cloud/tasks/v2beta3/cloudtasks_pb.rb +4 -3
  4. data/lib/google/cloud/tasks/v2beta3/cloudtasks_services_pb.rb +38 -50
  5. data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/cloudtasks.rb +92 -116
  6. data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/queue.rb +55 -67
  7. data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/target.rb +95 -64
  8. data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/task.rb +17 -28
  9. data/lib/google/cloud/tasks/v2beta3/queue_pb.rb +2 -0
  10. data/lib/google/cloud/tasks/v2beta3/target_pb.rb +14 -0
  11. data/lib/google/cloud/tasks/v2beta3/task_pb.rb +1 -0
  12. metadata +22 -2
data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/cloudtasks.rb CHANGED
@@ -17,8 +17,7 @@ module Google
17
17
  module Cloud
18
18
  module Tasks
19
19
  module V2beta3
20
- # Request message for
21
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::ListQueues ListQueues}.
20
+ # Request message for {Google::Cloud::Tasks::V2beta3::CloudTasks::ListQueues ListQueues}.
22
21
  # @!attribute [rw] parent
23
22
  # @return [String]
24
23
  # Required.
@@ -27,11 +26,11 @@ module Google
27
26
  # For example: `projects/PROJECT_ID/locations/LOCATION_ID`
28
27
  # @!attribute [rw] filter
29
28
  # @return [String]
30
- # `filter` can be used to specify a subset of queues. Any
31
- # {Google::Cloud::Tasks::V2beta3::Queue Queue} field can be used as a filter and
32
- # several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The
33
- # filter syntax is the same as described in [Stackdriver's Advanced Logs
34
- # Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
29
+ # `filter` can be used to specify a subset of queues. Any {Google::Cloud::Tasks::V2beta3::Queue Queue}
30
+ # field can be used as a filter and several operators as supported.
31
+ # For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
32
+ # described in
33
+ # [Stackdriver's Advanced Logs Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
35
34
  #
36
35
  # Sample filter "state: PAUSED".
37
36
  #
@@ -44,24 +43,21 @@ module Google
44
43
  # The maximum page size is 9800. If unspecified, the page size will
45
44
  # be the maximum. Fewer queues than requested might be returned,
46
45
  # even if more queues exist; use the
47
- # {Google::Cloud::Tasks::V2beta3::ListQueuesResponse#next_page_token next_page_token}
48
- # in the response to determine if more queues exist.
46
+ # {Google::Cloud::Tasks::V2beta3::ListQueuesResponse#next_page_token next_page_token} in the
47
+ # response to determine if more queues exist.
49
48
  # @!attribute [rw] page_token
50
49
  # @return [String]
51
50
  # A token identifying the page of results to return.
52
51
  #
53
52
  # To request the first page results, page_token must be empty. To
54
53
  # request the next page of results, page_token must be the value of
55
- # {Google::Cloud::Tasks::V2beta3::ListQueuesResponse#next_page_token next_page_token}
56
- # returned from the previous call to
57
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::ListQueues ListQueues} method. It
58
- # is an error to switch the value of the
59
- # {Google::Cloud::Tasks::V2beta3::ListQueuesRequest#filter filter} while
60
- # iterating through pages.
54
+ # {Google::Cloud::Tasks::V2beta3::ListQueuesResponse#next_page_token next_page_token} returned
55
+ # from the previous call to {Google::Cloud::Tasks::V2beta3::CloudTasks::ListQueues ListQueues}
56
+ # method. It is an error to switch the value of the
57
+ # {Google::Cloud::Tasks::V2beta3::ListQueuesRequest#filter filter} while iterating through pages.
61
58
  class ListQueuesRequest; end
62
59
 
63
- # Response message for
64
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::ListQueues ListQueues}.
60
+ # Response message for {Google::Cloud::Tasks::V2beta3::CloudTasks::ListQueues ListQueues}.
65
61
  # @!attribute [rw] queues
66
62
  # @return [Array<Google::Cloud::Tasks::V2beta3::Queue>]
67
63
  # The list of queues.
@@ -70,8 +66,7 @@ module Google
70
66
  # A token to retrieve next page of results.
71
67
  #
72
68
  # To return the next page of results, call
73
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::ListQueues ListQueues} with this
74
- # value as the
69
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::ListQueues ListQueues} with this value as the
75
70
  # {Google::Cloud::Tasks::V2beta3::ListQueuesRequest#page_token page_token}.
76
71
  #
77
72
  # If the next_page_token is empty, there are no more results.
@@ -79,8 +74,7 @@ module Google
79
74
  # The page token is valid for only 2 hours.
80
75
  class ListQueuesResponse; end
81
76
 
82
- # Request message for
83
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::GetQueue GetQueue}.
77
+ # Request message for {Google::Cloud::Tasks::V2beta3::CloudTasks::GetQueue GetQueue}.
84
78
  # @!attribute [rw] name
85
79
  # @return [String]
86
80
  # Required.
@@ -89,8 +83,7 @@ module Google
89
83
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
90
84
  class GetQueueRequest; end
91
85
 
92
- # Request message for
93
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::CreateQueue CreateQueue}.
86
+ # Request message for {Google::Cloud::Tasks::V2beta3::CloudTasks::CreateQueue CreateQueue}.
94
87
  # @!attribute [rw] parent
95
88
  # @return [String]
96
89
  # Required.
@@ -107,25 +100,21 @@ module Google
107
100
  #
108
101
  # The queue to create.
109
102
  #
110
- # {Google::Cloud::Tasks::V2beta3::Queue#name Queue's name} cannot be the same as
111
- # an existing queue.
103
+ # {Google::Cloud::Tasks::V2beta3::Queue#name Queue's name} cannot be the same as an existing queue.
112
104
  class CreateQueueRequest; end
113
105
 
114
- # Request message for
115
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::UpdateQueue UpdateQueue}.
106
+ # Request message for {Google::Cloud::Tasks::V2beta3::CloudTasks::UpdateQueue UpdateQueue}.
116
107
  # @!attribute [rw] queue
117
108
  # @return [Google::Cloud::Tasks::V2beta3::Queue]
118
109
  # Required.
119
110
  #
120
111
  # The queue to create or update.
121
112
  #
122
- # The queue's {Google::Cloud::Tasks::V2beta3::Queue#name name} must be
123
- # specified.
113
+ # The queue's {Google::Cloud::Tasks::V2beta3::Queue#name name} must be specified.
124
114
  #
125
115
  # Output only fields cannot be modified using UpdateQueue.
126
116
  # Any value specified for an output only field will be ignored.
127
- # The queue's {Google::Cloud::Tasks::V2beta3::Queue#name name} cannot be
128
- # changed.
117
+ # The queue's {Google::Cloud::Tasks::V2beta3::Queue#name name} cannot be changed.
129
118
  # @!attribute [rw] update_mask
130
119
  # @return [Google::Protobuf::FieldMask]
131
120
  # A mask used to specify which fields of the queue are being updated.
@@ -133,8 +122,7 @@ module Google
133
122
  # If empty, then all fields will be updated.
134
123
  class UpdateQueueRequest; end
135
124
 
136
- # Request message for
137
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::DeleteQueue DeleteQueue}.
125
+ # Request message for {Google::Cloud::Tasks::V2beta3::CloudTasks::DeleteQueue DeleteQueue}.
138
126
  # @!attribute [rw] name
139
127
  # @return [String]
140
128
  # Required.
@@ -143,8 +131,7 @@ module Google
143
131
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
144
132
  class DeleteQueueRequest; end
145
133
 
146
- # Request message for
147
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::PurgeQueue PurgeQueue}.
134
+ # Request message for {Google::Cloud::Tasks::V2beta3::CloudTasks::PurgeQueue PurgeQueue}.
148
135
  # @!attribute [rw] name
149
136
  # @return [String]
150
137
  # Required.
@@ -153,8 +140,7 @@ module Google
153
140
  # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
154
141
  class PurgeQueueRequest; end
155
142
 
156
- # Request message for
157
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::PauseQueue PauseQueue}.
143
+ # Request message for {Google::Cloud::Tasks::V2beta3::CloudTasks::PauseQueue PauseQueue}.
158
144
  # @!attribute [rw] name
159
145
  # @return [String]
160
146
  # Required.
@@ -163,8 +149,7 @@ module Google
163
149
  # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
164
150
  class PauseQueueRequest; end
165
151
 
166
- # Request message for
167
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::ResumeQueue ResumeQueue}.
152
+ # Request message for {Google::Cloud::Tasks::V2beta3::CloudTasks::ResumeQueue ResumeQueue}.
168
153
  # @!attribute [rw] name
169
154
  # @return [String]
170
155
  # Required.
@@ -173,8 +158,7 @@ module Google
173
158
  # `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
174
159
  class ResumeQueueRequest; end
175
160
 
176
- # Request message for listing tasks using
177
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::ListTasks ListTasks}.
161
+ # Request message for listing tasks using {Google::Cloud::Tasks::V2beta3::CloudTasks::ListTasks ListTasks}.
178
162
  # @!attribute [rw] parent
179
163
  # @return [String]
180
164
  # Required.
@@ -183,19 +167,18 @@ module Google
183
167
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
184
168
  # @!attribute [rw] response_view
185
169
  # @return [Google::Cloud::Tasks::V2beta3::Task::View]
186
- # The response_view specifies which subset of the
187
- # {Google::Cloud::Tasks::V2beta3::Task Task} will be returned.
188
- #
189
- # By default response_view is
190
- # {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all information is
191
- # retrieved by default because some data, such as payloads, might be
192
- # desirable to return only when needed because of its large size or because
193
- # of the sensitivity of data that it contains.
194
- #
195
- # Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}
196
- # requires `cloudtasks.tasks.fullView` [Google
197
- # IAM](https://cloud.google.com/iam/) permission on the
198
- # {Google::Cloud::Tasks::V2beta3::Task Task} resource.
170
+ # The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta3::Task Task} will be
171
+ # returned.
172
+ #
173
+ # By default response_view is {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all
174
+ # information is retrieved by default because some data, such as
175
+ # payloads, might be desirable to return only when needed because
176
+ # of its large size or because of the sensitivity of data that it
177
+ # contains.
178
+ #
179
+ # Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} requires
180
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
181
+ # permission on the {Google::Cloud::Tasks::V2beta3::Task Task} resource.
199
182
  # @!attribute [rw] page_size
200
183
  # @return [Integer]
201
184
  # Requested page size. Fewer tasks than requested might be returned.
@@ -203,23 +186,22 @@ module Google
203
186
  # The maximum page size is 1000. If unspecified, the page size will
204
187
  # be the maximum. Fewer tasks than requested might be returned,
205
188
  # even if more tasks exist; use
206
- # {Google::Cloud::Tasks::V2beta3::ListTasksResponse#next_page_token next_page_token}
207
- # in the response to determine if more tasks exist.
189
+ # {Google::Cloud::Tasks::V2beta3::ListTasksResponse#next_page_token next_page_token} in the
190
+ # response to determine if more tasks exist.
208
191
  # @!attribute [rw] page_token
209
192
  # @return [String]
210
193
  # A token identifying the page of results to return.
211
194
  #
212
195
  # To request the first page results, page_token must be empty. To
213
196
  # request the next page of results, page_token must be the value of
214
- # {Google::Cloud::Tasks::V2beta3::ListTasksResponse#next_page_token next_page_token}
215
- # returned from the previous call to
216
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::ListTasks ListTasks} method.
197
+ # {Google::Cloud::Tasks::V2beta3::ListTasksResponse#next_page_token next_page_token} returned
198
+ # from the previous call to {Google::Cloud::Tasks::V2beta3::CloudTasks::ListTasks ListTasks}
199
+ # method.
217
200
  #
218
201
  # The page token is valid for only 2 hours.
219
202
  class ListTasksRequest; end
220
203
 
221
- # Response message for listing tasks using
222
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::ListTasks ListTasks}.
204
+ # Response message for listing tasks using {Google::Cloud::Tasks::V2beta3::CloudTasks::ListTasks ListTasks}.
223
205
  # @!attribute [rw] tasks
224
206
  # @return [Array<Google::Cloud::Tasks::V2beta3::Task>]
225
207
  # The list of tasks.
@@ -228,15 +210,13 @@ module Google
228
210
  # A token to retrieve next page of results.
229
211
  #
230
212
  # To return the next page of results, call
231
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::ListTasks ListTasks} with this
232
- # value as the
213
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::ListTasks ListTasks} with this value as the
233
214
  # {Google::Cloud::Tasks::V2beta3::ListTasksRequest#page_token page_token}.
234
215
  #
235
216
  # If the next_page_token is empty, there are no more results.
236
217
  class ListTasksResponse; end
237
218
 
238
- # Request message for getting a task using
239
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::GetTask GetTask}.
219
+ # Request message for getting a task using {Google::Cloud::Tasks::V2beta3::CloudTasks::GetTask GetTask}.
240
220
  # @!attribute [rw] name
241
221
  # @return [String]
242
222
  # Required.
@@ -245,23 +225,21 @@ module Google
245
225
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
246
226
  # @!attribute [rw] response_view
247
227
  # @return [Google::Cloud::Tasks::V2beta3::Task::View]
248
- # The response_view specifies which subset of the
249
- # {Google::Cloud::Tasks::V2beta3::Task Task} will be returned.
250
- #
251
- # By default response_view is
252
- # {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all information is
253
- # retrieved by default because some data, such as payloads, might be
254
- # desirable to return only when needed because of its large size or because
255
- # of the sensitivity of data that it contains.
256
- #
257
- # Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}
258
- # requires `cloudtasks.tasks.fullView` [Google
259
- # IAM](https://cloud.google.com/iam/) permission on the
260
- # {Google::Cloud::Tasks::V2beta3::Task Task} resource.
228
+ # The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta3::Task Task} will be
229
+ # returned.
230
+ #
231
+ # By default response_view is {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all
232
+ # information is retrieved by default because some data, such as
233
+ # payloads, might be desirable to return only when needed because
234
+ # of its large size or because of the sensitivity of data that it
235
+ # contains.
236
+ #
237
+ # Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} requires
238
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
239
+ # permission on the {Google::Cloud::Tasks::V2beta3::Task Task} resource.
261
240
  class GetTaskRequest; end
262
241
 
263
- # Request message for
264
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::CreateTask CreateTask}.
242
+ # Request message for {Google::Cloud::Tasks::V2beta3::CloudTasks::CreateTask CreateTask}.
265
243
  # @!attribute [rw] parent
266
244
  # @return [String]
267
245
  # Required.
@@ -278,13 +256,13 @@ module Google
278
256
  #
279
257
  # Task names have the following format:
280
258
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
281
- # The user can optionally specify a task
282
- # {Google::Cloud::Tasks::V2beta3::Task#name name}. If a name is not specified
283
- # then the system will generate a random unique task id, which will be set in
284
- # the task returned in the {Google::Cloud::Tasks::V2beta3::Task#name response}.
259
+ # The user can optionally specify a task {Google::Cloud::Tasks::V2beta3::Task#name name}. If a
260
+ # name is not specified then the system will generate a random
261
+ # unique task id, which will be set in the task returned in the
262
+ # {Google::Cloud::Tasks::V2beta3::Task#name response}.
285
263
  #
286
- # If {Google::Cloud::Tasks::V2beta3::Task#schedule_time schedule_time} is not
287
- # set or is in the past then Cloud Tasks will set it to the current time.
264
+ # If {Google::Cloud::Tasks::V2beta3::Task#schedule_time schedule_time} is not set or is in the
265
+ # past then Cloud Tasks will set it to the current time.
288
266
  #
289
267
  # Task De-duplication:
290
268
  #
@@ -299,29 +277,28 @@ module Google
299
277
  # for ~9days after the original task was deleted or executed.
300
278
  #
301
279
  # Because there is an extra lookup cost to identify duplicate task
302
- # names, these {Google::Cloud::Tasks::V2beta3::CloudTasks::CreateTask CreateTask}
303
- # calls have significantly increased latency. Using hashed strings for the
304
- # task id or for the prefix of the task id is recommended. Choosing task ids
305
- # that are sequential or have sequential prefixes, for example using a
280
+ # names, these {Google::Cloud::Tasks::V2beta3::CloudTasks::CreateTask CreateTask} calls have significantly
281
+ # increased latency. Using hashed strings for the task id or for
282
+ # the prefix of the task id is recommended. Choosing task ids that
283
+ # are sequential or have sequential prefixes, for example using a
306
284
  # timestamp, causes an increase in latency and error rates in all
307
285
  # task commands. The infrastructure relies on an approximately
308
286
  # uniform distribution of task ids to store and serve tasks
309
287
  # efficiently.
310
288
  # @!attribute [rw] response_view
311
289
  # @return [Google::Cloud::Tasks::V2beta3::Task::View]
312
- # The response_view specifies which subset of the
313
- # {Google::Cloud::Tasks::V2beta3::Task Task} will be returned.
314
- #
315
- # By default response_view is
316
- # {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all information is
317
- # retrieved by default because some data, such as payloads, might be
318
- # desirable to return only when needed because of its large size or because
319
- # of the sensitivity of data that it contains.
320
- #
321
- # Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}
322
- # requires `cloudtasks.tasks.fullView` [Google
323
- # IAM](https://cloud.google.com/iam/) permission on the
324
- # {Google::Cloud::Tasks::V2beta3::Task Task} resource.
290
+ # The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta3::Task Task} will be
291
+ # returned.
292
+ #
293
+ # By default response_view is {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all
294
+ # information is retrieved by default because some data, such as
295
+ # payloads, might be desirable to return only when needed because
296
+ # of its large size or because of the sensitivity of data that it
297
+ # contains.
298
+ #
299
+ # Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} requires
300
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
301
+ # permission on the {Google::Cloud::Tasks::V2beta3::Task Task} resource.
325
302
  class CreateTaskRequest; end
326
303
 
327
304
  # Request message for deleting a task using
@@ -344,19 +321,18 @@ module Google
344
321
  # `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
345
322
  # @!attribute [rw] response_view
346
323
  # @return [Google::Cloud::Tasks::V2beta3::Task::View]
347
- # The response_view specifies which subset of the
348
- # {Google::Cloud::Tasks::V2beta3::Task Task} will be returned.
349
- #
350
- # By default response_view is
351
- # {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all information is
352
- # retrieved by default because some data, such as payloads, might be
353
- # desirable to return only when needed because of its large size or because
354
- # of the sensitivity of data that it contains.
355
- #
356
- # Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}
357
- # requires `cloudtasks.tasks.fullView` [Google
358
- # IAM](https://cloud.google.com/iam/) permission on the
359
- # {Google::Cloud::Tasks::V2beta3::Task Task} resource.
324
+ # The response_view specifies which subset of the {Google::Cloud::Tasks::V2beta3::Task Task} will be
325
+ # returned.
326
+ #
327
+ # By default response_view is {Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all
328
+ # information is retrieved by default because some data, such as
329
+ # payloads, might be desirable to return only when needed because
330
+ # of its large size or because of the sensitivity of data that it
331
+ # contains.
332
+ #
333
+ # Authorization for {Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL} requires
334
+ # `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
335
+ # permission on the {Google::Cloud::Tasks::V2beta3::Task Task} resource.
360
336
  class RunTaskRequest; end
361
337
  end
362
338
  end
data/lib/google/cloud/tasks/v2beta3/doc/google/cloud/tasks/v2beta3/queue.rb CHANGED
@@ -22,9 +22,8 @@ module Google
22
22
  # retry options, queue types, and others.
23
23
  # @!attribute [rw] name
24
24
  # @return [String]
25
- # Caller-specified and required in
26
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::CreateQueue CreateQueue}, after
27
- # which it becomes output only.
25
+ # Caller-specified and required in {Google::Cloud::Tasks::V2beta3::CloudTasks::CreateQueue CreateQueue},
26
+ # after which it becomes output only.
28
27
  #
29
28
  # The queue name.
30
29
  #
@@ -44,36 +43,31 @@ module Google
44
43
  # hyphens (-). The maximum length is 100 characters.
45
44
  # @!attribute [rw] app_engine_http_queue
46
45
  # @return [Google::Cloud::Tasks::V2beta3::AppEngineHttpQueue]
47
- # {Google::Cloud::Tasks::V2beta3::AppEngineHttpQueue AppEngineHttpQueue}
48
- # settings apply only to [App Engine
49
- # tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest] in this queue.
50
- # {Google::Cloud::Tasks::V2beta3::HttpRequest Http tasks} are not affected by
51
- # this proto.
46
+ # {Google::Cloud::Tasks::V2beta3::AppEngineHttpQueue AppEngineHttpQueue} settings apply only to
47
+ # {Google::Cloud::Tasks::V2beta3::AppEngineHttpRequest App Engine tasks} in this queue.
48
+ # {Google::Cloud::Tasks::V2beta3::HttpRequest Http tasks} are not affected by this proto.
52
49
  # @!attribute [rw] rate_limits
53
50
  # @return [Google::Cloud::Tasks::V2beta3::RateLimits]
54
51
  # Rate limits for task dispatches.
55
52
  #
56
- # {Google::Cloud::Tasks::V2beta3::Queue#rate_limits rate_limits} and
57
- # {Google::Cloud::Tasks::V2beta3::Queue#retry_config retry_config} are related
58
- # because they both control task attempts. However they control task attempts
59
- # in different ways:
53
+ # {Google::Cloud::Tasks::V2beta3::Queue#rate_limits rate_limits} and {Google::Cloud::Tasks::V2beta3::Queue#retry_config retry_config} are
54
+ # related because they both control task attempts. However they control task
55
+ # attempts in different ways:
60
56
  #
61
- # * {Google::Cloud::Tasks::V2beta3::Queue#rate_limits rate_limits} controls the
62
- # total rate of
57
+ # * {Google::Cloud::Tasks::V2beta3::Queue#rate_limits rate_limits} controls the total rate of
63
58
  # dispatches from a queue (i.e. all traffic dispatched from the
64
59
  # queue, regardless of whether the dispatch is from a first
65
60
  # attempt or a retry).
66
- # * {Google::Cloud::Tasks::V2beta3::Queue#retry_config retry_config} controls
67
- # what happens to
61
+ # * {Google::Cloud::Tasks::V2beta3::Queue#retry_config retry_config} controls what happens to
68
62
  # particular a task after its first attempt fails. That is,
69
- # {Google::Cloud::Tasks::V2beta3::Queue#retry_config retry_config} controls
70
- # task retries (the second attempt, third attempt, etc).
63
+ # {Google::Cloud::Tasks::V2beta3::Queue#retry_config retry_config} controls task retries (the
64
+ # second attempt, third attempt, etc).
71
65
  #
72
66
  # The queue's actual dispatch rate is the result of:
73
67
  #
74
68
  # * Number of tasks in the queue
75
- # * User-specified throttling: {Queue::RateLimits rate limits}
76
- # {Queue::RetryConfig retry configuration}, and the
69
+ # * User-specified throttling: {Google::Cloud::Tasks::V2beta3::Queue#rate_limits rate_limits},
70
+ # {Google::Cloud::Tasks::V2beta3::Queue#retry_config retry_config}, and the
77
71
  # {Google::Cloud::Tasks::V2beta3::Queue#state queue's state}.
78
72
  # * System throttling due to `429` (Too Many Requests) or `503` (Service
79
73
  # Unavailable) responses from the worker, high error rates, or to smooth
@@ -96,25 +90,28 @@ module Google
96
90
  #
97
91
  # `state` can only be changed by called
98
92
  # {Google::Cloud::Tasks::V2beta3::CloudTasks::PauseQueue PauseQueue},
99
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::ResumeQueue ResumeQueue}, or
100
- # uploading
93
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::ResumeQueue ResumeQueue}, or uploading
101
94
  # [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref).
102
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::UpdateQueue UpdateQueue} cannot be
103
- # used to change `state`.
95
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::UpdateQueue UpdateQueue} cannot be used to change `state`.
104
96
  # @!attribute [rw] purge_time
105
97
  # @return [Google::Protobuf::Timestamp]
106
98
  # Output only. The last time this queue was purged.
107
99
  #
108
- # All tasks that were {Google::Cloud::Tasks::V2beta3::Task#create_time created}
109
- # before this time were purged.
100
+ # All tasks that were {Google::Cloud::Tasks::V2beta3::Task#create_time created} before this time
101
+ # were purged.
110
102
  #
111
- # A queue can be purged using
112
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::PurgeQueue PurgeQueue}, the [App
113
- # Engine Task Queue SDK, or the Cloud
103
+ # A queue can be purged using {Google::Cloud::Tasks::V2beta3::CloudTasks::PurgeQueue PurgeQueue}, the
104
+ # [App Engine Task Queue SDK, or the Cloud
114
105
  # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
115
106
  #
116
107
  # Purge time will be truncated to the nearest microsecond. Purge
117
108
  # time will be unset if the queue has never been purged.
109
+ # @!attribute [rw] log_sampling_ratio
110
+ # @return [Float]
111
+ # Specifies the fraction of operations to write to
112
+ # [Stackdriver Logging](https://cloud.google.com/logging/docs/).
113
+ # This field may contain any value between 0.0 and 1.0, inclusive.
114
+ # 0.0 is the default and means that no operations are logged.
118
115
  class Queue
119
116
  # State of the queue.
120
117
  module State
@@ -159,10 +156,8 @@ module Google
159
156
  # This message determines the maximum rate that tasks can be dispatched by a
160
157
  # queue, regardless of whether the dispatch is a first task attempt or a retry.
161
158
  #
162
- # Note: The debugging command,
163
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::RunTask RunTask}, will run a task
164
- # even if the queue has reached its
165
- # {Google::Cloud::Tasks::V2beta3::RateLimits RateLimits}.
159
+ # Note: The debugging command, {Google::Cloud::Tasks::V2beta3::CloudTasks::RunTask RunTask}, will run a task
160
+ # even if the queue has reached its {Google::Cloud::Tasks::V2beta3::RateLimits RateLimits}.
166
161
  # @!attribute [rw] max_dispatches_per_second
167
162
  # @return [Float]
168
163
  # The maximum rate at which tasks are dispatched from this queue.
@@ -170,8 +165,7 @@ module Google
170
165
  # If unspecified when the queue is created, Cloud Tasks will pick the
171
166
  # default.
172
167
  #
173
- # * For {Google::Cloud::Tasks::V2beta3::AppEngineHttpQueue App Engine queues},
174
- # the maximum allowed value
168
+ # * For {Google::Cloud::Tasks::V2beta3::AppEngineHttpQueue App Engine queues}, the maximum allowed value
175
169
  # is 500.
176
170
  #
177
171
  #
@@ -205,9 +199,9 @@ module Google
205
199
  # `queue.yaml/xml`, `max_burst_size` is equal to
206
200
  # [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size).
207
201
  # Since `max_burst_size` is output only, if
208
- # {Google::Cloud::Tasks::V2beta3::CloudTasks::UpdateQueue UpdateQueue} is called
209
- # on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset
210
- # based on the value of
202
+ # {Google::Cloud::Tasks::V2beta3::CloudTasks::UpdateQueue UpdateQueue} is called on a queue
203
+ # created by `queue.yaml/xml`, `max_burst_size` will be reset based
204
+ # on the value of
211
205
  # {Google::Cloud::Tasks::V2beta3::RateLimits#max_dispatches_per_second max_dispatches_per_second},
212
206
  # regardless of whether
213
207
  # {Google::Cloud::Tasks::V2beta3::RateLimits#max_dispatches_per_second max_dispatches_per_second}
@@ -255,9 +249,9 @@ module Google
255
249
  # If positive, `max_retry_duration` specifies the time limit for
256
250
  # retrying a failed task, measured from when the task was first
257
251
  # attempted. Once `max_retry_duration` time has passed *and* the
258
- # task has been attempted
259
- # {Google::Cloud::Tasks::V2beta3::RetryConfig#max_attempts max_attempts} times,
260
- # no further attempts will be made and the task will be deleted.
252
+ # task has been attempted {Google::Cloud::Tasks::V2beta3::RetryConfig#max_attempts max_attempts}
253
+ # times, no further attempts will be made and the task will be
254
+ # deleted.
261
255
  #
262
256
  # If zero, then the task age is unlimited.
263
257
  #
@@ -272,13 +266,11 @@ module Google
272
266
  # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
273
267
  # @!attribute [rw] min_backoff
274
268
  # @return [Google::Protobuf::Duration]
275
- # A task will be {Google::Cloud::Tasks::V2beta3::Task#schedule_time scheduled}
276
- # for retry between
269
+ # A task will be {Google::Cloud::Tasks::V2beta3::Task#schedule_time scheduled} for retry between
277
270
  # {Google::Cloud::Tasks::V2beta3::RetryConfig#min_backoff min_backoff} and
278
- # {Google::Cloud::Tasks::V2beta3::RetryConfig#max_backoff max_backoff} duration
279
- # after it fails, if the queue's
280
- # {Google::Cloud::Tasks::V2beta3::RetryConfig RetryConfig} specifies that the
281
- # task should be retried.
271
+ # {Google::Cloud::Tasks::V2beta3::RetryConfig#max_backoff max_backoff} duration after it fails,
272
+ # if the queue's {Google::Cloud::Tasks::V2beta3::RetryConfig RetryConfig} specifies that the task should be
273
+ # retried.
282
274
  #
283
275
  # If unspecified when the queue is created, Cloud Tasks will pick the
284
276
  # default.
@@ -291,13 +283,11 @@ module Google
291
283
  # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
292
284
  # @!attribute [rw] max_backoff
293
285
  # @return [Google::Protobuf::Duration]
294
- # A task will be {Google::Cloud::Tasks::V2beta3::Task#schedule_time scheduled}
295
- # for retry between
286
+ # A task will be {Google::Cloud::Tasks::V2beta3::Task#schedule_time scheduled} for retry between
296
287
  # {Google::Cloud::Tasks::V2beta3::RetryConfig#min_backoff min_backoff} and
297
- # {Google::Cloud::Tasks::V2beta3::RetryConfig#max_backoff max_backoff} duration
298
- # after it fails, if the queue's
299
- # {Google::Cloud::Tasks::V2beta3::RetryConfig RetryConfig} specifies that the
300
- # task should be retried.
288
+ # {Google::Cloud::Tasks::V2beta3::RetryConfig#max_backoff max_backoff} duration after it fails,
289
+ # if the queue's {Google::Cloud::Tasks::V2beta3::RetryConfig RetryConfig} specifies that the task should be
290
+ # retried.
301
291
  #
302
292
  # If unspecified when the queue is created, Cloud Tasks will pick the
303
293
  # default.
@@ -313,23 +303,21 @@ module Google
313
303
  # The time between retries will double `max_doublings` times.
314
304
  #
315
305
  # A task's retry interval starts at
316
- # {Google::Cloud::Tasks::V2beta3::RetryConfig#min_backoff min_backoff}, then
317
- # doubles `max_doublings` times, then increases linearly, and finally retries
318
- # retries at intervals of
306
+ # {Google::Cloud::Tasks::V2beta3::RetryConfig#min_backoff min_backoff}, then doubles
307
+ # `max_doublings` times, then increases linearly, and finally
308
+ # retries retries at intervals of
319
309
  # {Google::Cloud::Tasks::V2beta3::RetryConfig#max_backoff max_backoff} up to
320
310
  # {Google::Cloud::Tasks::V2beta3::RetryConfig#max_attempts max_attempts} times.
321
311
  #
322
- # For example, if
323
- # {Google::Cloud::Tasks::V2beta3::RetryConfig#min_backoff min_backoff} is 10s,
324
- # {Google::Cloud::Tasks::V2beta3::RetryConfig#max_backoff max_backoff} is 300s,
325
- # and `max_doublings` is 3, then the a task will first be retried in 10s. The
326
- # retry interval will double three times, and then increase linearly by 2^3 *
327
- # 10s. Finally, the task will retry at intervals of
328
- # {Google::Cloud::Tasks::V2beta3::RetryConfig#max_backoff max_backoff} until the
329
- # task has been attempted
330
- # {Google::Cloud::Tasks::V2beta3::RetryConfig#max_attempts max_attempts} times.
331
- # Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s,
332
- # 300s, ....
312
+ # For example, if {Google::Cloud::Tasks::V2beta3::RetryConfig#min_backoff min_backoff} is 10s,
313
+ # {Google::Cloud::Tasks::V2beta3::RetryConfig#max_backoff max_backoff} is 300s, and
314
+ # `max_doublings` is 3, then the a task will first be retried in
315
+ # 10s. The retry interval will double three times, and then
316
+ # increase linearly by 2^3 * 10s. Finally, the task will retry at
317
+ # intervals of {Google::Cloud::Tasks::V2beta3::RetryConfig#max_backoff max_backoff} until the
318
+ # task has been attempted {Google::Cloud::Tasks::V2beta3::RetryConfig#max_attempts max_attempts}
319
+ # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s,
320
+ # 240s, 300s, 300s, ....
333
321
  #
334
322
  # If unspecified when the queue is created, Cloud Tasks will pick the
335
323
  # default.