Class DeleteForecastRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<DeleteForecastRequest.Builder>
co.elastic.clients.elasticsearch.ml.DeleteForecastRequest.Builder
- All Implemented Interfaces:
WithJson<DeleteForecastRequest.Builder>
,ObjectBuilder<DeleteForecastRequest>
- Enclosing class:
- DeleteForecastRequest
public static class DeleteForecastRequest.Builder
extends RequestBase.AbstractBuilder<DeleteForecastRequest.Builder>
implements ObjectBuilder<DeleteForecastRequest>
Builder for
DeleteForecastRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionallowNoForecasts
(Boolean value) Specifies whether an error occurs when there are no forecasts.build()
Builds aDeleteForecastRequest
.forecastId
(String value) A comma-separated list of forecast identifiers.Required - Identifier for the anomaly detection job.protected DeleteForecastRequest.Builder
self()
Specifies the period of time to wait for the completion of the delete operation.Specifies the period of time to wait for the completion of the delete operation.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
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
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
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<DeleteForecastRequest.Builder>
-
build
Builds aDeleteForecastRequest
.- Specified by:
build
in interfaceObjectBuilder<DeleteForecastRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-