Class GetDataFrameAnalyticsRequest.Builder

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

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

    • Builder

      public Builder()
  • Method Details

    • allowNoMatch

      public final GetDataFrameAnalyticsRequest.Builder allowNoMatch​(@Nullable java.lang.Boolean value)
      Specifies what to do when the request:
      1. Contains wildcard expressions and there are no data frame analytics jobs that match.
      2. Contains the _all string or no identifiers and there are no matches.
      3. Contains wildcard expressions and there are only partial matches.

      The default value returns an empty data_frame_analytics array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.

      API name: allow_no_match

    • excludeGenerated

      public final 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

    • from

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

      API name: from

    • id

      public final 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

    • size

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

      API name: size

    • build

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