Class TopMetricsAggregationBuilder
java.lang.Object
org.elasticsearch.search.aggregations.AggregationBuilder
org.elasticsearch.search.aggregations.AbstractAggregationBuilder<TopMetricsAggregationBuilder>
org.elasticsearch.client.analytics.TopMetricsAggregationBuilder
- All Implemented Interfaces:
org.elasticsearch.common.io.stream.NamedWriteable
,org.elasticsearch.common.io.stream.Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentFragment
,org.elasticsearch.index.query.Rewriteable<org.elasticsearch.search.aggregations.AggregationBuilder>
,org.elasticsearch.search.aggregations.BaseAggregationBuilder
public class TopMetricsAggregationBuilder extends org.elasticsearch.search.aggregations.AbstractAggregationBuilder<TopMetricsAggregationBuilder>
Builds the Top Metrics aggregation request.
NOTE: This extends AbstractAggregationBuilder for compatibility
with SearchSourceBuilder.aggregation(AggregationBuilder)
but it
doesn't support any "server" side things like
Writeable.writeTo(StreamOutput),
AggregationBuilder.rewrite(QueryRewriteContext), or
AbstractAggregationBuilder.build(QueryShardContext, AggregatorFactory).
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
org.elasticsearch.search.aggregations.AggregationBuilder.BucketCardinality, org.elasticsearch.search.aggregations.AggregationBuilder.CommonFields
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
NAME
Fields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
metadata
-
Constructor Summary
Constructors Constructor Description TopMetricsAggregationBuilder(java.lang.String name, org.elasticsearch.search.sort.SortBuilder<?> sort, int size, java.lang.String... metrics)
Build the request. -
Method Summary
Modifier and Type Method Description org.elasticsearch.search.aggregations.AggregationBuilder.BucketCardinality
bucketCardinality()
protected org.elasticsearch.search.aggregations.AggregatorFactory
doBuild(org.elasticsearch.index.query.QueryShardContext queryShardContext, org.elasticsearch.search.aggregations.AggregatorFactory parent, org.elasticsearch.search.aggregations.AggregatorFactories.Builder subfactoriesBuilder)
protected void
doWriteTo(org.elasticsearch.common.io.stream.StreamOutput out)
java.lang.String
getType()
protected org.elasticsearch.common.xcontent.XContentBuilder
internalXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
protected org.elasticsearch.search.aggregations.AggregationBuilder
shallowCopy(org.elasticsearch.search.aggregations.AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)
Methods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
build, equals, getMetadata, getWriteableName, hashCode, setMetadata, subAggregation, subAggregation, subAggregations, 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
-
TopMetricsAggregationBuilder
public TopMetricsAggregationBuilder(java.lang.String name, org.elasticsearch.search.sort.SortBuilder<?> sort, int size, java.lang.String... metrics)Build the request.- Parameters:
name
- the name of the metricsort
- the sort key used to select the top metricssize
- number of results to return per bucketmetrics
- the names of the fields to select
-
-
Method Details
-
getType
public java.lang.String getType() -
internalXContent
protected org.elasticsearch.common.xcontent.XContentBuilder internalXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
internalXContent
in classorg.elasticsearch.search.aggregations.AbstractAggregationBuilder<TopMetricsAggregationBuilder>
- Throws:
java.io.IOException
-
doWriteTo
protected void doWriteTo(org.elasticsearch.common.io.stream.StreamOutput out) throws java.io.IOException- Specified by:
doWriteTo
in classorg.elasticsearch.search.aggregations.AbstractAggregationBuilder<TopMetricsAggregationBuilder>
- Throws:
java.io.IOException
-
bucketCardinality
public org.elasticsearch.search.aggregations.AggregationBuilder.BucketCardinality bucketCardinality()- Specified by:
bucketCardinality
in classorg.elasticsearch.search.aggregations.AggregationBuilder
-
doBuild
protected org.elasticsearch.search.aggregations.AggregatorFactory doBuild(org.elasticsearch.index.query.QueryShardContext queryShardContext, org.elasticsearch.search.aggregations.AggregatorFactory parent, org.elasticsearch.search.aggregations.AggregatorFactories.Builder subfactoriesBuilder) throws java.io.IOException- Specified by:
doBuild
in classorg.elasticsearch.search.aggregations.AbstractAggregationBuilder<TopMetricsAggregationBuilder>
- Throws:
java.io.IOException
-
shallowCopy
protected org.elasticsearch.search.aggregations.AggregationBuilder shallowCopy(org.elasticsearch.search.aggregations.AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)- Specified by:
shallowCopy
in classorg.elasticsearch.search.aggregations.AggregationBuilder
-