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

Class BucketCorrelationFunctionCountCorrelationIndicator.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BucketCorrelationFunctionCountCorrelationIndicator.Builder>

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

All Implemented Interfaces:

WithJson<BucketCorrelationFunctionCountCorrelationIndicator.Builder>, ObjectBuilder<BucketCorrelationFunctionCountCorrelationIndicator>

Enclosing class:

BucketCorrelationFunctionCountCorrelationIndicator

public static class BucketCorrelationFunctionCountCorrelationIndicator.Builder
extends WithJsonObjectBuilderBase<BucketCorrelationFunctionCountCorrelationIndicator.Builder>
implements ObjectBuilder<BucketCorrelationFunctionCountCorrelationIndicator>

Builder for BucketCorrelationFunctionCountCorrelationIndicator.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BucketCorrelationFunctionCountCorrelationIndicator	build()	Builds a BucketCorrelationFunctionCountCorrelationIndicator.
final BucketCorrelationFunctionCountCorrelationIndicator.Builder	docCount(int value)	Required - The total number of documents that initially created the expectations.
final BucketCorrelationFunctionCountCorrelationIndicator.Builder	expectations(Double value, Double... values)	Required - An array of numbers with which to correlate the configured bucket_path values.
final BucketCorrelationFunctionCountCorrelationIndicator.Builder	expectations(List<Double> list)	Required - An array of numbers with which to correlate the configured bucket_path values.
final BucketCorrelationFunctionCountCorrelationIndicator.Builder	fractions(Double value, Double... values)	An array of fractions to use when averaging and calculating variance.
final BucketCorrelationFunctionCountCorrelationIndicator.Builder	fractions(List<Double> list)	An array of fractions to use when averaging and calculating variance.
protected BucketCorrelationFunctionCountCorrelationIndicator.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

docCount

public final BucketCorrelationFunctionCountCorrelationIndicator.Builder docCount(int value)

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 BucketCorrelationFunctionCountCorrelationIndicator.Builder expectations(List<Double> list)

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

Adds all elements of list to expectations.

expectations

public final BucketCorrelationFunctionCountCorrelationIndicator.Builder expectations(Double value,
 Double... values)

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

Adds one or more values to expectations.

fractions

public final BucketCorrelationFunctionCountCorrelationIndicator.Builder fractions(List<Double> list)

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

Adds all elements of list to fractions.

fractions

public final BucketCorrelationFunctionCountCorrelationIndicator.Builder fractions(Double value,
 Double... values)

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

Adds one or more values to fractions.

self

protected BucketCorrelationFunctionCountCorrelationIndicator.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<BucketCorrelationFunctionCountCorrelationIndicator.Builder>

build

public BucketCorrelationFunctionCountCorrelationIndicator build()

Builds a BucketCorrelationFunctionCountCorrelationIndicator.

Specified by:

build in interface ObjectBuilder<BucketCorrelationFunctionCountCorrelationIndicator>

Throws:

NullPointerException - if some of the required fields are null.