Struct ApiRequest

pub struct ApiRequest {
    pub type: Type,
    pub method: Method,
    pub url: String,
    pub headers: Option<JsonSchema>,
    pub body: Option<JsonSchema>,
    pub mode: Mode,
    pub hooks: Option<Vec<Hook>>,
    pub output: Option<JsonSchema>,
    pub name: String,
    pub metadata: Option<Value>,
}

Fields

type: Type

method: Method

url: String

Api endpoint to send requests to.

headers: Option<JsonSchema>

These are the custom headers to include in the Api Request sent. Each key-value pair represents a header name and its value.

body: Option<JsonSchema>

This defined the JSON body of your Api Request. For example, if body_schema included "my_field": "my_gather_statement.user_age", then the json body sent to the server would have that particular value assign to it. Right now, only data from gather statements are supported.

mode: Mode

This is the mode of the Api Request. We only support BLOCKING and BACKGROUND for now.

hooks: Option<Vec<Hook>>

This is a list of hooks for a task. Each hook is a list of tasks to run on a trigger (such as on start, on failure, etc). Only Say is supported for now.

output: Option<JsonSchema>

This is the schema for the outputs of the Api Request.

name: String

metadata: Option<Value>

This is for metadata you want to store on the task.

Implementations

impl ApiRequest

pub fn new( type: Type, method: Method, url: String, mode: Mode, name: String, ) -> ApiRequest

Trait Implementations

impl Clone for ApiRequest

fn clone(&self) -> ApiRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApiRequest

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

Formats the value using the given formatter.

impl Default for ApiRequest

fn default() -> ApiRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ApiRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ApiRequest

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ApiRequest