Package co.elastic.clients.elasticsearch.ml

Class DetectorUpdate

java.lang.Object

co.elastic.clients.elasticsearch.ml.DetectorUpdate

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class DetectorUpdate
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final List<DetectionRule>	customRules()	An array of custom rule objects, which enable you to customize the way detectors operate.
final String	description()	A description of the detector.
final int	detectorIndex()	Required - A unique identifier for the detector.
static DetectorUpdate	of(Function<DetectorUpdate.Builder,ObjectBuilder<DetectorUpdate>> 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	setupDetectorUpdateDeserializer(ObjectDeserializer<DetectorUpdate.Builder> op)
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<DetectorUpdate> _DESERIALIZER

Json deserializer for DetectorUpdate

Method Details

of

public static DetectorUpdate of(Function<DetectorUpdate.Builder,ObjectBuilder<DetectorUpdate>> fn)

detectorIndex

public final int detectorIndex()

Required - A unique identifier for the detector. This identifier is based on the order of the detectors in the analysis_config, starting at zero.

API name: detector_index

description

@Nullable
public final String description()

A description of the detector.

API name: description

customRules

public final List<DetectionRule> customRules()

An array of custom rule objects, which enable you to customize the way detectors operate. For example, a rule may dictate to the detector conditions under which results should be skipped. Kibana refers to custom rules as job rules.

API name: custom_rules

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 String toString()

Overrides:

toString in class Object

setupDetectorUpdateDeserializer

protected static void setupDetectorUpdateDeserializer(ObjectDeserializer<DetectorUpdate.Builder> op)