Class BucketCorrelationAggregation
java.lang.Object
co.elastic.clients.elasticsearch._types.aggregations.AggregationBase
co.elastic.clients.elasticsearch._types.aggregations.BucketPathAggregation
co.elastic.clients.elasticsearch._types.aggregations.BucketCorrelationAggregation
- All Implemented Interfaces:
AggregationVariant
,JsonpSerializable
@JsonpDeserializable public class BucketCorrelationAggregation extends BucketPathAggregation implements AggregationVariant
A sibling pipeline aggregation which executes a correlation function on the
configured sibling multi-bucket aggregation.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
BucketCorrelationAggregation.Builder
Builder forBucketCorrelationAggregation
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketPathAggregation
BucketPathAggregation.AbstractBuilder<BuilderT extends BucketPathAggregation.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<BucketCorrelationAggregation>
_DESERIALIZER
Json deserializer forBucketCorrelationAggregation
-
Method Summary
Modifier and Type Method Description Aggregation.Kind
_aggregationKind()
Aggregation variant kind.BucketCorrelationFunction
function()
Required - The correlation function to execute.static BucketCorrelationAggregation
of(java.util.function.Function<BucketCorrelationAggregation.Builder,ObjectBuilder<BucketCorrelationAggregation>> fn)
protected void
serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void
setupBucketCorrelationAggregationDeserializer(ObjectDeserializer<BucketCorrelationAggregation.Builder> op)
Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketPathAggregation
bucketsPath, setupBucketPathAggregationDeserializer
Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase
meta, name, serialize, setupAggregationBaseDeserializer, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface co.elastic.clients.elasticsearch._types.aggregations.AggregationVariant
_toAggregation
-
Field Details
-
_DESERIALIZER
Json deserializer forBucketCorrelationAggregation
-
-
Method Details
-
of
public static BucketCorrelationAggregation of(java.util.function.Function<BucketCorrelationAggregation.Builder,ObjectBuilder<BucketCorrelationAggregation>> fn) -
_aggregationKind
Aggregation variant kind.- Specified by:
_aggregationKind
in interfaceAggregationVariant
-
function
Required - The correlation function to execute.API name:
function
-
serializeInternal
- Overrides:
serializeInternal
in classBucketPathAggregation
-
setupBucketCorrelationAggregationDeserializer
protected static void setupBucketCorrelationAggregationDeserializer(ObjectDeserializer<BucketCorrelationAggregation.Builder> op)
-