Class ForecastRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.ml.ForecastRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<ForecastRequest>
- Enclosing class:
- ForecastRequest
public static class ForecastRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<ForecastRequest>
Builder for
ForecastRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description ForecastRequest
build()
Builds aForecastRequest
.ForecastRequest.Builder
duration(Time value)
A period of time that indicates how far into the future to forecast.ForecastRequest.Builder
duration(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
A period of time that indicates how far into the future to forecast.ForecastRequest.Builder
expiresIn(Time value)
The period of time that forecast results are retained.ForecastRequest.Builder
expiresIn(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
The period of time that forecast results are retained.ForecastRequest.Builder
jobId(java.lang.String value)
Required - Identifier for the anomaly detection job.ForecastRequest.Builder
maxModelMemory(java.lang.String value)
The maximum memory the forecast can use.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
-
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
public final ForecastRequest.Builder duration(java.util.function.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
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(java.util.function.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
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
-
build
Builds aForecastRequest
.- Specified by:
build
in interfaceObjectBuilder<ForecastRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-