This repository has been archived by the owner on Sep 16, 2023. It is now read-only.
/
target.proto
424 lines (393 loc) · 18.5 KB
/
target.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
// Copyright 2019 Google LLC.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
syntax = "proto3";
package google.cloud.tasks.v2;
import "google/api/field_behavior.proto";
import "google/api/annotations.proto";
option go_package = "google.golang.org/genproto/googleapis/cloud/tasks/v2;tasks";
option java_multiple_files = true;
option java_outer_classname = "TargetProto";
option java_package = "com.google.cloud.tasks.v2";
// HTTP request.
//
// The task will be pushed to the worker as an HTTP request. If the worker
// or the redirected worker acknowledges the task by returning a successful HTTP
// response code ([`200` - `299`]), the task will be removed from the queue. If
// any other HTTP response code is returned or no response is received, the
// task will be retried according to the following:
//
// * User-specified throttling: [retry configuration][google.cloud.tasks.v2.Queue.retry_config],
// [rate limits][google.cloud.tasks.v2.Queue.rate_limits], and the [queue's state][google.cloud.tasks.v2.Queue.state].
//
// * System throttling: To prevent the worker from overloading, Cloud Tasks may
// temporarily reduce the queue's effective rate. User-specified settings
// will not be changed.
//
// System throttling happens because:
//
// * Cloud Tasks backs off on all errors. Normally the backoff specified in
// [rate limits][google.cloud.tasks.v2.Queue.rate_limits] will be used. But if the worker returns
// `429` (Too Many Requests), `503` (Service Unavailable), or the rate of
// errors is high, Cloud Tasks will use a higher backoff rate. The retry
// specified in the `Retry-After` HTTP response header is considered.
//
// * To prevent traffic spikes and to smooth sudden increases in traffic,
// dispatches ramp up slowly when the queue is newly created or idle and
// if large numbers of tasks suddenly become available to dispatch (due to
// spikes in create task rates, the queue being unpaused, or many tasks
// that are scheduled at the same time).
message HttpRequest {
// Required. The full url path that the request will be sent to.
//
// This string must begin with either "http://" or "https://". Some examples
// are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will
// encode some characters for safety and compatibility. The maximum allowed
// URL length is 2083 characters after encoding.
//
// The `Location` header response from a redirect response [`300` - `399`]
// may be followed. The redirect is not counted as a separate attempt.
string url = 1 [(google.api.field_behavior) = REQUIRED];
// The HTTP method to use for the request. The default is POST.
HttpMethod http_method = 2;
// HTTP request headers.
//
// This map contains the header field names and values.
// Headers can be set when the
// [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
//
// These headers represent a subset of the headers that will accompany the
// task's HTTP request. Some HTTP request headers will be ignored or replaced.
//
// A partial list of headers that will be ignored or replaced is:
//
// * Host: This will be computed by Cloud Tasks and derived from
// [HttpRequest.url][google.cloud.tasks.v2.HttpRequest.url].
// * Content-Length: This will be computed by Cloud Tasks.
// * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
// * `X-Google-*`: Google use only.
// * `X-AppEngine-*`: Google use only.
//
// `Content-Type` won't be set by Cloud Tasks. You can explicitly set
// `Content-Type` to a media type when the
// [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
// For example, `Content-Type` can be set to `"application/octet-stream"` or
// `"application/json"`.
//
// Headers which can have multiple values (according to RFC2616) can be
// specified using comma-separated values.
//
// The size of the headers must be less than 80KB.
map<string, string> headers = 3;
// HTTP request body.
//
// A request body is allowed only if the
// [HTTP method][google.cloud.tasks.v2.HttpRequest.http_method] is POST, PUT, or PATCH. It is an
// error to set body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2.HttpMethod].
bytes body = 4;
// The mode for generating an `Authorization` header for HTTP requests.
//
// If specified, all `Authorization` headers in the [HttpRequest.headers][google.cloud.tasks.v2.HttpRequest.headers]
// field will be overridden.
oneof authorization_header {
// If specified, an
// [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
// will be generated and attached as an `Authorization` header in the HTTP
// request.
//
// This type of authorization should generally only be used when calling
// Google APIs hosted on *.googleapis.com.
OAuthToken oauth_token = 5;
// If specified, an
// [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
// token will be generated and attached as an `Authorization` header in the
// HTTP request.
//
// This type of authorization can be used for many scenarios, including
// calling Cloud Run, or endpoints where you intend to validate the token
// yourself.
OidcToken oidc_token = 6;
}
}
// App Engine HTTP request.
//
// The message defines the HTTP request that is sent to an App Engine app when
// the task is dispatched.
//
// Using [AppEngineHttpRequest][google.cloud.tasks.v2.AppEngineHttpRequest] requires
// [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
// Google IAM permission for the project
// and the following scope:
//
// `https://www.googleapis.com/auth/cloud-platform`
//
// The task will be delivered to the App Engine app which belongs to the same
// project as the queue. For more information, see
// [How Requests are
// Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
// and how routing is affected by
// [dispatch
// files](https://cloud.google.com/appengine/docs/python/config/dispatchref).
// Traffic is encrypted during transport and never leaves Google datacenters.
// Because this traffic is carried over a communication mechanism internal to
// Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS).
// The request to the handler, however, will appear to have used the HTTP
// protocol.
//
// The [AppEngineRouting][google.cloud.tasks.v2.AppEngineRouting] used to construct the URL that the task is
// delivered to can be set at the queue-level or task-level:
//
// * If [app_engine_routing_override is set on the
// queue][Queue.app_engine_routing_override], this value is used for all
// tasks in the queue, no matter what the setting is for the [task-level
// app_engine_routing][AppEngineHttpRequest.app_engine_routing].
//
//
// The `url` that the task will be sent to is:
//
// * `url =` [host][google.cloud.tasks.v2.AppEngineRouting.host] `+`
// [relative_uri][google.cloud.tasks.v2.AppEngineHttpRequest.relative_uri]
//
// Tasks can be dispatched to secure app handlers, unsecure app handlers, and
// URIs restricted with
// [`login:
// admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref).
// Because tasks are not run as any user, they cannot be dispatched to URIs
// restricted with
// [`login:
// required`](https://cloud.google.com/appengine/docs/standard/python/config/appref)
// Task dispatches also do not follow redirects.
//
// The task attempt has succeeded if the app's request handler returns an HTTP
// response code in the range [`200` - `299`]. The task attempt has failed if
// the app's handler returns a non-2xx response code or Cloud Tasks does
// not receive response before the [deadline][google.cloud.tasks.v2.Task.dispatch_deadline]. Failed
// tasks will be retried according to the
// [retry configuration][google.cloud.tasks.v2.Queue.retry_config]. `503` (Service Unavailable) is
// considered an App Engine system error instead of an application error and
// will cause Cloud Tasks' traffic congestion control to temporarily throttle
// the queue's dispatches. Unlike other types of task targets, a `429` (Too Many
// Requests) response from an app handler does not cause traffic congestion
// control to throttle the queue.
message AppEngineHttpRequest {
// The HTTP method to use for the request. The default is POST.
//
// The app's request handler for the task's target URL must be able to handle
// HTTP requests with this http_method, otherwise the task attempt will fail
// with error code 405 (Method Not Allowed). See
// [Writing a push task request
// handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
// and the documentation for the request handlers in the language your app is
// written in e.g.
// [Python Request
// Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass).
HttpMethod http_method = 1;
// Task-level setting for App Engine routing.
//
// * If [app_engine_routing_override is set on the
// queue][Queue.app_engine_routing_override], this value is used for all
// tasks in the queue, no matter what the setting is for the [task-level
// app_engine_routing][AppEngineHttpRequest.app_engine_routing].
AppEngineRouting app_engine_routing = 2;
// The relative URI.
//
// The relative URI must begin with "/" and must be a valid HTTP relative URI.
// It can contain a path and query string arguments.
// If the relative URI is empty, then the root path "/" will be used.
// No spaces are allowed, and the maximum length allowed is 2083 characters.
string relative_uri = 3;
// HTTP request headers.
//
// This map contains the header field names and values.
// Headers can be set when the
// [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
// Repeated headers are not supported but a header value can contain commas.
//
// Cloud Tasks sets some headers to default values:
//
// * `User-Agent`: By default, this header is
// `"AppEngine-Google; (+http://code.google.com/appengine)"`.
// This header can be modified, but Cloud Tasks will append
// `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
// modified `User-Agent`.
//
// If the task has a [body][google.cloud.tasks.v2.AppEngineHttpRequest.body], Cloud
// Tasks sets the following headers:
//
// * `Content-Type`: By default, the `Content-Type` header is set to
// `"application/octet-stream"`. The default can be overridden by explicitly
// setting `Content-Type` to a particular media type when the
// [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
// For example, `Content-Type` can be set to `"application/json"`.
// * `Content-Length`: This is computed by Cloud Tasks. This value is
// output only. It cannot be changed.
//
// The headers below cannot be set or overridden:
//
// * `Host`
// * `X-Google-*`
// * `X-AppEngine-*`
//
// In addition, Cloud Tasks sets some headers when the task is dispatched,
// such as headers containing information about the task; see
// [request
// headers](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_request_headers).
// These headers are set only when the task is dispatched, so they are not
// visible when the task is returned in a Cloud Tasks response.
//
// Although there is no specific limit for the maximum number of headers or
// the size, there is a limit on the maximum size of the [Task][google.cloud.tasks.v2.Task]. For more
// information, see the [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask] documentation.
map<string, string> headers = 4;
// HTTP request body.
//
// A request body is allowed only if the HTTP method is POST or PUT. It is
// an error to set a body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2.HttpMethod].
bytes body = 5;
}
// App Engine Routing.
//
// Defines routing characteristics specific to App Engine - service, version,
// and instance.
//
// For more information about services, versions, and instances see
// [An Overview of App
// Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine),
// [Microservices Architecture on Google App
// Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine),
// [App Engine Standard request
// routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed),
// and [App Engine Flex request
// routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
//
// Using [AppEngineRouting][google.cloud.tasks.v2.AppEngineRouting] requires
// [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
// Google IAM permission for the project
// and the following scope:
//
// `https://www.googleapis.com/auth/cloud-platform`
message AppEngineRouting {
// App service.
//
// By default, the task is sent to the service which is the default
// service when the task is attempted.
//
// For some queues or tasks which were created using the App Engine
// Task Queue API, [host][google.cloud.tasks.v2.AppEngineRouting.host] is not parsable
// into [service][google.cloud.tasks.v2.AppEngineRouting.service],
// [version][google.cloud.tasks.v2.AppEngineRouting.version], and
// [instance][google.cloud.tasks.v2.AppEngineRouting.instance]. For example, some tasks
// which were created using the App Engine SDK use a custom domain
// name; custom domains are not parsed by Cloud Tasks. If
// [host][google.cloud.tasks.v2.AppEngineRouting.host] is not parsable, then
// [service][google.cloud.tasks.v2.AppEngineRouting.service],
// [version][google.cloud.tasks.v2.AppEngineRouting.version], and
// [instance][google.cloud.tasks.v2.AppEngineRouting.instance] are the empty string.
string service = 1;
// App version.
//
// By default, the task is sent to the version which is the default
// version when the task is attempted.
//
// For some queues or tasks which were created using the App Engine
// Task Queue API, [host][google.cloud.tasks.v2.AppEngineRouting.host] is not parsable
// into [service][google.cloud.tasks.v2.AppEngineRouting.service],
// [version][google.cloud.tasks.v2.AppEngineRouting.version], and
// [instance][google.cloud.tasks.v2.AppEngineRouting.instance]. For example, some tasks
// which were created using the App Engine SDK use a custom domain
// name; custom domains are not parsed by Cloud Tasks. If
// [host][google.cloud.tasks.v2.AppEngineRouting.host] is not parsable, then
// [service][google.cloud.tasks.v2.AppEngineRouting.service],
// [version][google.cloud.tasks.v2.AppEngineRouting.version], and
// [instance][google.cloud.tasks.v2.AppEngineRouting.instance] are the empty string.
string version = 2;
// App instance.
//
// By default, the task is sent to an instance which is available when
// the task is attempted.
//
// Requests can only be sent to a specific instance if
// [manual scaling is used in App Engine
// Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
// App Engine Flex does not support instances. For more information, see
// [App Engine Standard request
// routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
// and [App Engine Flex request
// routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
string instance = 3;
// Output only. The host that the task is sent to.
//
// The host is constructed from the domain name of the app associated with
// the queue's project ID (for example <app-id>.appspot.com), and the
// [service][google.cloud.tasks.v2.AppEngineRouting.service], [version][google.cloud.tasks.v2.AppEngineRouting.version],
// and [instance][google.cloud.tasks.v2.AppEngineRouting.instance]. Tasks which were created using
// the App Engine SDK might have a custom domain name.
//
// For more information, see
// [How Requests are
// Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
string host = 4;
}
// The HTTP method used to deliver the task.
enum HttpMethod {
// HTTP method unspecified
HTTP_METHOD_UNSPECIFIED = 0;
// HTTP POST
POST = 1;
// HTTP GET
GET = 2;
// HTTP HEAD
HEAD = 3;
// HTTP PUT
PUT = 4;
// HTTP DELETE
DELETE = 5;
// HTTP PATCH
PATCH = 6;
// HTTP OPTIONS
OPTIONS = 7;
}
// Contains information needed for generating an
// [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
// This type of authorization should generally only be used when calling Google
// APIs hosted on *.googleapis.com.
message OAuthToken {
// [Service account email](https://cloud.google.com/iam/docs/service-accounts)
// to be used for generating OAuth token.
// The service account must be within the same project as the queue. The
// caller must have iam.serviceAccounts.actAs permission for the service
// account.
string service_account_email = 1;
// OAuth scope to be used for generating OAuth access token.
// If not specified, "https://www.googleapis.com/auth/cloud-platform"
// will be used.
string scope = 2;
}
// Contains information needed for generating an
// [OpenID Connect
// token](https://developers.google.com/identity/protocols/OpenIDConnect).
// This type of authorization can be used for many scenarios, including
// calling Cloud Run, or endpoints where you intend to validate the token
// yourself.
message OidcToken {
// [Service account email](https://cloud.google.com/iam/docs/service-accounts)
// to be used for generating OIDC token.
// The service account must be within the same project as the queue. The
// caller must have iam.serviceAccounts.actAs permission for the service
// account.
string service_account_email = 1;
// Audience to be used when generating OIDC token. If not specified, the URI
// specified in target will be used.
string audience = 2;
}