filterconfig

Pydantic Filter Configuration Data Model.

FilterConfig

Bases: GenericConfig

Filter Strategy Data Configuration.

Source code in oteapi/models/filterconfig.py

class FilterConfig(GenericConfig):
    """Filter Strategy Data Configuration."""

    filterType: str = Field(
        ..., description="Type of registered filter strategy. E.g., `filter/sql`."
    )
    query: Optional[str] = Field(None, description="Define a query operation.")
    condition: Optional[str] = Field(
        None,
        description="Logical statement indicating when a filter should be applied.",
    )
    limit: Optional[int] = Field(
        None, description="Number of items remaining after a filter expression."
    )

condition: Optional[str] = Field(None, description='Logical statement indicating when a filter should be applied.') class-attribute instance-attribute

filterType: str = Field(..., description='Type of registered filter strategy. E.g., `filter/sql`.') class-attribute instance-attribute

limit: Optional[int] = Field(None, description='Number of items remaining after a filter expression.') class-attribute instance-attribute

query: Optional[str] = Field(None, description='Define a query operation.') class-attribute instance-attribute