Package co.elastic.clients.elasticsearch.ml

Class PerPartitionCategorization

java.lang.Object

co.elastic.clients.elasticsearch.ml.PerPartitionCategorization

All Implemented Interfaces:

JsonpSerializable

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	enabled()	To enable this setting, you must also set the partition_field_name property to the same value in every detector that uses the keyword mlcategory.
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	setupPerPartitionCategorizationDeserializer(DelegatingDeserializer<PerPartitionCategorization.Builder> op)
java.lang.Boolean	stopOnWarn()	This setting can be set to true only if per-partition categorization is enabled.

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<PerPartitionCategorization> _DESERIALIZER

Json deserializer for PerPartitionCategorization

Constructor Details

PerPartitionCategorization

public PerPartitionCategorization(PerPartitionCategorization.Builder builder)

PerPartitionCategorization

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

Method Details

enabled

@Nullable
public java.lang.Boolean enabled()

To enable this setting, you must also set the partition_field_name property to the same value in every detector that uses the keyword mlcategory. Otherwise, job creation fails.

API name: enabled

stopOnWarn

@Nullable
public java.lang.Boolean stopOnWarn()

This setting can be set to true only if per-partition categorization is enabled. If true, both categorization and subsequent anomaly detection stops for partitions where the categorization status changes to warn. This setting makes it viable to have a job where it is expected that categorization works well for some partitions but not others; you do not pay the cost of bad categorization forever in the partitions where it works badly.

API name: stop_on_warn

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)

setupPerPartitionCategorizationDeserializer

protected static void setupPerPartitionCategorizationDeserializer(DelegatingDeserializer<PerPartitionCategorization.Builder> op)