Struct JobRequest 

pub struct JobRequest {
    pub method: String,
    pub url: Option<String>,
    pub url_from: Option<String>,
    pub headers: HashMap<String, String>,
    pub query: HashMap<String, String>,
    pub json: Option<Value>,
    pub locator_header: Option<String>,
    pub locator_body: Option<String>,
    pub locator_param: Option<String>,
    pub records_path: Option<String>,
}

One HTTP request in a job lifecycle (submit / fetch).

Fields

method: String

HTTP method (default GET; set POST for submit).

url: Option<String>

URL — absolute, or a base_url-relative path. ${job_id} is substituted.

Required for submit. For fetch, set exactly one of url (a fixed template) or url_from (a JSONPath into the poll body).

url_from: Option<String>

fetch only (#543): resolve the download URL from the last poll response body via JSONPath, instead of rendering url. For APIs that return a one-time signed download link in the poll body (e.g. a Stripe report run’s result.url) rather than at a deterministic /{job_id} path. The matched value must be a string; an absolute URL is used verbatim, a relative one is resolved against base_url. Mutually exclusive with url.

headers: HashMap<String, String>

Extra headers.

query: HashMap<String, String>

Extra query params.

json: Option<Value>

JSON request body.

locator_header: Option<String>

fetch only (#557): result-set continuation. Response header carrying a pagination locator (e.g. Salesforce Bulk Sforce-Locator). While present (and not empty / "null"), the fetch is repeated with the locator sent as locator_param, appending records across pages.

locator_body: Option<String>

fetch only (#557): JSONPath into the fetch response body for the continuation locator, when it rides the body rather than a header. Alternative to locator_header.

locator_param: Option<String>

fetch only (#557): query-param name the locator is sent as on each continuation request. Required when a locator source is configured.

records_path: Option<String>

fetch only (#557): JSONPath for extracting records from each fetch page, overriding the source-level records_path. Applies to a JSON result body.

Trait Implementations

impl Clone for JobRequest

fn clone(&self) -> JobRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JobRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JobRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for JobRequest

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 JobRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for JobRequest

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 JobRequest