Struct google_api_proto::google::cloud::tasks::v2beta2::HttpRequest

pub struct HttpRequest {
    pub url: String,
    pub http_method: i32,
    pub headers: BTreeMap<String, String>,
    pub body: Bytes,
    pub authorization_header: Option<AuthorizationHeader>,
}

HTTP request.

The task will be pushed to the worker as an HTTP request. An HTTP request embodies a url, an http method, headers, body and authorization for the http task.

Fields

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: i32

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

headers: BTreeMap<String, String>

HTTP request headers.

This map contains the header field names and values. Headers can be set when running the [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] or [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].

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:

• Any header that is prefixed with “X-CloudTasks-” will be treated as service header. Service headers define properties of the task and are predefined in CloudTask.
• Host: This will be computed by Cloud Tasks and derived from [HttpRequest.url][google.cloud.tasks.v2beta2.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][google.cloud.tasks.v2beta2.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.v2beta2.HttpMethod].

authorization_header: Option<AuthorizationHeader>

The mode for generating an Authorization header for HTTP requests.

If specified, all Authorization headers in the [HttpRequest.headers][google.cloud.tasks.v2beta2.HttpRequest.headers] field will be overridden.

Implementations

impl HttpRequest

pub fn http_method(&self) -> HttpMethod

Returns the enum value of http_method, or the default if the field is set to an invalid enum value.

pub fn set_http_method(&mut self, value: HttpMethod)

Sets http_method to the provided enum value.

Trait Implementations

impl Clone for HttpRequest

fn clone(&self) -> HttpRequest

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for HttpRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for HttpRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for HttpRequest