Package co.elastic.clients.elasticsearch.ml

Class DetectionRule

java.lang.Object

co.elastic.clients.elasticsearch.ml.DetectionRule

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class DetectionRule
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final List<RuleAction>	actions()	The set of actions to be triggered when the rule applies.
final List<RuleCondition>	conditions()	An array of numeric conditions when the rule applies.
static DetectionRule	of(Function<DetectionRule.Builder,ObjectBuilder<DetectionRule>> fn)
final Map<String,FilterRef>	scope()	A scope of series where the rule applies.
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	setupDetectionRuleDeserializer(ObjectDeserializer<DetectionRule.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<DetectionRule> _DESERIALIZER

Json deserializer for DetectionRule

Method Details

of

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

actions

public final List<RuleAction> actions()

The set of actions to be triggered when the rule applies. If more than one action is specified the effects of all actions are combined.

API name: actions

conditions

public final List<RuleCondition> conditions()

An array of numeric conditions when the rule applies. A rule must either have a non-empty scope or at least one condition. Multiple conditions are combined together with a logical AND.

API name: conditions

scope

public final Map<String,FilterRef> scope()

A scope of series where the rule applies. A rule must either have a non-empty scope or at least one condition. By default, the scope includes all series. Scoping is allowed for any of the fields that are also specified in by_field_name, over_field_name, or partition_field_name.

API name: scope

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

setupDetectionRuleDeserializer

protected static void setupDetectionRuleDeserializer(ObjectDeserializer<DetectionRule.Builder> op)