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 Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description DeleteForecastRequest.Builder
allowNoForecasts(java.lang.Boolean value)
Specifies whether an error occurs when there are no forecasts.DeleteForecastRequest
build()
Builds aDeleteForecastRequest
.DeleteForecastRequest.Builder
forecastId(java.lang.String value)
A comma-separated list of forecast identifiers.DeleteForecastRequest.Builder
jobId(java.lang.String value)
Required - Identifier for the anomaly detection job.DeleteForecastRequest.Builder
timeout(Time value)
Specifies the period of time to wait for the completion of the delete operation.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.Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowNoForecasts
Specifies whether an error occurs when there are no forecasts. In particular, if this parameter is set tofalse
and there are no forecasts associated with the job, attempts to delete all forecasts return an error.API name:
allow_no_forecasts
-
forecastId
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
Required - Identifier for the anomaly detection job.API name:
job_id
-
timeout
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
Builds aDeleteForecastRequest
.- Specified by:
build
in interfaceObjectBuilder<DeleteForecastRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-