Struct switchboard_utils::protos::oracle_job::HttpTask

pub struct HttpTask {
    pub url: Option<String>,
    pub method: Option<i32>,
    pub headers: Vec<Header>,
    pub body: Option<String>,
}

The adapter will report the text body of a successful HTTP request to the specified url, or return an error if the response status code is greater than or equal to 400.

Input: None

Returns: String representation of the http response.

Example: Basic HttpTask

{"httpTask": {"url": "<https://mywebsite.org/path"}> }

Example: HttpTask example with headers

{ "httpTask": { "url": "<https://mywebsite.org/path",> "method": "METHOD_POST", "headers": \[ { "key": "MY_HEADER_KEY", "value": "MY_HEADER_VALUE" } \], "body": "{\"MY_BODY_KEY\":\"MY_BODY_VALUE\"}" } }

Fields

url: Option<String>

/ A string containing the URL to direct this HTTP request to.

method: Option<i32>

/ The type of HTTP request to make.

headers: Vec<Header>

/ A list of headers to add to this HttpTask.

body: Option<String>

/ A stringified body (if any) to add to this HttpTask.

Implementations

impl HttpTask

pub fn url(&self) -> &str

Returns the value of url, or the default value if url is unset.

pub fn method(&self) -> Method

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

pub fn set_method(&mut self, value: Method)

Sets method to the provided enum value.

pub fn body(&self) -> &str

Returns the value of body, or the default value if body is unset.

Trait Implementations

impl Clone for HttpTask

fn clone(&self) -> HttpTask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HttpTask

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

Formats the value using the given formatter.

impl Default for HttpTask

fn default() -> Self

Returns the “default value” for a type.

impl Message for HttpTask

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

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

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

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

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

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

impl PartialEq for HttpTask

fn eq(&self, other: &HttpTask) -> 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 HttpTask