Class BucketKsAggregation.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder<BuilderT>
co.elastic.clients.elasticsearch._types.aggregations.BucketPathAggregation.AbstractBuilder<BucketKsAggregation.Builder>
co.elastic.clients.elasticsearch._types.aggregations.BucketKsAggregation.Builder
- All Implemented Interfaces:
WithJson<BucketKsAggregation.Builder>
,ObjectBuilder<BucketKsAggregation>
- Enclosing class:
- BucketKsAggregation
public static class BucketKsAggregation.Builder
extends BucketPathAggregation.AbstractBuilder<BucketKsAggregation.Builder>
implements ObjectBuilder<BucketKsAggregation>
Builder for
BucketKsAggregation
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionalternative
(String value, String... values) A list of string values indicating which K-S test alternative to calculate.alternative
(List<String> list) A list of string values indicating which K-S test alternative to calculate.build()
Builds aBucketKsAggregation
.A list of doubles indicating the distribution of the samples with which to compare to thebuckets_path
results.A list of doubles indicating the distribution of the samples with which to compare to thebuckets_path
results.samplingMethod
(String value) Indicates the sampling methodology when calculating the K-S test.protected BucketKsAggregation.Builder
self()
Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketPathAggregation.AbstractBuilder
bucketsPath, bucketsPath
Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder
meta, meta, name
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
alternative
A list of string values indicating which K-S test alternative to calculate. The valid values are: "greater", "less", "two_sided". This parameter is key for determining the K-S statistic used when calculating the K-S test. Default value is all possible alternative hypotheses.API name:
alternative
Adds all elements of
list
toalternative
. -
alternative
A list of string values indicating which K-S test alternative to calculate. The valid values are: "greater", "less", "two_sided". This parameter is key for determining the K-S statistic used when calculating the K-S test. Default value is all possible alternative hypotheses.API name:
alternative
Adds one or more values to
alternative
. -
fractions
A list of doubles indicating the distribution of the samples with which to compare to thebuckets_path
results. In typical usage this is the overall proportion of documents in each bucket, which is compared with the actual document proportions in each bucket from the sibling aggregation counts. The default is to assume that overall documents are uniformly distributed on these buckets, which they would be if one used equal percentiles of a metric to define the bucket end points.API name:
fractions
Adds all elements of
list
tofractions
. -
fractions
A list of doubles indicating the distribution of the samples with which to compare to thebuckets_path
results. In typical usage this is the overall proportion of documents in each bucket, which is compared with the actual document proportions in each bucket from the sibling aggregation counts. The default is to assume that overall documents are uniformly distributed on these buckets, which they would be if one used equal percentiles of a metric to define the bucket end points.API name:
fractions
Adds one or more values to
fractions
. -
samplingMethod
Indicates the sampling methodology when calculating the K-S test. Note, this is sampling of the returned values. This determines the cumulative distribution function (CDF) points used comparing the two samples. Default isupper_tail
, which emphasizes the upper end of the CDF points. Valid options are:upper_tail
,uniform
, andlower_tail
.API name:
sampling_method
-
self
- Specified by:
self
in classAggregationBase.AbstractBuilder<BucketKsAggregation.Builder>
-
build
Builds aBucketKsAggregation
.- Specified by:
build
in interfaceObjectBuilder<BucketKsAggregation>
- Throws:
NullPointerException
- if some of the required fields are null.
-