Struct ExtractedParameter 

#[non_exhaustive]
pub struct ExtractedParameter {
    pub key: Option<String>,
    pub default_value: Option<String>,
    pub property_location: Option<PropertyLocation>,
    pub value: Option<ResponseExtractionMapping>,
}

Parameter extraction configuration that defines how to extract and map values from API responses to request parameters.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key: Option<String>

The parameter key name that will be used in subsequent requests.

default_value: Option<String>

The default value to use if the parameter cannot be extracted from the response.

property_location: Option<PropertyLocation>

Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.

value: Option<ResponseExtractionMapping>

The JSON path or extraction mapping that defines how to extract the parameter value from API responses.

Implementations

impl ExtractedParameter

pub fn key(&self) -> Option<&str>

The parameter key name that will be used in subsequent requests.

pub fn default_value(&self) -> Option<&str>

The default value to use if the parameter cannot be extracted from the response.

pub fn property_location(&self) -> Option<&PropertyLocation>

Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.

pub fn value(&self) -> Option<&ResponseExtractionMapping>

The JSON path or extraction mapping that defines how to extract the parameter value from API responses.

impl ExtractedParameter

pub fn builder() -> ExtractedParameterBuilder

Creates a new builder-style object to manufacture ExtractedParameter.

Trait Implementations

impl Clone for ExtractedParameter

fn clone(&self) -> ExtractedParameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExtractedParameter

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

Formats the value using the given formatter.

impl PartialEq for ExtractedParameter

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