Package co.elastic.clients.elasticsearch._types.aggregations

Class BucketCorrelationFunctionCountCorrelationIndicator

java.lang.Object

co.elastic.clients.elasticsearch._types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator

All Implemented Interfaces:

JsonpSerializable

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

See Also:

API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
int	docCount()	Required - The total number of documents that initially created the expectations.
java.util.List<java.lang.Double>	expectations()	Required - An array of numbers with which to correlate the configured bucket_path values.
java.util.List<java.lang.Double>	fractions()	An array of fractions to use when averaging and calculating variance.
static BucketCorrelationFunctionCountCorrelationIndicator	of(java.util.function.Function<BucketCorrelationFunctionCountCorrelationIndicator.Builder,ObjectBuilder<BucketCorrelationFunctionCountCorrelationIndicator>> 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	setupBucketCorrelationFunctionCountCorrelationIndicatorDeserializer(ObjectDeserializer<BucketCorrelationFunctionCountCorrelationIndicator.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<BucketCorrelationFunctionCountCorrelationIndicator> _DESERIALIZER

Json deserializer for BucketCorrelationFunctionCountCorrelationIndicator

Method Details

of

public static BucketCorrelationFunctionCountCorrelationIndicator of(java.util.function.Function<BucketCorrelationFunctionCountCorrelationIndicator.Builder,ObjectBuilder<BucketCorrelationFunctionCountCorrelationIndicator>> fn)

docCount

public final int docCount()

Required - The total number of documents that initially created the expectations. It’s required to be greater than or equal to the sum of all values in the buckets_path as this is the originating superset of data to which the term values are correlated.

API name: doc_count

expectations

public final java.util.List<java.lang.Double> expectations()

Required - An array of numbers with which to correlate the configured bucket_path values. The length of this value must always equal the number of buckets returned by the bucket_path.

API name: expectations

fractions

public final java.util.List<java.lang.Double> fractions()

An array of fractions to use when averaging and calculating variance. This should be used if the pre-calculated data and the buckets_path have known gaps. The length of fractions, if provided, must equal expectations.

API name: fractions

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

setupBucketCorrelationFunctionCountCorrelationIndicatorDeserializer

protected static void setupBucketCorrelationFunctionCountCorrelationIndicatorDeserializer(ObjectDeserializer<BucketCorrelationFunctionCountCorrelationIndicator.Builder> op)