SourceConfiguration
¶
Source code in docs_src/capo_glue/types/source_configuration.py
filter_configuration
instance-attribute
¶
filter_configuration: NotRequired[FilterConfiguration]
Configuration for applying filter pushdown to REST API requests, defining how filter predicates are translated into query parameters or filter strings.
pagination_configuration
instance-attribute
¶
pagination_configuration: NotRequired[PaginationConfiguration]
Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.
request_method
instance-attribute
¶
request_method: NotRequired[HTTPMethod]
The HTTP method to use for requests to this endpoint, such as GET, POST.
request_parameters
instance-attribute
¶
request_parameters: NotRequired[ConnectorPropertyList]
Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.
request_path
instance-attribute
¶
request_path: NotRequired[PathString]
The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.
response_configuration
instance-attribute
¶
response_configuration: NotRequired[ResponseConfiguration]
Configuration that defines how to parse and extract data from API responses, including success and error handling.