FacetRequestOptions Class

  • Reference

The options for facet evaluation.

Inheritance
msrest.serialization.Model
FacetRequestOptions

Constructor

FacetRequestOptions(*, sort_by: str | None = None, sort_order: str | FacetSortOrder | None = 'desc', filter: str | None = None, top: int | None = None, **kwargs)

Parameters

Name Description
sort_by
Required
str

The column name or query expression to sort on. Defaults to count if not present.
sort_order
Required
str or FacetSortOrder

The sorting order by the selected column (count by default). Possible values include: "asc", "desc". Default value: "desc".
filter
Required
str

Specifies the filter condition for the 'where' clause which will be run on main query's result, just before the actual faceting.
top
Required
int

The maximum number of facet rows that should be returned.

Keyword-Only Parameters

Name Description
sort_by
Required
sort_order
default value: desc
filter
Required
top
Required