Package org.opensearch.client.opensearch._types.aggregations

Class ScriptedMetricAggregation

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.AggregationBase

org.opensearch.client.opensearch._types.aggregations.MetricAggregationBase

org.opensearch.client.opensearch._types.aggregations.ScriptedMetricAggregation

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, AggregationVariant, ToCopyableBuilder<ScriptedMetricAggregation.Builder,ScriptedMetricAggregation>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class ScriptedMetricAggregation
extends MetricAggregationBase
implements AggregationVariant, ToCopyableBuilder<ScriptedMetricAggregation.Builder,ScriptedMetricAggregation>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScriptedMetricAggregation.Builder	Builder for ScriptedMetricAggregation.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.aggregations.MetricAggregationBase

MetricAggregationBase.AbstractBuilder<BuilderT extends MetricAggregationBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<ScriptedMetricAggregation>	_DESERIALIZER	Json deserializer for ScriptedMetricAggregation

Method Summary

Modifier and Type	Method	Description
Aggregation.Kind	_aggregationKind()	Aggregation variant kind.
static ScriptedMetricAggregation.Builder	builder()
final Script	combineScript()	API name: combine_script
boolean	equals(Object o)
int	hashCode()
final Script	initScript()	API name: init_script
final Script	mapScript()	API name: map_script
static ScriptedMetricAggregation	of(Function<ScriptedMetricAggregation.Builder,ObjectBuilder<ScriptedMetricAggregation>> fn)
final Map<String,JsonData>	params()	A global object with script parameters for init, map and combine scripts.
final Script	reduceScript()	API name: reduce_script
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupScriptedMetricAggregationDeserializer(ObjectDeserializer<ScriptedMetricAggregation.Builder> op)
ScriptedMetricAggregation.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.MetricAggregationBase

field, missing, script, setupMetricAggregationBaseDeserializer

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase

meta, name, serialize, setupAggregationBaseDeserializer

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.opensearch._types.aggregations.AggregationVariant

toAggregation

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ScriptedMetricAggregation> _DESERIALIZER

Json deserializer for ScriptedMetricAggregation

Method Details

of

public static ScriptedMetricAggregation of(Function<ScriptedMetricAggregation.Builder,ObjectBuilder<ScriptedMetricAggregation>> fn)

_aggregationKind

public Aggregation.Kind _aggregationKind()

Aggregation variant kind.

Specified by:

_aggregationKind in interface AggregationVariant

combineScript

@Nullable
public final Script combineScript()

API name: combine_script

initScript

@Nullable
public final Script initScript()

API name: init_script

mapScript

@Nullable
public final Script mapScript()

API name: map_script

params

@Nonnull
public final Map<String,JsonData> params()

A global object with script parameters for init, map and combine scripts. It is shared between the scripts.

API name: params

reduceScript

@Nullable
public final Script reduceScript()

API name: reduce_script

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class MetricAggregationBase

toBuilder

@Nonnull
public ScriptedMetricAggregation.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ScriptedMetricAggregation.Builder,ScriptedMetricAggregation>

Returns:

a new builder instance.

builder

@Nonnull
public static ScriptedMetricAggregation.Builder builder()

setupScriptedMetricAggregationDeserializer

protected static void setupScriptedMetricAggregationDeserializer(ObjectDeserializer<ScriptedMetricAggregation.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class MetricAggregationBase

equals

public boolean equals(Object o)

Overrides:

equals in class MetricAggregationBase