Constructor Detail

• TermsStatsFacetBuilder

  public TermsStatsFacetBuilder(String name)

  Constructs a new terms stats facet builder under the provided facet name.

Method Detail

• keyField

  public TermsStatsFacetBuilder keyField(String keyField)

• valueField

  public TermsStatsFacetBuilder valueField(String valueField)

• order

  public TermsStatsFacetBuilder order(TermsStatsFacet.ComparatorType comparatorType)

  The order by which to return the facets by. Defaults to TermsStatsFacet.ComparatorType.COUNT.

• size

  public TermsStatsFacetBuilder size(int size)

  Sets the size of the result.

• shardSize

  public TermsStatsFacetBuilder shardSize(int shardSize)

  Sets the number of terms that will be returned from each shard. The higher the number the more accurate the results will be. The shard size cannot be smaller than size, therefore in this case it will fall back and be treated as being equal to size.

• allTerms

  public TermsStatsFacetBuilder allTerms()

  Marks all terms to be returned, even ones with 0 counts.

• valueScript

  public TermsStatsFacetBuilder valueScript(String script)

  A value script to be executed (instead of value field) which results (numeric) will be used to compute the totals.

• lang

  public TermsStatsFacetBuilder lang(String lang)

  The language of the script.

• param

  public TermsStatsFacetBuilder param(String name,
                                      Object value)

  A parameter that will be passed to the script.

  Parameters:

  name - The name of the script parameter.

  value - The value of the script parameter.

• toXContent

  public XContentBuilder toXContent(XContentBuilder builder,
                                    ToXContent.Params params)
                             throws IOException

  Throws:

  IOException