Package co.elastic.clients.elasticsearch.ml

Class GetDataFrameAnalyticsRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • id

      public GetDataFrameAnalyticsRequest.Builder id​(@Nullable java.lang.String value)
      Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame analytics jobs.

      API name: id

    • allowNoMatch

      public GetDataFrameAnalyticsRequest.Builder allowNoMatch​(@Nullable java.lang.Boolean value)
      Whether to ignore if a wildcard expression matches no data frame analytics. (This includes _all string or when no data frame analytics have been specified)

      API name: allow_no_match

    • from

      public GetDataFrameAnalyticsRequest.Builder from​(@Nullable java.lang.Integer value)
      Skips the specified number of data frame analytics jobs.

      API name: from

    • size

      public GetDataFrameAnalyticsRequest.Builder size​(@Nullable java.lang.Integer value)
      Specifies the maximum number of data frame analytics jobs to obtain.

      API name: size

    • excludeGenerated

      public GetDataFrameAnalyticsRequest.Builder excludeGenerated​(@Nullable java.lang.Boolean value)
      Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.

      API name: exclude_generated

    • build

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