google-cloud-tasks-v2beta3 0.10.1 → 0.10.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/google/cloud/tasks/v2beta3/bindings_override.rb +102 -0
- data/lib/google/cloud/tasks/v2beta3/cloud_tasks/client.rb +255 -108
- data/lib/google/cloud/tasks/v2beta3/cloud_tasks/rest/client.rb +243 -114
- data/lib/google/cloud/tasks/v2beta3/cloud_tasks/rest/service_stub.rb +61 -0
- data/lib/google/cloud/tasks/v2beta3/cloud_tasks/rest.rb +1 -0
- data/lib/google/cloud/tasks/v2beta3/cloudtasks_pb.rb +5 -1
- data/lib/google/cloud/tasks/v2beta3/cloudtasks_services_pb.rb +49 -30
- data/lib/google/cloud/tasks/v2beta3/queue_pb.rb +1 -1
- data/lib/google/cloud/tasks/v2beta3/rest.rb +1 -0
- data/lib/google/cloud/tasks/v2beta3/target_pb.rb +9 -1
- data/lib/google/cloud/tasks/v2beta3/version.rb +1 -1
- data/proto_docs/google/api/httpbody.rb +80 -0
- data/proto_docs/google/cloud/tasks/v2beta3/cloudtasks.rb +155 -99
- data/proto_docs/google/cloud/tasks/v2beta3/queue.rb +5 -2
- data/proto_docs/google/cloud/tasks/v2beta3/target.rb +199 -0
- data/proto_docs/google/cloud/tasks/v2beta3/task.rb +1 -1
- data/proto_docs/google/iam/v1/policy.rb +8 -4
- metadata +24 -2
@@ -21,18 +21,18 @@ module Google
|
|
21
21
|
module Cloud
|
22
22
|
module Tasks
|
23
23
|
module V2beta3
|
24
|
-
# Request message for
|
24
|
+
# Request message for
|
25
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#list_queues ListQueues}.
|
25
26
|
# @!attribute [rw] parent
|
26
27
|
# @return [::String]
|
27
28
|
# Required. The location name.
|
28
29
|
# For example: `projects/PROJECT_ID/locations/LOCATION_ID`
|
29
30
|
# @!attribute [rw] filter
|
30
31
|
# @return [::String]
|
31
|
-
# `filter` can be used to specify a subset of queues. Any
|
32
|
-
# field can be used as a filter and
|
33
|
-
# For example: `<=, <, >=, >, !=, =, :`. The
|
34
|
-
# described in
|
35
|
-
# [Stackdriver's Advanced Logs
|
32
|
+
# `filter` can be used to specify a subset of queues. Any
|
33
|
+
# {::Google::Cloud::Tasks::V2beta3::Queue Queue} field can be used as a filter and
|
34
|
+
# several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The
|
35
|
+
# filter syntax is the same as described in [Stackdriver's Advanced Logs
|
36
36
|
# Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
|
37
37
|
#
|
38
38
|
# Sample filter "state: PAUSED".
|
@@ -46,22 +46,24 @@ module Google
|
|
46
46
|
# The maximum page size is 9800. If unspecified, the page size will
|
47
47
|
# be the maximum. Fewer queues than requested might be returned,
|
48
48
|
# even if more queues exist; use the
|
49
|
-
# {::Google::Cloud::Tasks::V2beta3::ListQueuesResponse#next_page_token next_page_token}
|
50
|
-
# response to determine if more queues exist.
|
49
|
+
# {::Google::Cloud::Tasks::V2beta3::ListQueuesResponse#next_page_token next_page_token}
|
50
|
+
# in the response to determine if more queues exist.
|
51
51
|
# @!attribute [rw] page_token
|
52
52
|
# @return [::String]
|
53
53
|
# A token identifying the page of results to return.
|
54
54
|
#
|
55
55
|
# To request the first page results, page_token must be empty. To
|
56
56
|
# request the next page of results, page_token must be the value of
|
57
|
-
# {::Google::Cloud::Tasks::V2beta3::ListQueuesResponse#next_page_token next_page_token}
|
58
|
-
# from the previous call to
|
59
|
-
# method. It
|
60
|
-
#
|
57
|
+
# {::Google::Cloud::Tasks::V2beta3::ListQueuesResponse#next_page_token next_page_token}
|
58
|
+
# returned from the previous call to
|
59
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#list_queues ListQueues} method. It
|
60
|
+
# is an error to switch the value of the
|
61
|
+
# {::Google::Cloud::Tasks::V2beta3::ListQueuesRequest#filter filter} while
|
62
|
+
# iterating through pages.
|
61
63
|
# @!attribute [rw] read_mask
|
62
64
|
# @return [::Google::Protobuf::FieldMask]
|
63
|
-
# Optional. Read mask is used for a more granular control over what the API
|
64
|
-
# If the mask is not present all fields will be returned except
|
65
|
+
# Optional. Read mask is used for a more granular control over what the API
|
66
|
+
# returns. If the mask is not present all fields will be returned except
|
65
67
|
# [Queue.stats]. [Queue.stats] will be returned only if it was explicitly
|
66
68
|
# specified in the mask.
|
67
69
|
class ListQueuesRequest
|
@@ -69,7 +71,8 @@ module Google
|
|
69
71
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
70
72
|
end
|
71
73
|
|
72
|
-
# Response message for
|
74
|
+
# Response message for
|
75
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#list_queues ListQueues}.
|
73
76
|
# @!attribute [rw] queues
|
74
77
|
# @return [::Array<::Google::Cloud::Tasks::V2beta3::Queue>]
|
75
78
|
# The list of queues.
|
@@ -78,7 +81,8 @@ module Google
|
|
78
81
|
# A token to retrieve next page of results.
|
79
82
|
#
|
80
83
|
# To return the next page of results, call
|
81
|
-
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#list_queues ListQueues} with this
|
84
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#list_queues ListQueues} with this
|
85
|
+
# value as the
|
82
86
|
# {::Google::Cloud::Tasks::V2beta3::ListQueuesRequest#page_token page_token}.
|
83
87
|
#
|
84
88
|
# If the next_page_token is empty, there are no more results.
|
@@ -89,15 +93,16 @@ module Google
|
|
89
93
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
90
94
|
end
|
91
95
|
|
92
|
-
# Request message for
|
96
|
+
# Request message for
|
97
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#get_queue GetQueue}.
|
93
98
|
# @!attribute [rw] name
|
94
99
|
# @return [::String]
|
95
100
|
# Required. The resource name of the queue. For example:
|
96
101
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
97
102
|
# @!attribute [rw] read_mask
|
98
103
|
# @return [::Google::Protobuf::FieldMask]
|
99
|
-
# Optional. Read mask is used for a more granular control over what the API
|
100
|
-
# If the mask is not present all fields will be returned except
|
104
|
+
# Optional. Read mask is used for a more granular control over what the API
|
105
|
+
# returns. If the mask is not present all fields will be returned except
|
101
106
|
# [Queue.stats]. [Queue.stats] will be returned only if it was explicitly
|
102
107
|
# specified in the mask.
|
103
108
|
class GetQueueRequest
|
@@ -105,7 +110,8 @@ module Google
|
|
105
110
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
106
111
|
end
|
107
112
|
|
108
|
-
# Request message for
|
113
|
+
# Request message for
|
114
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#create_queue CreateQueue}.
|
109
115
|
# @!attribute [rw] parent
|
110
116
|
# @return [::String]
|
111
117
|
# Required. The location name in which the queue will be created.
|
@@ -113,27 +119,31 @@ module Google
|
|
113
119
|
#
|
114
120
|
# The list of allowed locations can be obtained by calling Cloud
|
115
121
|
# Tasks' implementation of
|
116
|
-
#
|
122
|
+
# `::Google::Cloud::Location::Locations::Client#list_locations`.
|
117
123
|
# @!attribute [rw] queue
|
118
124
|
# @return [::Google::Cloud::Tasks::V2beta3::Queue]
|
119
125
|
# Required. The queue to create.
|
120
126
|
#
|
121
|
-
# [Queue's name][google.cloud.tasks.v2beta3.Queue.name] cannot be the same as
|
127
|
+
# [Queue's name][google.cloud.tasks.v2beta3.Queue.name] cannot be the same as
|
128
|
+
# an existing queue.
|
122
129
|
class CreateQueueRequest
|
123
130
|
include ::Google::Protobuf::MessageExts
|
124
131
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
125
132
|
end
|
126
133
|
|
127
|
-
# Request message for
|
134
|
+
# Request message for
|
135
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#update_queue UpdateQueue}.
|
128
136
|
# @!attribute [rw] queue
|
129
137
|
# @return [::Google::Cloud::Tasks::V2beta3::Queue]
|
130
138
|
# Required. The queue to create or update.
|
131
139
|
#
|
132
|
-
# The queue's {::Google::Cloud::Tasks::V2beta3::Queue#name name} must be
|
140
|
+
# The queue's {::Google::Cloud::Tasks::V2beta3::Queue#name name} must be
|
141
|
+
# specified.
|
133
142
|
#
|
134
143
|
# Output only fields cannot be modified using UpdateQueue.
|
135
144
|
# Any value specified for an output only field will be ignored.
|
136
|
-
# The queue's {::Google::Cloud::Tasks::V2beta3::Queue#name name} cannot be
|
145
|
+
# The queue's {::Google::Cloud::Tasks::V2beta3::Queue#name name} cannot be
|
146
|
+
# changed.
|
137
147
|
# @!attribute [rw] update_mask
|
138
148
|
# @return [::Google::Protobuf::FieldMask]
|
139
149
|
# A mask used to specify which fields of the queue are being updated.
|
@@ -144,7 +154,8 @@ module Google
|
|
144
154
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
145
155
|
end
|
146
156
|
|
147
|
-
# Request message for
|
157
|
+
# Request message for
|
158
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#delete_queue DeleteQueue}.
|
148
159
|
# @!attribute [rw] name
|
149
160
|
# @return [::String]
|
150
161
|
# Required. The queue name. For example:
|
@@ -154,7 +165,8 @@ module Google
|
|
154
165
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
155
166
|
end
|
156
167
|
|
157
|
-
# Request message for
|
168
|
+
# Request message for
|
169
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#purge_queue PurgeQueue}.
|
158
170
|
# @!attribute [rw] name
|
159
171
|
# @return [::String]
|
160
172
|
# Required. The queue name. For example:
|
@@ -164,7 +176,8 @@ module Google
|
|
164
176
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
165
177
|
end
|
166
178
|
|
167
|
-
# Request message for
|
179
|
+
# Request message for
|
180
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#pause_queue PauseQueue}.
|
168
181
|
# @!attribute [rw] name
|
169
182
|
# @return [::String]
|
170
183
|
# Required. The queue name. For example:
|
@@ -174,7 +187,8 @@ module Google
|
|
174
187
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
175
188
|
end
|
176
189
|
|
177
|
-
# Request message for
|
190
|
+
# Request message for
|
191
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#resume_queue ResumeQueue}.
|
178
192
|
# @!attribute [rw] name
|
179
193
|
# @return [::String]
|
180
194
|
# Required. The queue name. For example:
|
@@ -184,32 +198,34 @@ module Google
|
|
184
198
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
185
199
|
end
|
186
200
|
|
187
|
-
# Request message for listing tasks using
|
201
|
+
# Request message for listing tasks using
|
202
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#list_tasks ListTasks}.
|
188
203
|
# @!attribute [rw] parent
|
189
204
|
# @return [::String]
|
190
205
|
# Required. The queue name. For example:
|
191
206
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
192
207
|
# @!attribute [rw] response_view
|
193
208
|
# @return [::Google::Cloud::Tasks::V2beta3::Task::View]
|
194
|
-
# The response_view specifies which subset of the
|
195
|
-
# returned.
|
196
|
-
#
|
197
|
-
# By default response_view is
|
198
|
-
#
|
199
|
-
#
|
200
|
-
#
|
201
|
-
# contains.
|
202
|
-
#
|
203
|
-
# Authorization for {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}
|
204
|
-
# `cloudtasks.tasks.fullView` [Google
|
205
|
-
# permission on the
|
209
|
+
# The response_view specifies which subset of the
|
210
|
+
# {::Google::Cloud::Tasks::V2beta3::Task Task} will be returned.
|
211
|
+
#
|
212
|
+
# By default response_view is
|
213
|
+
# {::Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all information is
|
214
|
+
# retrieved by default because some data, such as payloads, might be
|
215
|
+
# desirable to return only when needed because of its large size or because
|
216
|
+
# of the sensitivity of data that it contains.
|
217
|
+
#
|
218
|
+
# Authorization for {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}
|
219
|
+
# requires `cloudtasks.tasks.fullView` [Google
|
220
|
+
# IAM](https://cloud.google.com/iam/) permission on the
|
221
|
+
# {::Google::Cloud::Tasks::V2beta3::Task Task} resource.
|
206
222
|
# @!attribute [rw] page_size
|
207
223
|
# @return [::Integer]
|
208
224
|
# Maximum page size.
|
209
225
|
#
|
210
226
|
# Fewer tasks than requested might be returned, even if more tasks exist; use
|
211
|
-
# {::Google::Cloud::Tasks::V2beta3::ListTasksResponse#next_page_token next_page_token}
|
212
|
-
# determine if more tasks exist.
|
227
|
+
# {::Google::Cloud::Tasks::V2beta3::ListTasksResponse#next_page_token next_page_token}
|
228
|
+
# in the response to determine if more tasks exist.
|
213
229
|
#
|
214
230
|
# The maximum page size is 1000. If unspecified, the page size will be the
|
215
231
|
# maximum.
|
@@ -219,9 +235,9 @@ module Google
|
|
219
235
|
#
|
220
236
|
# To request the first page results, page_token must be empty. To
|
221
237
|
# request the next page of results, page_token must be the value of
|
222
|
-
# {::Google::Cloud::Tasks::V2beta3::ListTasksResponse#next_page_token next_page_token}
|
223
|
-
# from the previous call to
|
224
|
-
# method.
|
238
|
+
# {::Google::Cloud::Tasks::V2beta3::ListTasksResponse#next_page_token next_page_token}
|
239
|
+
# returned from the previous call to
|
240
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#list_tasks ListTasks} method.
|
225
241
|
#
|
226
242
|
# The page token is valid for only 2 hours.
|
227
243
|
class ListTasksRequest
|
@@ -229,7 +245,8 @@ module Google
|
|
229
245
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
230
246
|
end
|
231
247
|
|
232
|
-
# Response message for listing tasks using
|
248
|
+
# Response message for listing tasks using
|
249
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#list_tasks ListTasks}.
|
233
250
|
# @!attribute [rw] tasks
|
234
251
|
# @return [::Array<::Google::Cloud::Tasks::V2beta3::Task>]
|
235
252
|
# The list of tasks.
|
@@ -238,7 +255,8 @@ module Google
|
|
238
255
|
# A token to retrieve next page of results.
|
239
256
|
#
|
240
257
|
# To return the next page of results, call
|
241
|
-
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#list_tasks ListTasks} with this
|
258
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#list_tasks ListTasks} with this
|
259
|
+
# value as the
|
242
260
|
# {::Google::Cloud::Tasks::V2beta3::ListTasksRequest#page_token page_token}.
|
243
261
|
#
|
244
262
|
# If the next_page_token is empty, there are no more results.
|
@@ -247,31 +265,34 @@ module Google
|
|
247
265
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
248
266
|
end
|
249
267
|
|
250
|
-
# Request message for getting a task using
|
268
|
+
# Request message for getting a task using
|
269
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#get_task GetTask}.
|
251
270
|
# @!attribute [rw] name
|
252
271
|
# @return [::String]
|
253
272
|
# Required. The task name. For example:
|
254
273
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
255
274
|
# @!attribute [rw] response_view
|
256
275
|
# @return [::Google::Cloud::Tasks::V2beta3::Task::View]
|
257
|
-
# The response_view specifies which subset of the
|
258
|
-
# returned.
|
259
|
-
#
|
260
|
-
# By default response_view is
|
261
|
-
#
|
262
|
-
#
|
263
|
-
#
|
264
|
-
# contains.
|
265
|
-
#
|
266
|
-
# Authorization for {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}
|
267
|
-
# `cloudtasks.tasks.fullView` [Google
|
268
|
-
# permission on the
|
276
|
+
# The response_view specifies which subset of the
|
277
|
+
# {::Google::Cloud::Tasks::V2beta3::Task Task} will be returned.
|
278
|
+
#
|
279
|
+
# By default response_view is
|
280
|
+
# {::Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all information is
|
281
|
+
# retrieved by default because some data, such as payloads, might be
|
282
|
+
# desirable to return only when needed because of its large size or because
|
283
|
+
# of the sensitivity of data that it contains.
|
284
|
+
#
|
285
|
+
# Authorization for {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}
|
286
|
+
# requires `cloudtasks.tasks.fullView` [Google
|
287
|
+
# IAM](https://cloud.google.com/iam/) permission on the
|
288
|
+
# {::Google::Cloud::Tasks::V2beta3::Task Task} resource.
|
269
289
|
class GetTaskRequest
|
270
290
|
include ::Google::Protobuf::MessageExts
|
271
291
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
272
292
|
end
|
273
293
|
|
274
|
-
# Request message for
|
294
|
+
# Request message for
|
295
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#create_task CreateTask}.
|
275
296
|
# @!attribute [rw] parent
|
276
297
|
# @return [::String]
|
277
298
|
# Required. The queue name. For example:
|
@@ -284,13 +305,13 @@ module Google
|
|
284
305
|
#
|
285
306
|
# Task names have the following format:
|
286
307
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
|
287
|
-
# The user can optionally specify a task
|
288
|
-
# name
|
289
|
-
# unique task id, which will be set in
|
290
|
-
# {::Google::Cloud::Tasks::V2beta3::Task#name response}.
|
308
|
+
# The user can optionally specify a task
|
309
|
+
# {::Google::Cloud::Tasks::V2beta3::Task#name name}. If a name is not specified
|
310
|
+
# then the system will generate a random unique task id, which will be set in
|
311
|
+
# the task returned in the {::Google::Cloud::Tasks::V2beta3::Task#name response}.
|
291
312
|
#
|
292
|
-
# If {::Google::Cloud::Tasks::V2beta3::Task#schedule_time schedule_time} is not
|
293
|
-
# past then Cloud Tasks will set it to the current time.
|
313
|
+
# If {::Google::Cloud::Tasks::V2beta3::Task#schedule_time schedule_time} is not
|
314
|
+
# set or is in the past then Cloud Tasks will set it to the current time.
|
294
315
|
#
|
295
316
|
# Task De-duplication:
|
296
317
|
#
|
@@ -299,34 +320,35 @@ module Google
|
|
299
320
|
# that was deleted or executed recently then the call will fail
|
300
321
|
# with [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS].
|
301
322
|
# If the task's queue was created using Cloud Tasks, then another task with
|
302
|
-
# the same name can't be created for ~
|
323
|
+
# the same name can't be created for ~1 hour after the original task was
|
303
324
|
# deleted or executed. If the task's queue was created using queue.yaml or
|
304
325
|
# queue.xml, then another task with the same name can't be created
|
305
|
-
# for ~
|
326
|
+
# for ~9 days after the original task was deleted or executed.
|
306
327
|
#
|
307
328
|
# Because there is an extra lookup cost to identify duplicate task
|
308
|
-
# names, these {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#create_task CreateTask}
|
309
|
-
# increased latency. Using hashed strings for the
|
310
|
-
# the prefix of the task id is recommended. Choosing task ids
|
311
|
-
# are sequential or have sequential prefixes, for example using a
|
329
|
+
# names, these {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#create_task CreateTask}
|
330
|
+
# calls have significantly increased latency. Using hashed strings for the
|
331
|
+
# task id or for the prefix of the task id is recommended. Choosing task ids
|
332
|
+
# that are sequential or have sequential prefixes, for example using a
|
312
333
|
# timestamp, causes an increase in latency and error rates in all
|
313
334
|
# task commands. The infrastructure relies on an approximately
|
314
335
|
# uniform distribution of task ids to store and serve tasks
|
315
336
|
# efficiently.
|
316
337
|
# @!attribute [rw] response_view
|
317
338
|
# @return [::Google::Cloud::Tasks::V2beta3::Task::View]
|
318
|
-
# The response_view specifies which subset of the
|
319
|
-
# returned.
|
320
|
-
#
|
321
|
-
# By default response_view is
|
322
|
-
#
|
323
|
-
#
|
324
|
-
#
|
325
|
-
# contains.
|
326
|
-
#
|
327
|
-
# Authorization for {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}
|
328
|
-
# `cloudtasks.tasks.fullView` [Google
|
329
|
-
# permission on the
|
339
|
+
# The response_view specifies which subset of the
|
340
|
+
# {::Google::Cloud::Tasks::V2beta3::Task Task} will be returned.
|
341
|
+
#
|
342
|
+
# By default response_view is
|
343
|
+
# {::Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all information is
|
344
|
+
# retrieved by default because some data, such as payloads, might be
|
345
|
+
# desirable to return only when needed because of its large size or because
|
346
|
+
# of the sensitivity of data that it contains.
|
347
|
+
#
|
348
|
+
# Authorization for {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}
|
349
|
+
# requires `cloudtasks.tasks.fullView` [Google
|
350
|
+
# IAM](https://cloud.google.com/iam/) permission on the
|
351
|
+
# {::Google::Cloud::Tasks::V2beta3::Task Task} resource.
|
330
352
|
class CreateTaskRequest
|
331
353
|
include ::Google::Protobuf::MessageExts
|
332
354
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -351,22 +373,56 @@ module Google
|
|
351
373
|
# `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
|
352
374
|
# @!attribute [rw] response_view
|
353
375
|
# @return [::Google::Cloud::Tasks::V2beta3::Task::View]
|
354
|
-
# The response_view specifies which subset of the
|
355
|
-
# returned.
|
356
|
-
#
|
357
|
-
# By default response_view is
|
358
|
-
#
|
359
|
-
#
|
360
|
-
#
|
361
|
-
# contains.
|
362
|
-
#
|
363
|
-
# Authorization for {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}
|
364
|
-
# `cloudtasks.tasks.fullView` [Google
|
365
|
-
# permission on the
|
376
|
+
# The response_view specifies which subset of the
|
377
|
+
# {::Google::Cloud::Tasks::V2beta3::Task Task} will be returned.
|
378
|
+
#
|
379
|
+
# By default response_view is
|
380
|
+
# {::Google::Cloud::Tasks::V2beta3::Task::View::BASIC BASIC}; not all information is
|
381
|
+
# retrieved by default because some data, such as payloads, might be
|
382
|
+
# desirable to return only when needed because of its large size or because
|
383
|
+
# of the sensitivity of data that it contains.
|
384
|
+
#
|
385
|
+
# Authorization for {::Google::Cloud::Tasks::V2beta3::Task::View::FULL FULL}
|
386
|
+
# requires `cloudtasks.tasks.fullView` [Google
|
387
|
+
# IAM](https://cloud.google.com/iam/) permission on the
|
388
|
+
# {::Google::Cloud::Tasks::V2beta3::Task Task} resource.
|
366
389
|
class RunTaskRequest
|
367
390
|
include ::Google::Protobuf::MessageExts
|
368
391
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
369
392
|
end
|
393
|
+
|
394
|
+
# Request message for
|
395
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#buffer_task BufferTask}.
|
396
|
+
# @!attribute [rw] queue
|
397
|
+
# @return [::String]
|
398
|
+
# Required. The parent queue name. For example:
|
399
|
+
# projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
|
400
|
+
#
|
401
|
+
# The queue must already exist.
|
402
|
+
# @!attribute [rw] task_id
|
403
|
+
# @return [::String]
|
404
|
+
# Optional. Task ID for the task being created. If not provided, a random
|
405
|
+
# task ID is assigned to the task.
|
406
|
+
# @!attribute [rw] body
|
407
|
+
# @return [::Google::Api::HttpBody]
|
408
|
+
# Optional. Body of the HTTP request.
|
409
|
+
#
|
410
|
+
# The body can take any generic value. The value is written to the
|
411
|
+
# [HttpRequest][payload] of the [Task].
|
412
|
+
class BufferTaskRequest
|
413
|
+
include ::Google::Protobuf::MessageExts
|
414
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
415
|
+
end
|
416
|
+
|
417
|
+
# Response message for
|
418
|
+
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#buffer_task BufferTask}.
|
419
|
+
# @!attribute [rw] task
|
420
|
+
# @return [::Google::Cloud::Tasks::V2beta3::Task]
|
421
|
+
# The created task.
|
422
|
+
class BufferTaskResponse
|
423
|
+
include ::Google::Protobuf::MessageExts
|
424
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
425
|
+
end
|
370
426
|
end
|
371
427
|
end
|
372
428
|
end
|
@@ -42,7 +42,7 @@ module Google
|
|
42
42
|
# projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
|
43
43
|
# * `LOCATION_ID` is the canonical ID for the queue's location.
|
44
44
|
# The list of available locations can be obtained by calling
|
45
|
-
#
|
45
|
+
# `::Google::Cloud::Location::Locations::Client#list_locations`.
|
46
46
|
# For more information, see https://cloud.google.com/about/locations/.
|
47
47
|
# * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
|
48
48
|
# hyphens (-). The maximum length is 100 characters.
|
@@ -53,6 +53,9 @@ module Google
|
|
53
53
|
# tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest] in this queue.
|
54
54
|
# {::Google::Cloud::Tasks::V2beta3::HttpRequest Http tasks} are not affected by
|
55
55
|
# this proto.
|
56
|
+
# @!attribute [rw] http_target
|
57
|
+
# @return [::Google::Cloud::Tasks::V2beta3::HttpTarget]
|
58
|
+
# Modifies HTTP target for HTTP tasks.
|
56
59
|
# @!attribute [rw] rate_limits
|
57
60
|
# @return [::Google::Cloud::Tasks::V2beta3::RateLimits]
|
58
61
|
# Rate limits for task dispatches.
|
@@ -99,7 +102,7 @@ module Google
|
|
99
102
|
# @return [::Google::Cloud::Tasks::V2beta3::Queue::State]
|
100
103
|
# Output only. The state of the queue.
|
101
104
|
#
|
102
|
-
# `state` can only be changed by
|
105
|
+
# `state` can only be changed by called
|
103
106
|
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#pause_queue PauseQueue},
|
104
107
|
# {::Google::Cloud::Tasks::V2beta3::CloudTasks::Client#resume_queue ResumeQueue}, or
|
105
108
|
# uploading
|