Struct CallbackSpec 

pub struct CallbackSpec {
    pub url: String,
    pub method: String,
    pub headers: BTreeMap<String, String>,
    pub extra_fields: BTreeMap<String, Value>,
    pub on: Vec<RunStatus>,
}

Available on crate feature serve only.

A caller-supplied completion callback, carried on the run record.

Fields

url: String

Destination URL. http/https only.

method: String

HTTP method — defaults to POST.

headers: BTreeMap<String, String>

Extra headers sent with the request.

These are credentials in practice, so a clustered server refuses them (see CallbackSpec::reject_secrets_in_cluster): a clustered submit persists the run record — including this map — into the shared history database for a peer to execute, which would store the value in clear text.

extra_fields: BTreeMap<String, Value>

Static fields merged into the callback body (e.g. the caller’s own job id). A key colliding with a faucet-emitted field is rejected at submit time — see RESERVED_BODY_KEYS.

on: Vec<RunStatus>

Terminal statuses to fire on. Empty (the default) means all of them, which is what a job-status callback wants — a caller that only subscribes to success will hang on a cancelled run.

Implementations

impl CallbackSpec

pub fn validate(&self, allow_hosts: &[String]) -> Result<(), String>

Structural + egress validation, run at submit time so a bad callback is a 422 on the submission rather than a silent no-op an hour later when the run finishes.

pub fn reject_secrets_in_cluster(&self, clustered: bool) -> Result<(), String>

A clustered submit persists the run record for a peer to execute, so caller-supplied credentials would land in the shared history database in clear text. Mirrors the guard the template registry already applies to secret params.

pub fn fires_on(&self, status: RunStatus) -> bool

Whether this spec subscribes to status.

Trait Implementations

impl Clone for CallbackSpec

fn clone(&self) -> CallbackSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CallbackSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CallbackSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for CallbackSpec

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for CallbackSpec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CallbackSpec

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 CallbackSpec