App Engine HTTP request.
The message defines the HTTP request that is sent to an App Engine app when the task is dispatched.
This proto can only be used for tasks in a queue which has [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target] set.
Using
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>.
The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level:
- If set, [app_engine_routing_override][google.cloud.tasks.v2beta2.AppEngineHttpTarget.app_engine_routing_override] is used for all tasks in the queue, no matter what the setting is for the [task-level app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
The url that the task will be sent to is:
url =host+[relative_url][google.cloud.tasks.v2beta2.AppEngineHttpRequest.relative_url]
The task attempt has succeeded if the app's request handler returns an
HTTP response code in the range [200 - 299]. 503 is
considered an App Engine system error instead of an application error.
Requests returning error 503 will be retried regardless of retry
configuration and not counted against retry counts. Any other response
code or a failure to receive a response before the deadline is a failed
attempt.
Task-level setting for App Engine routing. If set, [app_engi ne_routing_override][google.cloud.tasks.v2beta2.AppEngineHtt pTarget.app_engine_routing_override] is used for all tasks in the queue, no matter what the setting is for the [task- level app_engine_routing][google.cloud.tasks.v2beta2.AppEngi neHttpRequest.app_engine_routing].
HTTP request headers. This map contains the header field
names and values. Headers can be set when the [task is
created][google.cloud.tasks.v2beta2.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 [payload][g
oogle.cloud.tasks.v2beta2.AppEngineHttpRequest.payload], 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.v2beta2.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://clou
d.google.com/appengine/docs/python/taskqueue/push/creating-
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. For more information,
see the
CreateTask
documentation.
Classes
HeadersEntry
API documentation for tasks_v2beta2.types.AppEngineHttpRequest.HeadersEntry class.