Struct HttpRequest 

#[non_exhaustive]
pub struct HttpRequest {
    pub url: String,
    pub http_method: HttpMethod,
    pub headers: HashMap<String, String>,
    pub body: Bytes,
    pub authorization_header: Option<AuthorizationHeader>,
    /* private fields */
}

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, rate limits, and the queue’s 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 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).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

url: String

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.

http_method: HttpMethod

The HTTP method to use for the request. The default is POST.

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.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.
• 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.

body: Bytes

HTTP request body.

A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod.

authorization_header: Option<AuthorizationHeader>

The mode for generating an Authorization header for HTTP requests.

If specified, all Authorization headers in the HttpRequest.headers field will be overridden.

Implementations

impl HttpRequest

pub fn new() -> Self

pub fn set_url<T: Into<String>>(self, v: T) -> Self

Sets the value of url.

pub fn set_http_method<T: Into<HttpMethod>>(self, v: T) -> Self

Sets the value of http_method.

pub fn set_headers<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of headers.

pub fn set_body<T: Into<Bytes>>(self, v: T) -> Self

Sets the value of body.

pub fn set_authorization_header<T: Into<Option<AuthorizationHeader>>>( self, v: T, ) -> Self

Sets the value of authorization_header.

Note that all the setters affecting authorization_header are mutually exclusive.

pub fn oauth_token(&self) -> Option<&Box<OAuthToken>>

The value of authorization_header if it holds a OauthToken, None if the field is not set or holds a different branch.

pub fn set_oauth_token<T: Into<Box<OAuthToken>>>(self, v: T) -> Self

Sets the value of authorization_header to hold a OauthToken.

Note that all the setters affecting authorization_header are mutually exclusive.

pub fn oidc_token(&self) -> Option<&Box<OidcToken>>

The value of authorization_header if it holds a OidcToken, None if the field is not set or holds a different branch.

pub fn set_oidc_token<T: Into<Box<OidcToken>>>(self, v: T) -> Self

Sets the value of authorization_header to hold a OidcToken.

Note that all the setters affecting authorization_header are mutually exclusive.

Trait Implementations

impl Clone for HttpRequest

fn clone(&self) -> HttpRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HttpRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HttpRequest

fn default() -> HttpRequest

Returns the “default value” for a type.

impl Message for HttpRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for HttpRequest

fn eq(&self, other: &HttpRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for HttpRequest