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

Class BucketCorrelationFunctionCountCorrelationIndicator.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch._types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator.Builder
All Implemented Interfaces:
ObjectBuilder<BucketCorrelationFunctionCountCorrelationIndicator>
Enclosing class:
BucketCorrelationFunctionCountCorrelationIndicator
public static class BucketCorrelationFunctionCountCorrelationIndicator.Builder
extends ObjectBuilderBase
implements ObjectBuilder<BucketCorrelationFunctionCountCorrelationIndicator>
Builder for BucketCorrelationFunctionCountCorrelationIndicator.

  • 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​(java.util.List<java.lang.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​(java.lang.Double value, java.lang.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​(java.util.List<java.lang.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​(java.lang.Double value, java.lang.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.

    • build

      public BucketCorrelationFunctionCountCorrelationIndicator build()
      Builds a BucketCorrelationFunctionCountCorrelationIndicator.
      Specified by:
      build in interface ObjectBuilder<BucketCorrelationFunctionCountCorrelationIndicator>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.