Package co.elastic.clients.elasticsearch.ml

Class DetectionRule

java.lang.Object

co.elastic.clients.elasticsearch.ml.DetectionRule

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public final class DetectionRule
extends java.lang.Object
implements JsonpSerializable

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 JsonpDeserializer<DetectionRule>	_DESERIALIZER	Json deserializer for DetectionRule

Constructor Summary

Constructors

Constructor	Description
DetectionRule(DetectionRule.Builder builder)
DetectionRule(java.util.function.Function<DetectionRule.Builder,DetectionRule.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.util.List<RuleAction>	actions()	The set of actions to be triggered when the rule applies.
java.util.List<RuleCondition>	conditions()	An array of numeric conditions when the rule applies.
java.util.Map<java.lang.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(DelegatingDeserializer<DetectionRule.Builder> op)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<DetectionRule> _DESERIALIZER

Json deserializer for DetectionRule

Constructor Details

DetectionRule

public DetectionRule(DetectionRule.Builder builder)

DetectionRule

public DetectionRule(java.util.function.Function<DetectionRule.Builder,DetectionRule.Builder> fn)

Method Details

actions

@Nullable
public java.util.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

@Nullable
public java.util.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

@Nullable
public java.util.Map<java.lang.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)

setupDetectionRuleDeserializer

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