Package co.elastic.clients.elasticsearch.ml

Class PerPartitionCategorization

java.lang.Object

co.elastic.clients.elasticsearch.ml.PerPartitionCategorization

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PerPartitionCategorization
extends Object
implements JsonpSerializable

See Also:

• API specification

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

Method Summary

Modifier and Type	Method	Description
final 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.
static PerPartitionCategorization	of(Function<PerPartitionCategorization.Builder,ObjectBuilder<PerPartitionCategorization>> fn)
PerPartitionCategorization.Builder	rebuild()
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(ObjectDeserializer<PerPartitionCategorization.Builder> op)
final Boolean	stopOnWarn()	This setting can be set to true only if per-partition categorization is enabled.
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<PerPartitionCategorization> _DESERIALIZER

Json deserializer for PerPartitionCategorization

Method Details

of

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

enabled

@Nullable
public final 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 final 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)

toString

public String toString()

Overrides:

toString in class Object

rebuild

public PerPartitionCategorization.Builder rebuild()

Returns:

New PerPartitionCategorization.Builder initialized with field values of this instance

setupPerPartitionCategorizationDeserializer

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