Class GetCategoriesRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.ml.GetCategoriesRequest.Builder
All Implemented Interfaces:
ObjectBuilder<GetCategoriesRequest>
Enclosing class:
GetCategoriesRequest

public static class GetCategoriesRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<GetCategoriesRequest>
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • categoryId

      public final GetCategoriesRequest.Builder categoryId​(@Nullable java.lang.String value)
      Identifier for the category, which is unique in the job. If you specify neither the category ID nor the partition_field_value, the API returns information about all categories. If you specify only the partition_field_value, it returns information about all categories for the specified partition.

      API name: category_id

    • from

      public final GetCategoriesRequest.Builder from​(@Nullable java.lang.Integer value)
      Skips the specified number of categories.

      API name: from

    • jobId

      public final GetCategoriesRequest.Builder jobId​(java.lang.String value)
      Required - Identifier for the anomaly detection job.

      API name: job_id

    • page

      public final GetCategoriesRequest.Builder page​(@Nullable Page value)
      API name: page
    • page

      public final GetCategoriesRequest.Builder page​(java.util.function.Function<Page.Builder,​ObjectBuilder<Page>> fn)
      API name: page
    • partitionFieldValue

      public final GetCategoriesRequest.Builder partitionFieldValue​(@Nullable java.lang.String value)
      Only return categories for the specified partition.

      API name: partition_field_value

    • size

      public final GetCategoriesRequest.Builder size​(@Nullable java.lang.Integer value)
      Specifies the maximum number of categories to obtain.

      API name: size

    • build

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