FacetRequestOptions Class

The options for facet evaluation.

Inheritance

Model

FacetRequestOptions

Constructor

FacetRequestOptions(*, sort_by: Optional[str] = None, sort_order: Optional[Union[str, azure.mgmt.resourcegraph.models._resource_graph_client_enums.FacetSortOrder]] = 'desc', filter: Optional[str] = None, top: Optional[int] = None, **kwargs)

Parameters

sort_by

str

Required

The column name or query expression to sort on. Defaults to count if not present.

sort_order

str or FacetSortOrder

Required

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

filter

str

Required

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

top

int

Required

The maximum number of facet rows that should be returned.