Class ScriptedMetricAggregation.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.aggregations.MetricAggregationBase.AbstractBuilder<ScriptedMetricAggregation.Builder>
org.opensearch.client.opensearch._types.aggregations.ScriptedMetricAggregation.Builder
- All Implemented Interfaces:
CopyableBuilder<ScriptedMetricAggregation.Builder,,ScriptedMetricAggregation> MutableBuilder<ScriptedMetricAggregation.Builder,,ScriptedMetricAggregation> ObjectBuilder<ScriptedMetricAggregation>
- Enclosing class:
ScriptedMetricAggregation
public static class ScriptedMetricAggregation.Builder
extends MetricAggregationBase.AbstractBuilder<ScriptedMetricAggregation.Builder>
implements CopyableBuilder<ScriptedMetricAggregation.Builder,ScriptedMetricAggregation>
Builder for
ScriptedMetricAggregation.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aScriptedMetricAggregation.API name:combine_scriptcombineScript(Script value) API name:combine_scriptcopy()Create a new builderCopyableBuilderthat is a copy of this one.API name:init_scriptinitScript(Script value) API name:init_scriptAPI name:map_scriptAPI name:map_scriptA global object with script parameters forinit,mapandcombinescripts.A global object with script parameters forinit,mapandcombinescripts.API name:reduce_scriptreduceScript(Script value) API name:reduce_scriptprotected ScriptedMetricAggregation.Builderself()Methods inherited from class org.opensearch.client.opensearch._types.aggregations.MetricAggregationBase.AbstractBuilder
field, missing, missing, script, scriptMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<ScriptedMetricAggregation.Builder,ScriptedMetricAggregation> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classMetricAggregationBase.AbstractBuilder<ScriptedMetricAggregation.Builder>
-
combineScript
API name:combine_script -
combineScript
@Nonnull public final ScriptedMetricAggregation.Builder combineScript(Function<Script.Builder, ObjectBuilder<Script>> fn) API name:combine_script -
initScript
API name:init_script -
initScript
@Nonnull public final ScriptedMetricAggregation.Builder initScript(Function<Script.Builder, ObjectBuilder<Script>> fn) API name:init_script -
mapScript
API name:map_script -
mapScript
@Nonnull public final ScriptedMetricAggregation.Builder mapScript(Function<Script.Builder, ObjectBuilder<Script>> fn) API name:map_script -
params
A global object with script parameters forinit,mapandcombinescripts. It is shared between the scripts.API name:
paramsAdds all elements of
maptoparams. -
params
A global object with script parameters forinit,mapandcombinescripts. It is shared between the scripts.API name:
paramsAdds an entry to
params. -
reduceScript
API name:reduce_script -
reduceScript
@Nonnull public final ScriptedMetricAggregation.Builder reduceScript(Function<Script.Builder, ObjectBuilder<Script>> fn) API name:reduce_script -
build
Builds aScriptedMetricAggregation.- Specified by:
buildin interfaceObjectBuilder<ScriptedMetricAggregation>- Throws:
NullPointerException- if some of the required fields are null.
-