Class ScriptedMetricAggregationBuilder
- java.lang.Object
-
- org.elasticsearch.search.aggregations.AggregationBuilder
-
- org.elasticsearch.search.aggregations.AbstractAggregationBuilder<ScriptedMetricAggregationBuilder>
-
- org.elasticsearch.search.aggregations.metrics.scripted.ScriptedMetricAggregationBuilder
-
- All Implemented Interfaces:
NamedWriteable
,Writeable
,ToXContent
,ToXContentFragment
,BaseAggregationBuilder
public class ScriptedMetricAggregationBuilder extends AbstractAggregationBuilder<ScriptedMetricAggregationBuilder>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
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
-
Fields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
metaData
-
Fields inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
factoriesBuilder, name
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Modifier Constructor Description ScriptedMetricAggregationBuilder(java.lang.String name)
ScriptedMetricAggregationBuilder(StreamInput in)
Read from a stream.protected
ScriptedMetricAggregationBuilder(ScriptedMetricAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)
-
Method Summary
Modifier and Type Method Description Script
combineScript()
Get thecombine
script.ScriptedMetricAggregationBuilder
combineScript(Script combineScript)
Set thecombine
script.protected ScriptedMetricAggregatorFactory
doBuild(SearchContext context, AggregatorFactory<?> parent, AggregatorFactories.Builder subfactoriesBuilder)
protected boolean
doEquals(java.lang.Object obj)
protected int
doHashCode()
protected void
doWriteTo(StreamOutput out)
java.lang.String
getType()
The name of the type of aggregation built by this builder.Script
initScript()
Get theinit
script.ScriptedMetricAggregationBuilder
initScript(Script initScript)
Set theinit
script.protected XContentBuilder
internalXContent(XContentBuilder builder, ToXContent.Params builderParams)
Script
mapScript()
Get themap
script.ScriptedMetricAggregationBuilder
mapScript(Script mapScript)
Set themap
script.java.util.Map<java.lang.String,java.lang.Object>
params()
Get parameters that will be available in theinit
,map
andcombine
phases.ScriptedMetricAggregationBuilder
params(java.util.Map<java.lang.String,java.lang.Object> params)
Set parameters that will be available in theinit
,map
andcombine
phases.static ScriptedMetricAggregationBuilder
parse(java.lang.String aggregationName, XContentParser parser)
Script
reduceScript()
Get thereduce
script.ScriptedMetricAggregationBuilder
reduceScript(Script reduceScript)
Set thereduce
script.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
.-
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
doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment
isFragment
-
-
-
-
Field Detail
-
NAME
public static final java.lang.String NAME
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ScriptedMetricAggregationBuilder
public ScriptedMetricAggregationBuilder(java.lang.String name)
-
ScriptedMetricAggregationBuilder
protected ScriptedMetricAggregationBuilder(ScriptedMetricAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)
-
ScriptedMetricAggregationBuilder
public ScriptedMetricAggregationBuilder(StreamInput in) throws java.io.IOException
Read from a stream.- Throws:
java.io.IOException
-
-
Method Detail
-
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
-
doWriteTo
protected void doWriteTo(StreamOutput out) throws java.io.IOException
- Specified by:
doWriteTo
in classAbstractAggregationBuilder<ScriptedMetricAggregationBuilder>
- Throws:
java.io.IOException
-
initScript
public ScriptedMetricAggregationBuilder initScript(Script initScript)
Set theinit
script.
-
initScript
public Script initScript()
Get theinit
script.
-
mapScript
public ScriptedMetricAggregationBuilder mapScript(Script mapScript)
Set themap
script.
-
mapScript
public Script mapScript()
Get themap
script.
-
combineScript
public ScriptedMetricAggregationBuilder combineScript(Script combineScript)
Set thecombine
script.
-
combineScript
public Script combineScript()
Get thecombine
script.
-
reduceScript
public ScriptedMetricAggregationBuilder reduceScript(Script reduceScript)
Set thereduce
script.
-
reduceScript
public Script reduceScript()
Get thereduce
script.
-
params
public ScriptedMetricAggregationBuilder params(java.util.Map<java.lang.String,java.lang.Object> params)
Set parameters that will be available in theinit
,map
andcombine
phases.
-
params
public java.util.Map<java.lang.String,java.lang.Object> params()
Get parameters that will be available in theinit
,map
andcombine
phases.
-
doBuild
protected ScriptedMetricAggregatorFactory doBuild(SearchContext context, AggregatorFactory<?> parent, AggregatorFactories.Builder subfactoriesBuilder) throws java.io.IOException
- Specified by:
doBuild
in classAbstractAggregationBuilder<ScriptedMetricAggregationBuilder>
- Throws:
java.io.IOException
-
internalXContent
protected XContentBuilder internalXContent(XContentBuilder builder, ToXContent.Params builderParams) throws java.io.IOException
- Specified by:
internalXContent
in classAbstractAggregationBuilder<ScriptedMetricAggregationBuilder>
- Throws:
java.io.IOException
-
parse
public static ScriptedMetricAggregationBuilder parse(java.lang.String aggregationName, XContentParser parser) throws java.io.IOException
- 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.
-
doHashCode
protected int doHashCode()
- Specified by:
doHashCode
in classAbstractAggregationBuilder<ScriptedMetricAggregationBuilder>
-
doEquals
protected boolean doEquals(java.lang.Object obj)
- Specified by:
doEquals
in classAbstractAggregationBuilder<ScriptedMetricAggregationBuilder>
-
-