Struct googapis::google::cloud::tasks::v2::AppEngineHttpRequest [−][src]
pub struct AppEngineHttpRequest {
pub http_method: i32,
pub app_engine_routing: Option<AppEngineRouting>,
pub relative_uri: String,
pub headers: HashMap<String, String>,
pub body: Vec<u8>,
}
Expand description
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 and how routing is affected by dispatch files. 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
.
Because tasks are not run as any user, they cannot be dispatched to URIs
restricted with
login: required
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.
Fields
http_method: i32
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 and the documentation for the request handlers in the language your app is written in e.g. Python Request Handler.
app_engine_routing: Option<AppEngineRouting>
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].
relative_uri: String
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.
headers: HashMap<String, String>
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 modifiedUser-Agent
.
If the task has a [body][google.cloud.tasks.v2.AppEngineHttpRequest.body], Cloud Tasks sets the following headers:
Content-Type
: By default, theContent-Type
header is set to"application/octet-stream"
. The default can be overridden by explicitly settingContent-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. 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.
body: Vec<u8>
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].
Implementations
Returns the enum value of http_method
, or the default if the field is set to an invalid enum value.
Sets http_method
to the provided enum value.
Trait Implementations
fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
Returns the encoded length of the message without a length delimiter.
Encodes the message to a buffer. Read more
Encodes the message to a newly allocated buffer.
Encodes the message with a length-delimiter to a buffer. Read more
Encodes the message with a length-delimiter to a newly allocated buffer.
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
Decodes a length-delimited instance of the message from the buffer.
Decodes an instance of the message from a buffer, and merges it into self
. Read more
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for AppEngineHttpRequest
impl Send for AppEngineHttpRequest
impl Sync for AppEngineHttpRequest
impl Unpin for AppEngineHttpRequest
impl UnwindSafe for AppEngineHttpRequest
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more