Struct SourceConfiguration 

#[non_exhaustive]
pub struct SourceConfiguration {
    pub request_method: Option<HttpMethod>,
    pub request_path: Option<String>,
    pub request_parameters: Option<Vec<ConnectorProperty>>,
    pub response_configuration: Option<ResponseConfiguration>,
    pub pagination_configuration: Option<PaginationConfiguration>,
}

Configuration that defines how to make requests to endpoints, including request methods, paths, parameters, and response handling.

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.

request_method: Option<HttpMethod>

The HTTP method to use for requests to this endpoint, such as GET, POST.

request_path: Option<String>

The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.

request_parameters: Option<Vec<ConnectorProperty>>

Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.

response_configuration: Option<ResponseConfiguration>

Configuration that defines how to parse and extract data from API responses, including success and error handling.

pagination_configuration: Option<PaginationConfiguration>

Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.

Implementations

impl SourceConfiguration

pub fn request_method(&self) -> Option<&HttpMethod>

The HTTP method to use for requests to this endpoint, such as GET, POST.

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

The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.

pub fn request_parameters(&self) -> &[ConnectorProperty]

Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .request_parameters.is_none().

pub fn response_configuration(&self) -> Option<&ResponseConfiguration>

Configuration that defines how to parse and extract data from API responses, including success and error handling.

pub fn pagination_configuration(&self) -> Option<&PaginationConfiguration>

Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.

impl SourceConfiguration

pub fn builder() -> SourceConfigurationBuilder

Creates a new builder-style object to manufacture SourceConfiguration.

Trait Implementations

impl Clone for SourceConfiguration

fn clone(&self) -> SourceConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceConfiguration

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

Formats the value using the given formatter.

impl PartialEq for SourceConfiguration

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