Package co.elastic.clients.elasticsearch.ml

Class DeleteForecastRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoForecasts

      public final DeleteForecastRequest.Builder allowNoForecasts​(@Nullable java.lang.Boolean value)
      Specifies whether an error occurs when there are no forecasts. In particular, if this parameter is set to false and there are no forecasts associated with the job, attempts to delete all forecasts return an error.

      API name: allow_no_forecasts

    • forecastId

      public final DeleteForecastRequest.Builder forecastId​(@Nullable java.lang.String value)
      A comma-separated list of forecast identifiers. If you do not specify this optional parameter or if you specify _all or * the API deletes all forecasts from the job.

      API name: forecast_id

    • jobId

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

      API name: job_id

    • timeout

      public final DeleteForecastRequest.Builder timeout​(@Nullable Time value)
      Specifies the period of time to wait for the completion of the delete operation. When this period of time elapses, the API fails and returns an error.

      API name: timeout

    • timeout

      public final DeleteForecastRequest.Builder timeout​(java.util.function.Function<Time.Builder,​ObjectBuilder<Time>> fn)
      Specifies the period of time to wait for the completion of the delete operation. When this period of time elapses, the API fails and returns an error.

      API name: timeout

    • build

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