Package co.elastic.clients.elasticsearch.ml

Class ForecastRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<ForecastRequest.Builder>
co.elastic.clients.elasticsearch.ml.ForecastRequest.Builder
All Implemented Interfaces:
WithJson<ForecastRequest.Builder>, ObjectBuilder<ForecastRequest>
Enclosing class:
ForecastRequest
public static class ForecastRequest.Builder extends RequestBase.AbstractBuilder<ForecastRequest.Builder> implements ObjectBuilder<ForecastRequest>
Builder for ForecastRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • duration

      public final ForecastRequest.Builder duration(@Nullable Time value)
      A period of time that indicates how far into the future to forecast. For example, 30d corresponds to 30 days. The forecast starts at the last record that was processed.

      API name: duration

    • duration

      public final ForecastRequest.Builder duration(Function<Time.Builder,ObjectBuilder<Time>> fn)
      A period of time that indicates how far into the future to forecast. For example, 30d corresponds to 30 days. The forecast starts at the last record that was processed.

      API name: duration

    • expiresIn

      public final ForecastRequest.Builder expiresIn(@Nullable Time value)
      The period of time that forecast results are retained. After a forecast expires, the results are deleted. If set to a value of 0, the forecast is never automatically deleted.

      API name: expires_in

    • expiresIn

      public final ForecastRequest.Builder expiresIn(Function<Time.Builder,ObjectBuilder<Time>> fn)
      The period of time that forecast results are retained. After a forecast expires, the results are deleted. If set to a value of 0, the forecast is never automatically deleted.

      API name: expires_in

    • jobId

      public final ForecastRequest.Builder jobId(String value)
      Required - Identifier for the anomaly detection job.

      API name: job_id

    • maxModelMemory

      public final ForecastRequest.Builder maxModelMemory(@Nullable String value)
      The maximum memory the forecast can use. If the forecast needs to use more than the provided amount, it will spool to disk. Default is 20mb, maximum is 500mb and minimum is 1mb. If set to 40% or more of the job’s configured memory limit, it is automatically reduced to below that amount.

      API name: max_model_memory

    • self

      protected ForecastRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<ForecastRequest.Builder>

    • build

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