Struct Request

pub struct Request {

    pub id: String,
    pub name: String,
    pub test: Option<String>,
    pub url: String,
    pub method: Option<RequestMethod>,
    pub timeout: Option<u32>,
    pub headers: Option<Vec<NameValuePair>>,
    pub query_string_params: Option<Vec<NameValuePair>>,
    pub body: Option<RequestBody>,
    pub keep_alive: Option<bool>,
    pub runs: usize,
    pub multi_run_execution: ExecutionConcurrency,
    pub selected_scenario: Option<Selection>,
    pub selected_authorization: Option<Selection>,
    pub selected_certificate: Option<Selection>,
    pub selected_proxy: Option<Selection>,
    pub selected_data: Option<Selection>,
    pub warnings: Option<Vec<String>>,
    pub validation_errors: Option<HashMap<String, String>>,
}

Information required to dispatch and test an Apicize Request

Fields

id: String

Unique identifier (required to keep track of dispatches and test executions)

name: String

Human-readable name describing the Apicize Request

test: Option<String>

Test to execute after dispatching request and receiving response

url: String

URL to dispatch the HTTP request to

method: Option<RequestMethod>

HTTP method

timeout: Option<u32>

Timeout, in milliseconds, to wait for a response

headers: Option<Vec<NameValuePair>>

HTTP headers

query_string_params: Option<Vec<NameValuePair>>

HTTP query string parameters

body: Option<RequestBody>

HTTP body

keep_alive: Option<bool>

Keep HTTP connection alive

runs: usize

Number of runs for the request to execute

multi_run_execution: ExecutionConcurrency

Execution of multiple runs

selected_scenario: Option<Selection>

Selected scenario, if applicable

selected_authorization: Option<Selection>

Selected authorization, if applicable

selected_certificate: Option<Selection>

Selected certificate, if applicable

selected_proxy: Option<Selection>

Selected proxy, if applicable

selected_data: Option<Selection>

Selected external data, if any

warnings: Option<Vec<String>>

Populated with any warnings regarding how the request is set up upon load

validation_errors: Option<HashMap<String, String>>

Validation errors

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CloneIdentifiable for Request

fn clone_as_new(&self, new_name: String) -> Self

Create a copy with a new identifier

impl Default for Request

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Request

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Request

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

Formats the value using the given formatter.

impl EditableWarnings for Request

fn set_warnings(&mut self, warnings: Option<Vec<String>>)

Set warnings

impl Identifiable for Request

fn get_id(&self) -> &str

Return ID of self

fn get_name(&self) -> &str

Return name of self

fn get_title(&self) -> String

Return a title to display in a list

impl PartialEq for Request

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Warnings for Request

fn get_warnings(&self) -> &Option<Vec<String>>

Retrieve warnings

impl StructuralPartialEq for Request