BucketCorrelationFunction (java-client 8.2.1 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.aggregations.BucketCorrelationFunction

All Implemented Interfaces:: JsonpSerializable

@JsonpDeserializable
public class BucketCorrelationFunction
extends java.lang.Object
implements JsonpSerializable

See Also:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class BucketCorrelationFunction.Builder
Builder for BucketCorrelationFunction.
Field Summary

Fields

Modifier and Type Field Description

static JsonpDeserializer<BucketCorrelationFunction> _DESERIALIZER
Json deserializer for BucketCorrelationFunction

Method Summary

Modifier and Type	Method	Description
`BucketCorrelationFunctionCountCorrelation`	`countCorrelation()`	Required - The configuration to calculate a count correlation.
`static BucketCorrelationFunction`	`of(java.util.function.Function<BucketCorrelationFunction.Builder,ObjectBuilder<BucketCorrelationFunction>> fn)`
`void`	`serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`	Serialize this object to JSON.
`protected void`	`serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`
`protected static void`	`setupBucketCorrelationFunctionDeserializer(ObjectDeserializer<BucketCorrelationFunction.Builder> op)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- _DESERIALIZER
  
  public static final JsonpDeserializer<BucketCorrelationFunction> _DESERIALIZER
  
  Json deserializer for BucketCorrelationFunction
Method Details
- of
  
  public static BucketCorrelationFunction of(java.util.function.Function<BucketCorrelationFunction.Builder,ObjectBuilder<BucketCorrelationFunction>> fn)
- countCorrelation
  
  public final BucketCorrelationFunctionCountCorrelation countCorrelation()
  
  Required - The configuration to calculate a count correlation. This function is designed for determining the correlation of a term value and a given metric.
  API name: count_correlation
- serialize
  
  public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
  
  Serialize this object to JSON.
  
  Specified by:
  
  serialize in interface JsonpSerializable
- serializeInternal
  
  protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object
- setupBucketCorrelationFunctionDeserializer
  
  protected static void setupBucketCorrelationFunctionDeserializer(ObjectDeserializer<BucketCorrelationFunction.Builder> op)