Package co.elastic.clients.elasticsearch.ml

Class Category.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<Category.Builder>
co.elastic.clients.elasticsearch.ml.Category.Builder
All Implemented Interfaces:
WithJson<Category.Builder>, ObjectBuilder<Category>
Enclosing class:
Category
public static class Category.Builder extends WithJsonObjectBuilderBase<Category.Builder> implements ObjectBuilder<Category>
Builder for Category.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • categoryId

      public final Category.Builder categoryId(Number value)
      Required - A unique identifier for the category. category_id is unique at the job level, even when per-partition categorization is enabled.

      API name: category_id

    • examples

      public final Category.Builder examples(List<String> list)
      Required - A list of examples of actual values that matched the category.

      API name: examples

      Adds all elements of list to examples.

    • examples

      public final Category.Builder examples(String value, String... values)
      Required - A list of examples of actual values that matched the category.

      API name: examples

      Adds one or more values to examples.

    • grokPattern

      public final Category.Builder grokPattern(@Nullable String value)
      [experimental] A Grok pattern that could be used in Logstash or an ingest pipeline to extract fields from messages that match the category. This field is experimental and may be changed or removed in a future release. The Grok patterns that are found are not optimal, but are often a good starting point for manual tweaking.

      API name: grok_pattern

    • jobId

      public final Category.Builder jobId(String value)
      Required - Identifier for the anomaly detection job.

      API name: job_id

    • maxMatchingLength

      public final Category.Builder maxMatchingLength(Number value)
      Required - The maximum length of the fields that matched the category. The value is increased by 10% to enable matching for similar fields that have not been analyzed.

      API name: max_matching_length

    • partitionFieldName

      public final Category.Builder partitionFieldName(@Nullable String value)
      If per-partition categorization is enabled, this property identifies the field used to segment the categorization. It is not present when per-partition categorization is disabled.

      API name: partition_field_name

    • partitionFieldValue

      public final Category.Builder partitionFieldValue(@Nullable String value)
      If per-partition categorization is enabled, this property identifies the value of the partition_field_name for the category. It is not present when per-partition categorization is disabled.

      API name: partition_field_value

    • regex

      public final Category.Builder regex(String value)
      Required - A regular expression that is used to search for values that match the category.

      API name: regex

    • terms

      public final Category.Builder terms(String value)
      Required - A space separated list of the common tokens that are matched in values of the category.

      API name: terms

    • numMatches

      public final Category.Builder numMatches(@Nullable Long value)
      The number of messages that have been matched by this category. This is only guaranteed to have the latest accurate count after a job _flush or _close

      API name: num_matches

    • preferredToCategories

      public final Category.Builder preferredToCategories(List<String> list)
      A list of category_id entries that this current category encompasses. Any new message that is processed by the categorizer will match against this category and not any of the categories in this list. This is only guaranteed to have the latest accurate list of categories after a job _flush or _close

      API name: preferred_to_categories

      Adds all elements of list to preferredToCategories.

    • preferredToCategories

      public final Category.Builder preferredToCategories(String value, String... values)
      A list of category_id entries that this current category encompasses. Any new message that is processed by the categorizer will match against this category and not any of the categories in this list. This is only guaranteed to have the latest accurate list of categories after a job _flush or _close

      API name: preferred_to_categories

      Adds one or more values to preferredToCategories.

    • p

      public final Category.Builder p(@Nullable String value)
      API name: p

    • resultType

      public final Category.Builder resultType(String value)
      Required - API name: result_type

    • mlcategory

      public final Category.Builder mlcategory(String value)
      Required - API name: mlcategory

    • self

      protected Category.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<Category.Builder>

    • build

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