Class WeightedAvgAggregationBuilder
java.lang.Object
org.elasticsearch.search.aggregations.AggregationBuilder
org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB>
org.elasticsearch.search.aggregations.support.MultiValuesSourceAggregationBuilder<AB>
org.elasticsearch.search.aggregations.support.MultiValuesSourceAggregationBuilder.LeafOnly<WeightedAvgAggregationBuilder>
org.elasticsearch.search.aggregations.metrics.WeightedAvgAggregationBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,ToXContent
,ToXContentFragment
,BaseAggregationBuilder
public class WeightedAvgAggregationBuilder extends MultiValuesSourceAggregationBuilder.LeafOnly<WeightedAvgAggregationBuilder>
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.support.MultiValuesSourceAggregationBuilder
MultiValuesSourceAggregationBuilder.LeafOnly<AB extends MultiValuesSourceAggregationBuilder<AB>>
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
static ObjectParser<WeightedAvgAggregationBuilder,java.lang.String>
PARSER
static ParseField
VALUE_FIELD
static ParseField
WEIGHT_FIELD
Fields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
metadata
Fields inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
factoriesBuilder, name
-
Constructor Summary
Constructors Constructor Description WeightedAvgAggregationBuilder(java.lang.String name)
WeightedAvgAggregationBuilder(StreamInput in)
Read from a stream.WeightedAvgAggregationBuilder(WeightedAvgAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)
-
Method Summary
Modifier and Type Method Description AggregationBuilder.BucketCardinality
bucketCardinality()
Do aggregations built by this builder contain buckets? If so, do they contain *always* contain a single bucket?protected ValuesSourceType
defaultValueSourceType()
Aggregations should use this method to define aValuesSourceType
of last resort.XContentBuilder
doXContentBody(XContentBuilder builder, ToXContent.Params params)
java.lang.String
getType()
The name of the type of aggregation built by this builder.protected MultiValuesSourceAggregatorFactory
innerBuild(QueryShardContext queryShardContext, java.util.Map<java.lang.String,ValuesSourceConfig> configs, java.util.Map<java.lang.String,QueryBuilder> filters, DocValueFormat format, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected void
innerWriteTo(StreamOutput out)
Write subclass' state to the streamstatic void
registerUsage(ValuesSourceRegistry.Builder builder)
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
.WeightedAvgAggregationBuilder
value(MultiValuesSourceFieldConfig valueConfig)
WeightedAvgAggregationBuilder
weight(MultiValuesSourceFieldConfig weightConfig)
Methods inherited from class org.elasticsearch.search.aggregations.support.MultiValuesSourceAggregationBuilder.LeafOnly
subAggregations
Methods inherited from class org.elasticsearch.search.aggregations.support.MultiValuesSourceAggregationBuilder
doBuild, doWriteTo, equals, field, format, hashCode, internalXContent, userValueTypeHint
Methods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
build, getMetadata, getWriteableName, setMetadata, subAggregation, 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
-
VALUE_FIELD
-
WEIGHT_FIELD
-
PARSER
-
-
Constructor Details
-
WeightedAvgAggregationBuilder
public WeightedAvgAggregationBuilder(java.lang.String name) -
WeightedAvgAggregationBuilder
public WeightedAvgAggregationBuilder(WeightedAvgAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata) -
WeightedAvgAggregationBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
registerUsage
-
value
-
weight
-
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
-
defaultValueSourceType
Description copied from class:MultiValuesSourceAggregationBuilder
Aggregations should use this method to define aValuesSourceType
of last resort. This will only be used when the resolver can't find a field and the user hasn't provided a value type hint.- Specified by:
defaultValueSourceType
in classMultiValuesSourceAggregationBuilder<WeightedAvgAggregationBuilder>
- Returns:
- The CoreValuesSourceType we expect this script to yield.
-
innerWriteTo
Description copied from class:MultiValuesSourceAggregationBuilder
Write subclass' state to the stream- Specified by:
innerWriteTo
in classMultiValuesSourceAggregationBuilder<WeightedAvgAggregationBuilder>
-
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
-
innerBuild
protected MultiValuesSourceAggregatorFactory innerBuild(QueryShardContext queryShardContext, java.util.Map<java.lang.String,ValuesSourceConfig> configs, java.util.Map<java.lang.String,QueryBuilder> filters, DocValueFormat format, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) throws java.io.IOException- Specified by:
innerBuild
in classMultiValuesSourceAggregationBuilder<WeightedAvgAggregationBuilder>
- Throws:
java.io.IOException
-
doXContentBody
public XContentBuilder doXContentBody(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
doXContentBody
in classMultiValuesSourceAggregationBuilder<WeightedAvgAggregationBuilder>
- Throws:
java.io.IOException
-
getType
public java.lang.String getType()Description copied from interface:BaseAggregationBuilder
The name of the type of aggregation built by this builder.
-