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

Class PipelineAggregationBase

java.lang.Object

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

org.opensearch.client.opensearch._types.aggregations.BucketPathAggregation

org.opensearch.client.opensearch._types.aggregations.PipelineAggregationBase

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

Direct Known Subclasses:

AverageBucketAggregation, BucketScriptAggregation, BucketSelectorAggregation, CumulativeCardinalityAggregation, CumulativeSumAggregation, DerivativeAggregation, ExtendedStatsBucketAggregation, MaxBucketAggregation, MinBucketAggregation, MovingAverageAggregationBase, MovingFunctionAggregation, MovingPercentilesAggregation, NormalizeAggregation, PercentilesBucketAggregation, SerialDifferencingAggregation, StatsBucketAggregation, SumBucketAggregation

@Generated("org.opensearch.client.codegen.CodeGenerator")
public abstract class PipelineAggregationBase
extends BucketPathAggregation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PipelineAggregationBase.AbstractBuilder<BuilderT extends PipelineAggregationBase.AbstractBuilder<BuilderT>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PipelineAggregationBase(PipelineAggregationBase.AbstractBuilder<?> builder)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
final String	format()	DecimalFormat pattern for the output value.
final GapPolicy	gapPolicy()	API name: gap_policy
int	hashCode()
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static <BuilderT extends PipelineAggregationBase.AbstractBuilder<BuilderT>> void	setupPipelineAggregationBaseDeserializer(ObjectDeserializer<BuilderT> op)

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

bucketsPath, setupBucketPathAggregationDeserializer

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.json.PlainJsonSerializable

toJsonString

Constructor Details

PipelineAggregationBase

protected PipelineAggregationBase(PipelineAggregationBase.AbstractBuilder<?> builder)

Method Details

format

@Nullable
public final String format()

DecimalFormat pattern for the output value. If specified, the formatted value is returned in the aggregation's value_as_string property.

API name: format

gapPolicy

@Nullable
public final GapPolicy gapPolicy()

API name: gap_policy

serializeInternal

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

Overrides:

serializeInternal in class BucketPathAggregation

setupPipelineAggregationBaseDeserializer

protected static <BuilderT extends PipelineAggregationBase.AbstractBuilder<BuilderT>>
void setupPipelineAggregationBaseDeserializer(ObjectDeserializer<BuilderT> op)

hashCode

public int hashCode()

Overrides:

hashCode in class BucketPathAggregation

equals

public boolean equals(Object o)

Overrides:

equals in class BucketPathAggregation