org.elasticsearch.search.aggregations

クラス ValuesSourceAggregationBuilder<B extends ValuesSourceAggregationBuilder<B>>

java.lang.Object

org.elasticsearch.search.aggregations.AbstractAggregationBuilder

org.elasticsearch.search.aggregations.AggregationBuilder<B>

org.elasticsearch.search.aggregations.ValuesSourceAggregationBuilder<B>

すべての実装されたインタフェース:

ToXContent

直系の既知のサブクラス:

AbstractRangeBuilder, DateHistogramBuilder, GeoBoundsBuilder, HistogramBuilder, SamplerAggregationBuilder, TermsBuilder

public abstract class ValuesSourceAggregationBuilder<B extends ValuesSourceAggregationBuilder<B>>
extends AggregationBuilder<B>

A base class for all bucket aggregation builders that are based on values (either script generated or field data values)

ネストされたクラスのサマリー

インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

フィールドのサマリー

クラスから継承されたフィールド org.elasticsearch.search.aggregations.AbstractAggregationBuilder

type

インタフェースから継承されたフィールド org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタと説明
protected	ValuesSourceAggregationBuilder(String name, String type) Constructs a new builder.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected abstract XContentBuilder	doInternalXContent(XContentBuilder builder, ToXContent.Params params)
B	field(String field) Sets the field from which the values will be extracted.
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params builderParams)
B	missing(Object missingValue) Configure the value to use when documents miss a value.
B	script(Script script) Sets the script which generates the values.

クラスから継承されたメソッド org.elasticsearch.search.aggregations.AggregationBuilder

setMetaData, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, toXContent

クラスから継承されたメソッド org.elasticsearch.search.aggregations.AbstractAggregationBuilder

getName

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

ValuesSourceAggregationBuilder

protected ValuesSourceAggregationBuilder(String name,
                                         String type)

Constructs a new builder.

パラメータ:

name - The name of the aggregation.

type - The type of the aggregation.

メソッドの詳細

field

public B field(String field)

Sets the field from which the values will be extracted.

パラメータ:

field - The name of the field

戻り値:

This builder (fluent interface support)

script

public B script(Script script)

Sets the script which generates the values. If the script is configured along with the field (as in field(String)), then this script will be treated as a value script. A value script will be applied on the values that are extracted from the field data (you can refer to that value in the script using the _value reserved variable). If only the script is configured (and the no field is configured next to it), then the script will be responsible to generate the values that will be aggregated.

パラメータ:

script - The configured script.

戻り値:

This builder (fluent interface support)

missing

public B missing(Object missingValue)

Configure the value to use when documents miss a value.

internalXContent

protected final XContentBuilder internalXContent(XContentBuilder builder,
                                                 ToXContent.Params builderParams)
                                          throws IOException

定義:

internalXContent クラス内 AggregationBuilder<B extends ValuesSourceAggregationBuilder<B>>

例外:

IOException

doInternalXContent

protected abstract XContentBuilder doInternalXContent(XContentBuilder builder,
                                                      ToXContent.Params params)
                                               throws IOException

例外:

IOException