Class SignificantTextAggregationBuilder
java.lang.Object
org.elasticsearch.search.aggregations.AggregationBuilder
org.elasticsearch.search.aggregations.AbstractAggregationBuilder<SignificantTextAggregationBuilder>
org.elasticsearch.search.aggregations.bucket.significant.SignificantTextAggregationBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,ToXContent
,ToXContentFragment
,BaseAggregationBuilder
public class SignificantTextAggregationBuilder extends AbstractAggregationBuilder<SignificantTextAggregationBuilder>
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
NAME
Fields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
metadata
Fields inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
factoriesBuilder, name
-
Constructor Summary
Constructors Modifier Constructor Description SignificantTextAggregationBuilder(java.lang.String name, java.lang.String fieldName)
SignificantTextAggregationBuilder(StreamInput in)
Read from a stream.protected
SignificantTextAggregationBuilder(SignificantTextAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)
-
Method Summary
Modifier and Type Method Description QueryBuilder
backgroundFilter()
SignificantTextAggregationBuilder
backgroundFilter(QueryBuilder backgroundFilter)
AggregationBuilder.BucketCardinality
bucketCardinality()
Do aggregations built by this builder contain buckets? If so, do they contain *always* contain a single bucket?TermsAggregator.BucketCountThresholds
bucketCountThresholds()
SignificantTextAggregationBuilder
bucketCountThresholds(TermsAggregator.BucketCountThresholds bucketCountThresholds)
protected AggregatorFactory
doBuild(QueryShardContext queryShardContext, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected void
doWriteTo(StreamOutput out)
boolean
equals(java.lang.Object obj)
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()
java.lang.String
getType()
The name of the type of aggregation built by this builder.int
hashCode()
IncludeExclude
includeExclude()
Get terms to include and exclude from the aggregation resultsSignificantTextAggregationBuilder
includeExclude(IncludeExclude includeExclude)
Set terms to include and exclude from the aggregation resultsprotected 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.static SignificantTextAggregationBuilder
parse(java.lang.String aggregationName, XContentParser parser)
protected AggregationBuilder
shallowCopy(AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)
Create a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilder
andmetadata
.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.Methods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
build, getMetadata, getWriteableName, setMetadata, subAggregation, toXContent, writeTo
Methods inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
buildPipelineTree, doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, toString
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
-
Constructor Details
-
SignificantTextAggregationBuilder
protected SignificantTextAggregationBuilder(SignificantTextAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata) -
SignificantTextAggregationBuilder
public SignificantTextAggregationBuilder(java.lang.String name, java.lang.String fieldName)- Parameters:
name
- the name of this aggregationfieldName
- the name of the text field that will be the subject of this aggregation
-
SignificantTextAggregationBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
parse
public static SignificantTextAggregationBuilder parse(java.lang.String aggregationName, XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
shallowCopy
protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)Description copied from class:AggregationBuilder
Create a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilder
andmetadata
. Used byAggregationBuilder.rewrite(QueryRewriteContext)
.- Specified by:
shallowCopy
in classAggregationBuilder
-
getBucketCountThresholds
-
bucketCountThresholds
-
subAggregations
Description copied from class:AbstractAggregationBuilder
Registers sub-factories with this factory. The sub-factory will be responsible for the creation of sub-aggregators under the aggregator created by this factory.- Specified by:
subAggregations
in interfaceBaseAggregationBuilder
- Overrides:
subAggregations
in classAbstractAggregationBuilder<SignificantTextAggregationBuilder>
- Parameters:
subFactories
- The sub-factories- Returns:
- this factory (fluent interface)
-
subAggregation
Description copied from class:AggregationBuilder
Add a sub aggregation to this builder.- Overrides:
subAggregation
in classAbstractAggregationBuilder<SignificantTextAggregationBuilder>
-
bucketCountThresholds
public SignificantTextAggregationBuilder bucketCountThresholds(TermsAggregator.BucketCountThresholds bucketCountThresholds) -
size
Sets the size - indicating how many term buckets should be returned (defaults to 10) -
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). The higher the shard size is, the more accurate the results are. -
fieldName
Sets the name of the text field that will be the subject of this aggregation. -
sourceFieldNames
Selects the fields to load from _source JSON and analyze. If none are specified, the indexed "fieldName" value is assumed to also be the name of the JSON field holding the value -
filterDuplicateText
Control if duplicate paragraphs of text should try be filtered from the statistical text analysis. Can improve results but slows down analysis. Default is false. -
minDocCount
Set the minimum document count terms should have in order to appear in the response. -
shardMinDocCount
Set the minimum document count terms should have on the shard in order to appear in the response. -
backgroundFilter
-
backgroundFilter
-
includeExclude
Set terms to include and exclude from the aggregation results -
includeExclude
Get terms to include and exclude from the aggregation results -
significanceHeuristic
public SignificantTextAggregationBuilder significanceHeuristic(SignificanceHeuristic significanceHeuristic) -
significanceHeuristic
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractAggregationBuilder<SignificantTextAggregationBuilder>
- Throws:
java.io.IOException
-
bucketCardinality
Description copied from class:AggregationBuilder
Do aggregations built by this builder contain buckets? If so, do they contain *always* contain a single bucket?- Specified by:
bucketCardinality
in classAggregationBuilder
-
doBuild
protected AggregatorFactory doBuild(QueryShardContext queryShardContext, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) throws java.io.IOException- Specified by:
doBuild
in classAbstractAggregationBuilder<SignificantTextAggregationBuilder>
- Throws:
java.io.IOException
-
internalXContent
protected XContentBuilder internalXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
internalXContent
in classAbstractAggregationBuilder<SignificantTextAggregationBuilder>
- Throws:
java.io.IOException
-
hashCode
public int hashCode()- Overrides:
hashCode
in classAbstractAggregationBuilder<SignificantTextAggregationBuilder>
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classAbstractAggregationBuilder<SignificantTextAggregationBuilder>
-
getType
public java.lang.String getType()Description copied from interface:BaseAggregationBuilder
The name of the type of aggregation built by this builder.
-