Package co.elastic.clients.elasticsearch.ml

Class PerPartitionCategorization.Builder

java.lang.Object
co.elastic.clients.elasticsearch.ml.PerPartitionCategorization.Builder
All Implemented Interfaces:
ObjectBuilder<PerPartitionCategorization>
Enclosing class:
PerPartitionCategorization
public static class PerPartitionCategorization.Builder
extends java.lang.Object
implements ObjectBuilder<PerPartitionCategorization>
Builder for PerPartitionCategorization.

  • Constructor Summary

    Constructors
    Constructor Description
    Builder()  

  • Method Summary

    Modifier and Type Method Description
    PerPartitionCategorization build()
    Builds a PerPartitionCategorization.
    PerPartitionCategorization.Builder enabled​(java.lang.Boolean value)
    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.
    PerPartitionCategorization.Builder stopOnWarn​(java.lang.Boolean value)
    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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • enabled

      public PerPartitionCategorization.Builder enabled​(@Nullable java.lang.Boolean value)
      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

      public PerPartitionCategorization.Builder stopOnWarn​(@Nullable java.lang.Boolean value)
      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

    • build

      public PerPartitionCategorization build()
      Builds a PerPartitionCategorization.
      Specified by:
      build in interface ObjectBuilder<PerPartitionCategorization>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.