Package co.elastic.clients.elasticsearch.ml

Class AnomalyExplanation.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.ml.AnomalyExplanation.Builder

All Implemented Interfaces:

WithJson<AnomalyExplanation.Builder>, ObjectBuilder<AnomalyExplanation>

Enclosing class:

AnomalyExplanation

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

Builder for AnomalyExplanation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final AnomalyExplanation.Builder	anomalyCharacteristicsImpact(Integer value)	Impact from the duration and magnitude of the detected anomaly relative to the historical average.
final AnomalyExplanation.Builder	anomalyLength(Integer value)	Length of the detected anomaly in the number of buckets.
final AnomalyExplanation.Builder	anomalyType(String value)	Type of the detected anomaly: spike or dip.
AnomalyExplanation	build()	Builds a AnomalyExplanation.
final AnomalyExplanation.Builder	highVariancePenalty(Boolean value)	Indicates reduction of anomaly score for the bucket with large confidence intervals.
final AnomalyExplanation.Builder	incompleteBucketPenalty(Boolean value)	If the bucket contains fewer samples than expected, the score is reduced.
final AnomalyExplanation.Builder	lowerConfidenceBound(Double value)	Lower bound of the 95% confidence interval.
final AnomalyExplanation.Builder	multiBucketImpact(Integer value)	Impact of the deviation between actual and typical values in the past 12 buckets.
protected AnomalyExplanation.Builder	self()
final AnomalyExplanation.Builder	singleBucketImpact(Integer value)	Impact of the deviation between actual and typical values in the current bucket.
final AnomalyExplanation.Builder	typicalValue(Double value)	Typical (expected) value for this bucket.
final AnomalyExplanation.Builder	upperConfidenceBound(Double value)	Upper bound of the 95% confidence interval.

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

anomalyCharacteristicsImpact

public final AnomalyExplanation.Builder anomalyCharacteristicsImpact(@Nullable
 Integer value)

Impact from the duration and magnitude of the detected anomaly relative to the historical average.

API name: anomaly_characteristics_impact

anomalyLength

public final AnomalyExplanation.Builder anomalyLength(@Nullable
 Integer value)

Length of the detected anomaly in the number of buckets.

API name: anomaly_length

anomalyType

public final AnomalyExplanation.Builder anomalyType(@Nullable
 String value)

Type of the detected anomaly: spike or dip.

API name: anomaly_type

highVariancePenalty

public final AnomalyExplanation.Builder highVariancePenalty(@Nullable
 Boolean value)

Indicates reduction of anomaly score for the bucket with large confidence intervals. If a bucket has large confidence intervals, the score is reduced.

API name: high_variance_penalty

incompleteBucketPenalty

public final AnomalyExplanation.Builder incompleteBucketPenalty(@Nullable
 Boolean value)

If the bucket contains fewer samples than expected, the score is reduced.

API name: incomplete_bucket_penalty

lowerConfidenceBound

public final AnomalyExplanation.Builder lowerConfidenceBound(@Nullable
 Double value)

Lower bound of the 95% confidence interval.

API name: lower_confidence_bound

multiBucketImpact

public final AnomalyExplanation.Builder multiBucketImpact(@Nullable
 Integer value)

Impact of the deviation between actual and typical values in the past 12 buckets.

API name: multi_bucket_impact

singleBucketImpact

public final AnomalyExplanation.Builder singleBucketImpact(@Nullable
 Integer value)

Impact of the deviation between actual and typical values in the current bucket.

API name: single_bucket_impact

typicalValue

public final AnomalyExplanation.Builder typicalValue(@Nullable
 Double value)

Typical (expected) value for this bucket.

API name: typical_value

upperConfidenceBound

public final AnomalyExplanation.Builder upperConfidenceBound(@Nullable
 Double value)

Upper bound of the 95% confidence interval.

API name: upper_confidence_bound

self

protected AnomalyExplanation.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<AnomalyExplanation.Builder>

build

public AnomalyExplanation build()

Builds a AnomalyExplanation.

Specified by:

build in interface ObjectBuilder<AnomalyExplanation>

Throws:

NullPointerException - if some of the required fields are null.