public class TermsStatsFacetBuilder extends FacetBuilder
FacetBuilder.Mode
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
facetFilter, global, mode, name, nested
EMPTY_PARAMS
Constructor and Description |
---|
TermsStatsFacetBuilder(String name)
Constructs a new terms stats facet builder under the provided facet name.
|
Modifier and Type | Method and Description |
---|---|
TermsStatsFacetBuilder |
allTerms()
Marks all terms to be returned, even ones with 0 counts.
|
TermsStatsFacetBuilder |
keyField(String keyField) |
TermsStatsFacetBuilder |
lang(String lang)
The language of the script.
|
TermsStatsFacetBuilder |
order(TermsStatsFacet.ComparatorType comparatorType)
The order by which to return the facets by.
|
TermsStatsFacetBuilder |
param(String name,
Object value)
A parameter that will be passed to the script.
|
TermsStatsFacetBuilder |
shardSize(int shardSize)
Sets the number of terms that will be returned from each shard.
|
TermsStatsFacetBuilder |
size(int size)
Sets the size of the result.
|
XContentBuilder |
toXContent(XContentBuilder builder,
ToXContent.Params params) |
TermsStatsFacetBuilder |
valueField(String valueField) |
TermsStatsFacetBuilder |
valueScript(String script)
A value script to be executed (instead of value field) which results (numeric) will be used
to compute the totals.
|
addFilterFacetAndGlobal, facetFilter, global, mode, nested
public TermsStatsFacetBuilder(String name)
public TermsStatsFacetBuilder keyField(String keyField)
public TermsStatsFacetBuilder valueField(String valueField)
public TermsStatsFacetBuilder order(TermsStatsFacet.ComparatorType comparatorType)
TermsStatsFacet.ComparatorType.COUNT
.public TermsStatsFacetBuilder size(int size)
public TermsStatsFacetBuilder shardSize(int shardSize)
size
, therefore in this case it will fall back and be treated as being equal to
size.public TermsStatsFacetBuilder allTerms()
public TermsStatsFacetBuilder valueScript(String script)
public TermsStatsFacetBuilder lang(String lang)
public TermsStatsFacetBuilder param(String name, Object value)
name
- The name of the script parameter.value
- The value of the script parameter.public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
IOException
Copyright © 2009–2015. All rights reserved.