Share via


SearchOptions Class

Options for a search.

Note: This class is marked as 'experimental' and may change in the future.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Constructor

SearchOptions(*, filter: SearchFilter = None, include_total_count: bool = False)

Keyword-Only Parameters

Name Description
filter
Required
include_total_count
Required

Attributes

filter

filter: SearchFilter

include_total_count

include_total_count: bool

is_experimental

is_experimental = True

stage_status

stage_status = 'experimental'