程序包 org.easysearch.client.analytics

类 TopMetricsAggregationBuilder

java.lang.Object

org.easysearch.search.aggregations.AggregationBuilder

org.easysearch.search.aggregations.AbstractAggregationBuilder<TopMetricsAggregationBuilder>

org.easysearch.client.analytics.TopMetricsAggregationBuilder

所有已实现的接口:

org.easysearch.common.io.stream.NamedWriteable, org.easysearch.common.io.stream.Writeable, org.easysearch.common.xcontent.ToXContent, org.easysearch.common.xcontent.ToXContentFragment, org.easysearch.index.query.Rewriteable<org.easysearch.search.aggregations.AggregationBuilder>, org.easysearch.search.aggregations.BaseAggregationBuilder

public class TopMetricsAggregationBuilder
extends org.easysearch.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).

嵌套类概要

从类继承的嵌套类/接口 org.easysearch.search.aggregations.AggregationBuilder

org.easysearch.search.aggregations.AggregationBuilder.BucketCardinality, org.easysearch.search.aggregations.AggregationBuilder.CommonFields

从接口继承的嵌套类/接口 org.easysearch.common.xcontent.ToXContent

org.easysearch.common.xcontent.ToXContent.DelegatingMapParams, org.easysearch.common.xcontent.ToXContent.MapParams, org.easysearch.common.xcontent.ToXContent.Params

从接口继承的嵌套类/接口 org.easysearch.common.io.stream.Writeable

org.easysearch.common.io.stream.Writeable.Reader<V extends java.lang.Object>, org.easysearch.common.io.stream.Writeable.Writer<V extends java.lang.Object>

字段概要

字段

修饰符和类型	字段	说明
static java.lang.String	NAME

从类继承的字段 org.easysearch.search.aggregations.AbstractAggregationBuilder

metadata

从类继承的字段 org.easysearch.search.aggregations.AggregationBuilder

factoriesBuilder, name

从接口继承的字段 org.easysearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

从接口继承的字段 org.easysearch.common.xcontent.ToXContent

EMPTY_PARAMS

构造器概要

构造器

构造器	说明
TopMetricsAggregationBuilder(java.lang.String name, org.easysearch.search.sort.SortBuilder<?> sort, int size, java.lang.String... metrics)	Build the request.

方法概要

修饰符和类型	方法	说明
org.easysearch.search.aggregations.AggregationBuilder.BucketCardinality	bucketCardinality()
protected org.easysearch.search.aggregations.AggregatorFactory	doBuild(org.easysearch.index.query.QueryShardContext queryShardContext, org.easysearch.search.aggregations.AggregatorFactory parent, org.easysearch.search.aggregations.AggregatorFactories.Builder subfactoriesBuilder)
protected void	doWriteTo(org.easysearch.common.io.stream.StreamOutput out)
java.lang.String	getType()
protected org.easysearch.common.xcontent.XContentBuilder	internalXContent(org.easysearch.common.xcontent.XContentBuilder builder, org.easysearch.common.xcontent.ToXContent.Params params)
protected org.easysearch.search.aggregations.AggregationBuilder	shallowCopy(org.easysearch.search.aggregations.AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)

从类继承的方法 org.easysearch.search.aggregations.AbstractAggregationBuilder

build, equals, getMetadata, getWriteableName, hashCode, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeTo

从类继承的方法 org.easysearch.search.aggregations.AggregationBuilder

buildPipelineTree, doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, toString

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 org.easysearch.common.xcontent.ToXContentFragment

isFragment

字段详细资料

NAME

public static final java.lang.String NAME

另请参阅:

常量字段值

构造器详细资料

TopMetricsAggregationBuilder

public TopMetricsAggregationBuilder(java.lang.String name,
org.easysearch.search.sort.SortBuilder<?> sort,
int size,
java.lang.String... metrics)

Build the request.

参数:

name - the name of the metric

sort - the sort key used to select the top metrics

size - number of results to return per bucket

metrics - the names of the fields to select

方法详细资料

getType

public java.lang.String getType()

internalXContent

protected org.easysearch.common.xcontent.XContentBuilder internalXContent(org.easysearch.common.xcontent.XContentBuilder builder,
org.easysearch.common.xcontent.ToXContent.Params params)
                                                                   throws java.io.IOException

指定者:

internalXContent 在类中 org.easysearch.search.aggregations.AbstractAggregationBuilder<TopMetricsAggregationBuilder>

抛出:

java.io.IOException

doWriteTo

protected void doWriteTo(org.easysearch.common.io.stream.StreamOutput out)
                  throws java.io.IOException

指定者:

doWriteTo 在类中 org.easysearch.search.aggregations.AbstractAggregationBuilder<TopMetricsAggregationBuilder>

抛出:

java.io.IOException

bucketCardinality

public org.easysearch.search.aggregations.AggregationBuilder.BucketCardinality bucketCardinality()

指定者:

bucketCardinality 在类中 org.easysearch.search.aggregations.AggregationBuilder

doBuild

protected org.easysearch.search.aggregations.AggregatorFactory doBuild(org.easysearch.index.query.QueryShardContext queryShardContext,
org.easysearch.search.aggregations.AggregatorFactory parent,
org.easysearch.search.aggregations.AggregatorFactories.Builder subfactoriesBuilder)
                                                                throws java.io.IOException

指定者:

doBuild 在类中 org.easysearch.search.aggregations.AbstractAggregationBuilder<TopMetricsAggregationBuilder>

抛出:

java.io.IOException

shallowCopy

protected org.easysearch.search.aggregations.AggregationBuilder shallowCopy(org.easysearch.search.aggregations.AggregatorFactories.Builder factoriesBuilder,
java.util.Map<java.lang.String,java.lang.Object> metadata)

指定者:

shallowCopy 在类中 org.easysearch.search.aggregations.AggregationBuilder