Struct HttpConfig 

pub struct HttpConfig {
    pub method: String,
    pub url: String,
    pub headers: Vec<(String, String)>,
    pub body: Option<Value>,
    pub timeout_secs: Option<u64>,
    pub allow_failure: bool,
    pub retry: Option<RetryPolicy>,
    pub trace_context: Option<WorkflowTraceContext>,
    pub allowed_hosts: Vec<String>,
}

Serializable configuration for an HTTP step.

Examples

use ironflow_engine::config::HttpConfig;

let config = HttpConfig::get("https://api.example.com/health");

Fields

method: String

HTTP method (GET, POST, PUT, PATCH, DELETE).

url: String

Request URL.

headers: Vec<(String, String)>

Request headers.

body: Option<Value>

Request body as JSON.

timeout_secs: Option<u64>

Timeout in seconds (default: 30).

allow_failure: bool

When true, a failure of this step does not fail the run.

retry: Option<RetryPolicy>

Optional step-level retry policy.

trace_context: Option<WorkflowTraceContext>

Optional W3C trace context for distributed tracing propagation.

allowed_hosts: Vec<String>

Hosts this step may reach even when they are internal. See allow_host.

Implementations

impl HttpConfig

pub fn get(url: &str) -> Self

Create a GET request config.

Examples

use ironflow_engine::config::HttpConfig;

let config = HttpConfig::get("https://example.com");
assert_eq!(config.method, "GET");

pub fn post(url: &str) -> Self

Create a POST request config.

pub fn put(url: &str) -> Self

Create a PUT request config.

pub fn patch(url: &str) -> Self

Create a PATCH request config.

pub fn delete(url: &str) -> Self

Create a DELETE request config.

pub fn header(self, name: &str, value: &str) -> Self

Add a request header.

pub fn json(self, body: Value) -> Self

Set the request body as JSON.

pub fn timeout_secs(self, secs: u64) -> Self

Set the timeout in seconds.

pub fn allow_failure(self) -> Self

Mark this step as allowed to fail without stopping the run.

Examples

use ironflow_engine::config::HttpConfig;

let config = HttpConfig::get("https://example.com").allow_failure();
assert!(config.allow_failure);

pub fn retry_policy(self, policy: RetryPolicy) -> Self

Set a step-level retry policy.

Examples

use ironflow_core::retry::RetryPolicy;
use ironflow_engine::config::HttpConfig;

let config = HttpConfig::get("https://api.example.com")
    .retry_policy(RetryPolicy::new(5));
assert!(config.retry.is_some());

pub fn allow_host(self, host: &str) -> Self

Let this step reach host even when it is, or resolves to, a private, loopback, link-local or cloud metadata address.

Without it, the step fails before anything is sent. Hosts allowed for the whole deployment go in the worker’s IRONFLOW_HTTP_ALLOWED_HOSTS environment variable instead. See Http::allow_host.

Examples

use ironflow_engine::config::HttpConfig;

let config = HttpConfig::get("http://billing.internal:8080/invoices")
    .allow_host("billing.internal");
assert_eq!(config.allowed_hosts, ["billing.internal"]);

Trait Implementations

impl Clone for HttpConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HttpConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<HttpConfig> for StepConfig

fn from(c: HttpConfig) -> Self

Converts to this type from the input type.

impl Serialize for HttpConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.