Module org.elasticsearch.server
Class ScriptedMetricAggregationBuilder
java.lang.Object
org.elasticsearch.search.aggregations.AggregationBuilder
org.elasticsearch.search.aggregations.AbstractAggregationBuilder<ScriptedMetricAggregationBuilder>
org.elasticsearch.search.aggregations.metrics.ScriptedMetricAggregationBuilder
- All Implemented Interfaces:
NamedWriteable,VersionedNamedWriteable,Writeable,Rewriteable<AggregationBuilder>,BaseAggregationBuilder,ToXContent,ToXContentFragment
public class ScriptedMetricAggregationBuilder
extends AbstractAggregationBuilder<ScriptedMetricAggregationBuilder>
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFieldsNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final ConstructingObjectParser<ScriptedMetricAggregationBuilder, String> Fields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
metadataFields inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
DEFAULT_PREALLOCATION, factoriesBuilder, nameFields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDSFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsModifierConstructorDescriptionRead from a stream.protectedScriptedMetricAggregationBuilder(ScriptedMetricAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) -
Method Summary
Modifier and TypeMethodDescriptionA rough count of the number of buckets thatAggregators built by this builder will contain per owning parent bucket.combineScript(Script combineScript) Set thecombinescript.protected org.elasticsearch.search.aggregations.metrics.ScriptedMetricAggregatorFactorydoBuild(AggregationContext context, AggregatorFactory parent, AggregatorFactories.Builder subfactoriesBuilder) protected voiddoWriteTo(StreamOutput out) booleanThe minimal version of the recipient this object can be sent togetType()The name of the type of aggregation built by this builder.inthashCode()initScript(Script initScript) Set theinitscript.protected XContentBuilderinternalXContent(XContentBuilder builder, ToXContent.Params builderParams) Set themapscript.Set parameters that will be available in theinit,mapandcombinephases.reduceScript(Script reduceScript) Set thereducescript.protected AggregationBuildershallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) Create a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilderandmetadata.booleansupportsParallelCollection(ToLongFunction<String> fieldCardinalityResolver) Return false if this aggregation or any of the child aggregations does not support parallel collection.booleanDoes this aggregation support running with in a sampling context.Methods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeToMethods inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
buildPipelineTree, bytesToPreallocate, deepCopy, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getQuery, getSubAggregations, isInSortOrderExecutionRequired, rewrite, toString, validateSequentiallyOrdered, validateSequentiallyOrderedWithoutGapsMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Field Details
-
NAME
- See Also:
-
PARSER
-
-
Constructor Details
-
ScriptedMetricAggregationBuilder
-
ScriptedMetricAggregationBuilder
protected ScriptedMetricAggregationBuilder(ScriptedMetricAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) -
ScriptedMetricAggregationBuilder
Read from a stream.- Throws:
IOException
-
-
Method Details
-
shallowCopy
protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) Description copied from class:AggregationBuilderCreate a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilderandmetadata.- Specified by:
shallowCopyin classAggregationBuilder
-
doWriteTo
- Specified by:
doWriteToin classAbstractAggregationBuilder<ScriptedMetricAggregationBuilder>- Throws:
IOException
-
supportsSampling
public boolean supportsSampling()Description copied from class:AggregationBuilderDoes this aggregation support running with in a sampling context. By default, it's false for all aggregations. If the sub-classed builder supports sampling, be sure of the following that the resulting internal aggregation objects override theInternalAggregation.finalizeSampling(SamplingContext)and scales any values that require scaling.- Overrides:
supportsSamplingin classAggregationBuilder- Returns:
- does this aggregation builder support sampling
-
initScript
Set theinitscript. -
mapScript
Set themapscript. -
combineScript
Set thecombinescript. -
reduceScript
Set thereducescript. -
params
Set parameters that will be available in theinit,mapandcombinephases. -
bucketCardinality
Description copied from class:AggregationBuilderA rough count of the number of buckets thatAggregators built by this builder will contain per owning parent bucket.- Specified by:
bucketCardinalityin classAggregationBuilder
-
doBuild
protected org.elasticsearch.search.aggregations.metrics.ScriptedMetricAggregatorFactory doBuild(AggregationContext context, AggregatorFactory parent, AggregatorFactories.Builder subfactoriesBuilder) throws IOException - Specified by:
doBuildin classAbstractAggregationBuilder<ScriptedMetricAggregationBuilder>- Throws:
IOException
-
internalXContent
protected XContentBuilder internalXContent(XContentBuilder builder, ToXContent.Params builderParams) throws IOException - Specified by:
internalXContentin classAbstractAggregationBuilder<ScriptedMetricAggregationBuilder>- Throws:
IOException
-
getType
Description copied from interface:BaseAggregationBuilderThe name of the type of aggregation built by this builder. -
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteableThe minimal version of the recipient this object can be sent to -
supportsParallelCollection
Description copied from class:AggregationBuilderReturn false if this aggregation or any of the child aggregations does not support parallel collection. As a result, a request including such aggregation is always executed sequentially despite concurrency is enabled for the query phase.- Overrides:
supportsParallelCollectionin classAggregationBuilder
-
hashCode
public int hashCode()- Overrides:
hashCodein classAbstractAggregationBuilder<ScriptedMetricAggregationBuilder>
-
equals
- Overrides:
equalsin classAbstractAggregationBuilder<ScriptedMetricAggregationBuilder>
-