Package co.elastic.clients.elasticsearch.ml

Class StopDataFrameAnalyticsRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.StopDataFrameAnalyticsRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class StopDataFrameAnalyticsRequest extends RequestBase implements JsonpSerializable
Stop data frame analytics jobs. A data frame analytics job can be started and stopped multiple times throughout its lifecycle.
See Also:

  • Field Details

  • Method Details

    • of

      public static StopDataFrameAnalyticsRequest of(Function<StopDataFrameAnalyticsRequest.Builder,ObjectBuilder<StopDataFrameAnalyticsRequest>> fn)

    • allowNoMatch

      @Nullable public final Boolean allowNoMatch()
      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

      @Nullable public final Boolean force()
      If true, the data frame analytics job is stopped forcefully.

      API name: force

    • id

      public final String id()
      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

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

      API name: timeout

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • setupStopDataFrameAnalyticsRequestDeserializer

      protected static void setupStopDataFrameAnalyticsRequestDeserializer(ObjectDeserializer<StopDataFrameAnalyticsRequest.Builder> op)