public class SignificantTextAggregationBuilder extends AbstractAggregationBuilder<SignificantTextAggregationBuilder>
AggregationBuilder.CommonFields
Writeable.Reader<V>, Writeable.Writer<V>
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
metaData
factoriesBuilder, name
EMPTY_PARAMS
Constructor and Description |
---|
SignificantTextAggregationBuilder(StreamInput in)
Read from a stream.
|
SignificantTextAggregationBuilder(java.lang.String name,
java.lang.String fieldName) |
Modifier and Type | Method and Description |
---|---|
QueryBuilder |
backgroundFilter() |
SignificantTextAggregationBuilder |
backgroundFilter(QueryBuilder backgroundFilter) |
TermsAggregator.BucketCountThresholds |
bucketCountThresholds() |
SignificantTextAggregationBuilder |
bucketCountThresholds(TermsAggregator.BucketCountThresholds bucketCountThresholds) |
protected AggregatorFactory<?> |
doBuild(SearchContext context,
AggregatorFactory<?> parent,
AggregatorFactories.Builder subFactoriesBuilder) |
protected boolean |
doEquals(java.lang.Object obj) |
protected int |
doHashCode() |
protected void |
doWriteTo(StreamOutput out) |
SignificantTextAggregationBuilder |
fieldName(java.lang.String fieldName)
Sets the name of the text field that will be the subject of this
aggregation.
|
SignificantTextAggregationBuilder |
filterDuplicateText(boolean filterDuplicateText)
Control if duplicate paragraphs of text should try be filtered from the
statistical text analysis.
|
protected TermsAggregator.BucketCountThresholds |
getBucketCountThresholds() |
static Aggregator.Parser |
getParser(ParseFieldRegistry<SignificanceHeuristicParser> significanceHeuristicParserRegistry) |
java.lang.String |
getType()
The name of the type of aggregation built by this builder.
|
IncludeExclude |
includeExclude()
Get terms to include and exclude from the aggregation results
|
SignificantTextAggregationBuilder |
includeExclude(IncludeExclude includeExclude)
Set terms to include and exclude from the aggregation results
|
protected XContentBuilder |
internalXContent(XContentBuilder builder,
ToXContent.Params params) |
SignificantTextAggregationBuilder |
minDocCount(long minDocCount)
Set the minimum document count terms should have in order to appear in
the response.
|
SignificantTextAggregationBuilder |
shardMinDocCount(long shardMinDocCount)
Set the minimum document count terms should have on the shard in order to
appear in the response.
|
SignificantTextAggregationBuilder |
shardSize(int shardSize)
Sets the shard_size - indicating the number of term buckets each shard
will return to the coordinating node (the node that coordinates the
search execution).
|
SignificanceHeuristic |
significanceHeuristic() |
SignificantTextAggregationBuilder |
significanceHeuristic(SignificanceHeuristic significanceHeuristic) |
SignificantTextAggregationBuilder |
size(int size)
Sets the size - indicating how many term buckets should be returned
(defaults to 10)
|
SignificantTextAggregationBuilder |
sourceFieldNames(java.util.List<java.lang.String> names)
Selects the fields to load from _source JSON and analyze.
|
SignificantTextAggregationBuilder |
subAggregation(AggregationBuilder aggregation)
Add a sub aggregation to this builder.
|
SignificantTextAggregationBuilder |
subAggregations(AggregatorFactories.Builder subFactories)
Registers sub-factories with this factory.
|
build, equals, getMetaData, getWriteableName, hashCode, setMetaData, subAggregation, toXContent, writeTo
doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
isFragment
public static final java.lang.String NAME
public SignificantTextAggregationBuilder(java.lang.String name, java.lang.String fieldName)
name
- the name of this aggregationfieldName
- the name of the text field that will be the subject of this
aggregationpublic SignificantTextAggregationBuilder(StreamInput in) throws java.io.IOException
java.io.IOException
public static Aggregator.Parser getParser(ParseFieldRegistry<SignificanceHeuristicParser> significanceHeuristicParserRegistry)
protected TermsAggregator.BucketCountThresholds getBucketCountThresholds()
public TermsAggregator.BucketCountThresholds bucketCountThresholds()
public SignificantTextAggregationBuilder subAggregations(AggregatorFactories.Builder subFactories)
AbstractAggregationBuilder
subAggregations
in interface BaseAggregationBuilder
subAggregations
in class AbstractAggregationBuilder<SignificantTextAggregationBuilder>
subFactories
- The sub-factoriespublic SignificantTextAggregationBuilder subAggregation(AggregationBuilder aggregation)
AggregationBuilder
subAggregation
in class AbstractAggregationBuilder<SignificantTextAggregationBuilder>
public SignificantTextAggregationBuilder bucketCountThresholds(TermsAggregator.BucketCountThresholds bucketCountThresholds)
public SignificantTextAggregationBuilder size(int size)
public SignificantTextAggregationBuilder shardSize(int shardSize)
public SignificantTextAggregationBuilder fieldName(java.lang.String fieldName)
public SignificantTextAggregationBuilder sourceFieldNames(java.util.List<java.lang.String> names)
public SignificantTextAggregationBuilder filterDuplicateText(boolean filterDuplicateText)
public SignificantTextAggregationBuilder minDocCount(long minDocCount)
public SignificantTextAggregationBuilder shardMinDocCount(long shardMinDocCount)
public SignificantTextAggregationBuilder backgroundFilter(QueryBuilder backgroundFilter)
public QueryBuilder backgroundFilter()
public SignificantTextAggregationBuilder includeExclude(IncludeExclude includeExclude)
public IncludeExclude includeExclude()
public SignificantTextAggregationBuilder significanceHeuristic(SignificanceHeuristic significanceHeuristic)
public SignificanceHeuristic significanceHeuristic()
protected void doWriteTo(StreamOutput out) throws java.io.IOException
doWriteTo
in class AbstractAggregationBuilder<SignificantTextAggregationBuilder>
java.io.IOException
protected AggregatorFactory<?> doBuild(SearchContext context, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder) throws java.io.IOException
doBuild
in class AbstractAggregationBuilder<SignificantTextAggregationBuilder>
java.io.IOException
protected XContentBuilder internalXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
internalXContent
in class AbstractAggregationBuilder<SignificantTextAggregationBuilder>
java.io.IOException
protected int doHashCode()
doHashCode
in class AbstractAggregationBuilder<SignificantTextAggregationBuilder>
protected boolean doEquals(java.lang.Object obj)
doEquals
in class AbstractAggregationBuilder<SignificantTextAggregationBuilder>
public java.lang.String getType()
BaseAggregationBuilder