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 Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aForecastRequest
.final ForecastRequest.Builder
A period of time that indicates how far into the future to forecast.final ForecastRequest.Builder
A period of time that indicates how far into the future to forecast.final ForecastRequest.Builder
The period of time that forecast results are retained.final ForecastRequest.Builder
The period of time that forecast results are retained.final ForecastRequest.Builder
Required - Identifier for the anomaly detection job.final ForecastRequest.Builder
maxModelMemory
(String value) The maximum memory the forecast can use.protected ForecastRequest.Builder
self()
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
-
duration
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
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
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
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
Required - Identifier for the anomaly detection job.API name:
job_id
-
maxModelMemory
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
- Specified by:
self
in classRequestBase.AbstractBuilder<ForecastRequest.Builder>
-
build
Builds aForecastRequest
.- Specified by:
build
in interfaceObjectBuilder<ForecastRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-