Package co.elastic.clients.elasticsearch.ml

Class StopDataFrameAnalyticsRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoMatch

      public final StopDataFrameAnalyticsRequest.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 is true, which 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

    • force

      public final StopDataFrameAnalyticsRequest.Builder force​(@Nullable java.lang.Boolean value)
      If true, the data frame analytics job is stopped forcefully.

      API name: force

    • id

      public final StopDataFrameAnalyticsRequest.Builder id​(java.lang.String value)
      Required - Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.

      API name: id

    • timeout

      public final StopDataFrameAnalyticsRequest.Builder timeout​(@Nullable Time value)
      Controls the amount of time to wait until the data frame analytics job stops. Defaults to 20 seconds.

      API name: timeout

    • timeout

      public final StopDataFrameAnalyticsRequest.Builder timeout​(java.util.function.Function<Time.Builder,​ObjectBuilder<Time>> fn)
      Controls the amount of time to wait until the data frame analytics job stops. Defaults to 20 seconds.

      API name: timeout

    • build

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