Package co.elastic.clients.elasticsearch.ml

Class FlushJobRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.FlushJobRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class FlushJobRequest
extends RequestBase
implements JsonpSerializable
Forces any buffered data to be processed by the job. The flush jobs API is only applicable when sending data for analysis using the post data API. Depending on the content of the buffer, then it might additionally calculate new results. Both flush and close operations are similar, however the flush is more efficient if you are expecting to send more data for analysis. When flushing, the job remains open and is available to continue analyzing data. A close operation additionally prunes and persists the model state to disk and the job must be opened again before analyzing further data.
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static FlushJobRequest of​(java.util.function.Function<FlushJobRequest.Builder,​ObjectBuilder<FlushJobRequest>> fn)

    • advanceTime

      @Nullable public final java.lang.String advanceTime()
      Specifies to advance to a particular time value. Results are generated and the model is updated for data from the specified time interval.

      API name: advance_time

    • calcInterim

      @Nullable public final java.lang.Boolean calcInterim()
      If true, calculates the interim results for the most recent bucket or all buckets within the latency period.

      API name: calc_interim

    • end

      @Nullable public final java.lang.String end()
      When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results.

      API name: end

    • jobId

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

      API name: job_id

    • skipTime

      @Nullable public final java.lang.String skipTime()
      Specifies to skip to a particular time value. Results are not generated and the model is not updated for data from the specified time interval.

      API name: skip_time

    • start

      @Nullable public final java.lang.String start()
      When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results.

      API name: start

    • 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)

    • setupFlushJobRequestDeserializer

      protected static void setupFlushJobRequestDeserializer​(ObjectDeserializer<FlushJobRequest.Builder> op)