Class RequestFacetField
-
- All Implemented Interfaces:
@JsonClass(generateAdapter = true) public final class RequestFacetFieldA simple facet field
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumRequestFacetField.SortEnumValues: COUNT, INDEX
public enumRequestFacetField.MethodEnumValues: ENUM, FC
-
Field Summary
Fields Modifier and Type Field Description private Stringfieldprivate Stringlabelprivate Stringprefixprivate RequestFacetField.SortEnumsortprivate RequestFacetField.MethodEnummethodprivate Booleanmissingprivate Integerlimitprivate Integeroffsetprivate Integermincountprivate IntegerfacetEnumCacheMinDfprivate List<String>excludeFilters
-
Constructor Summary
Constructors Constructor Description RequestFacetField(String field, String label, String prefix, RequestFacetField.SortEnum sort, RequestFacetField.MethodEnum method, Boolean missing, Integer limit, Integer offset, Integer mincount, Integer facetEnumCacheMinDf, List<String> excludeFilters)
-
Method Summary
Modifier and Type Method Description final StringgetField()The facet field final UnitsetField(@Json(name = "field") String field)The facet field final StringgetLabel()A label to include in place of the facet field final UnitsetLabel(@Json(name = "label") String label)A label to include in place of the facet field final StringgetPrefix()Restricts the possible constraints to only indexed values with a specified prefix. final UnitsetPrefix(@Json(name = "prefix") String prefix)Restricts the possible constraints to only indexed values with a specified prefix. final RequestFacetField.SortEnumgetSort()final UnitsetSort(@Json(name = "sort") RequestFacetField.SortEnum sort)final RequestFacetField.MethodEnumgetMethod()final UnitsetMethod(@Json(name = "method") RequestFacetField.MethodEnum method)final BooleangetMissing()When true, count results that match the query but which have no facet value for the field (in addition to the Term-based constraints). final UnitsetMissing(@Json(name = "missing") Boolean missing)When true, count results that match the query but which have no facet value for the field (in addition to the Term-based constraints). final IntegergetLimit()final UnitsetLimit(@Json(name = "limit") Integer limit)final IntegergetOffset()final UnitsetOffset(@Json(name = "offset") Integer offset)final IntegergetMincount()The minimum count required for a facet field to be included in the response. final UnitsetMincount(@Json(name = "mincount") Integer mincount)The minimum count required for a facet field to be included in the response. final IntegergetFacetEnumCacheMinDf()final UnitsetFacetEnumCacheMinDf(@Json(name = "facetEnumCacheMinDf") Integer facetEnumCacheMinDf)final List<String>getExcludeFilters()Filter Queries with tags listed here will not be included in facet counts. final UnitsetExcludeFilters(@Json(name = "excludeFilters") List<String> excludeFilters)Filter Queries with tags listed here will not be included in facet counts. -
-
Method Detail
-
setLabel
final Unit setLabel(@Json(name = "label") String label)
A label to include in place of the facet field
-
getPrefix
final String getPrefix()
Restricts the possible constraints to only indexed values with a specified prefix.
-
setPrefix
final Unit setPrefix(@Json(name = "prefix") String prefix)
Restricts the possible constraints to only indexed values with a specified prefix.
-
getSort
final RequestFacetField.SortEnum getSort()
-
setSort
final Unit setSort(@Json(name = "sort") RequestFacetField.SortEnum sort)
-
getMethod
final RequestFacetField.MethodEnum getMethod()
-
setMethod
final Unit setMethod(@Json(name = "method") RequestFacetField.MethodEnum method)
-
getMissing
final Boolean getMissing()
When true, count results that match the query but which have no facet value for the field (in addition to the Term-based constraints).
-
setMissing
final Unit setMissing(@Json(name = "missing") Boolean missing)
When true, count results that match the query but which have no facet value for the field (in addition to the Term-based constraints).
-
getMincount
final Integer getMincount()
The minimum count required for a facet field to be included in the response.
-
setMincount
final Unit setMincount(@Json(name = "mincount") Integer mincount)
The minimum count required for a facet field to be included in the response.
-
getFacetEnumCacheMinDf
final Integer getFacetEnumCacheMinDf()
-
setFacetEnumCacheMinDf
final Unit setFacetEnumCacheMinDf(@Json(name = "facetEnumCacheMinDf") Integer facetEnumCacheMinDf)
-
getExcludeFilters
final List<String> getExcludeFilters()
Filter Queries with tags listed here will not be included in facet counts. This is used for multi-select facetting.
-
setExcludeFilters
final Unit setExcludeFilters(@Json(name = "excludeFilters") List<String> excludeFilters)
Filter Queries with tags listed here will not be included in facet counts. This is used for multi-select facetting.
-
-
-
-