Package co.elastic.clients.elasticsearch.ml

Class ForecastRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.ForecastRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class ForecastRequest extends RequestBase implements JsonpSerializable
Predict future behavior of a time series.

Forecasts are not supported for jobs that perform population analysis; an error occurs if you try to create a forecast for a job that has an over_field_name in its configuration. Forcasts predict future behavior based on historical data.

See Also:

  • Field Details

  • Method Details

    • of

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

    • duration

      @Nullable public final Time duration()
      Refer to the description for the duration query parameter.

      API name: duration

    • expiresIn

      @Nullable public final Time expiresIn()
      Refer to the description for the expires_in query parameter.

      API name: expires_in

    • jobId

      public final String jobId()
      Required - Identifier for the anomaly detection job. The job must be open when you create a forecast; otherwise, an error occurs.

      API name: job_id

    • maxModelMemory

      @Nullable public final String maxModelMemory()
      Refer to the description for the max_model_memory query parameter.

      API name: max_model_memory

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

    • setupForecastRequestDeserializer

      protected static void setupForecastRequestDeserializer(ObjectDeserializer<ForecastRequest.Builder> op)