Module macrobond_data_api.web.web_types.search.search_filter

Classes

class SearchFilter (*args, **kwargs)

A filter in a search request

Ancestors

  • builtins.dict

Class variables

var entityTypes : Optional[List[str]]

One or more entity types to include in the search. An empty list will include all types. If not specified, the search will be made for TimeSeries.

var mustHaveAttributes : Optional[List[str]]

Attributes to be matched against entities when searching. Any value will match.

var mustHaveFilterListPath : Optional[str]

Optional path to filter list that is added to the set of MustHaveValues. The paths are typically obtained from a call ListFilterLists.

var mustHaveValues : Optional[Dict[str, object]]

Pairs of attributes and values to be matched against entities when searching

var mustNotHaveAttributes : Optional[List[str]]

Attributes to exclude entities when searching. Any value will match.

var mustNotHaveValues : Optional[Dict[str, object]]

Pairs of attributes and values to exclude entities when searching

var text : Optional[str]

Words to search for separated by space.