Skip to content

SourceConfiguration

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

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.