Struct XmlStreamConfig 

pub struct XmlStreamConfig {
    pub base_url: String,
    pub path: String,
    pub method: Method,
    pub auth: AuthSpec<XmlAuth>,
    pub headers: HeaderMap,
    pub body: Option<String>,
    pub records_element_path: Option<String>,
    pub pagination: Option<XmlPagination>,
    pub max_pages: Option<usize>,
    pub query_params: HashMap<String, String>,
    pub batch_size: usize,
}

Available on crate features source-rest and source-xml only.

Configuration for the XML source.

Fields

base_url: String

Base URL of the API.

path: String

Request path (appended to base_url).

method: Method

HTTP method (GET or POST for SOAP).

auth: AuthSpec<XmlAuth>

Authentication: either inline ({ type, config }) or a { ref: <name> } pointer to a shared provider in the CLI’s top-level auth: catalog.

headers: HeaderMap

Additional request headers.

body: Option<String>

Optional request body (e.g. SOAP envelope).

records_element_path: Option<String>

Dot-separated path to the repeating element in the XML response (e.g. "Envelope.Body.GetUsersResponse.Users.User").

pagination: Option<XmlPagination>

Pagination configuration.

max_pages: Option<usize>

Maximum number of pages to fetch.

query_params: HashMap<String, String>

Query parameters to include in every request.

batch_size: usize

Records per emitted StreamPage. The event-driven XML parser accumulates matched subtrees into a buffer and yields whenever the buffer reaches this size. Defaults to DEFAULT_BATCH_SIZE.

batch_size = 0 is the “no batching” sentinel: the document is drained end-to-end and the entire result set is emitted in a single page. Useful for small lookup payloads or for sinks (e.g. SQL COPY, BigQuery load jobs) that prefer one large request to many small ones.

Implementations

impl XmlStreamConfig

pub fn new( base_url: impl Into<String>, path: impl Into<String>, ) -> XmlStreamConfig

Create a new config with required fields.

pub fn method(self, method: Method) -> XmlStreamConfig

Set the HTTP method (default: GET).

pub fn auth(self, auth: XmlAuth) -> XmlStreamConfig

Set the authentication method.

pub fn headers(self, headers: HeaderMap) -> XmlStreamConfig

Set additional headers.

pub fn body(self, body: impl Into<String>) -> XmlStreamConfig

Set a SOAP or XML request body.

pub fn records_element_path(self, path: impl Into<String>) -> XmlStreamConfig

Set the dot-separated path to the repeating element.

pub fn pagination(self, pagination: XmlPagination) -> XmlStreamConfig

Set pagination configuration.

pub fn max_pages(self, max: usize) -> XmlStreamConfig

Set the maximum number of pages.

pub fn query_param( self, key: impl Into<String>, value: impl Into<String>, ) -> XmlStreamConfig

Add a query parameter.

pub fn with_batch_size(self, batch_size: usize) -> XmlStreamConfig

Set the per-page record count for Source::stream_pages.

Pass 0 to opt out of batching — the entire document is drained and emitted in a single StreamPage.

Trait Implementations

impl Clone for XmlStreamConfig

fn clone(&self) -> XmlStreamConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XmlStreamConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for XmlStreamConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<XmlStreamConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for XmlStreamConfig

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 Serialize for XmlStreamConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.