close
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tasks/google/cloud/tasks_v2beta3/proto/cloudtasks.proto
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC.
// 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.
Expand Down
3 changes: 2 additions & 1 deletion tasks/google/cloud/tasks_v2beta3/proto/queue.proto
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC.
// 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.
Expand Down Expand Up @@ -92,6 +92,7 @@ message Queue {
oneof queue_type {
// [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] settings apply only to
// [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest] in this queue.
// [Http tasks][google.cloud.tasks.v2beta3.HttpRequest] are not affected by this proto.
AppEngineHttpQueue app_engine_http_queue = 3;
}

Expand Down
4 changes: 3 additions & 1 deletion tasks/google/cloud/tasks_v2beta3/proto/queue_pb2.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

87 changes: 86 additions & 1 deletion tasks/google/cloud/tasks_v2beta3/proto/target.proto
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2018 Google LLC.
// 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.
Expand All @@ -25,6 +25,91 @@ option java_outer_classname = "TargetProto";
option java_package = "com.google.cloud.tasks.v2beta3";


// HTTP request.
//
// Warning: This is an [alpha](https://cloud.google.com/terms/launch-stages)
// feature. If you haven't already joined, you can [use this form to sign
// up](https://docs.google.com/forms/d/e/1FAIpQLSfc4uEy9CBHKYUSdnY1hdhKDCX7julVZHy3imOiR-XrU7bUNQ/viewform?usp=sf_link).
//
// 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 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][Queue.RetryConfig],
// [rate limits][Queue.RateLimits], and the [queue's state][google.cloud.tasks.v2beta3.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 backoffs on all errors. Normally the backoff specified in
// [rate limits][Queue.RateLimits] 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 large traffic spikes,
// 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;

// 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.v2beta3.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.v2beta3.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.v2beta3.HttpMethod].
bytes body = 4;
}

// App Engine HTTP queue.
//
// The task will be delivered to the App Engine application hostname
Expand Down
Loading