Package co.elastic.clients.elasticsearch.ml

Class ForecastRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<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 WithJsonObjectBuilderBase<ForecastRequest.Builder>
implements ObjectBuilder<ForecastRequest>

Builder for ForecastRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ForecastRequest	build()	Builds a ForecastRequest.
ForecastRequest.Builder	duration(Time value)	Refer to the description for the duration query parameter.
ForecastRequest.Builder	duration(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Refer to the description for the duration query parameter.
ForecastRequest.Builder	expiresIn(Time value)	Refer to the description for the expires_in query parameter.
ForecastRequest.Builder	expiresIn(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Refer to the description for the expires_in query parameter.
ForecastRequest.Builder	jobId(java.lang.String value)	Required - Identifier for the anomaly detection job.
ForecastRequest.Builder	maxModelMemory(java.lang.String value)	Refer to the description for the max_model_memory query parameter.
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

duration

public final ForecastRequest.Builder duration(@Nullable
Time value)

Refer to the description for the duration query parameter.

API name: duration

duration

public final ForecastRequest.Builder duration(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Refer to the description for the duration query parameter.

API name: duration

expiresIn

public final ForecastRequest.Builder expiresIn(@Nullable
Time value)

Refer to the description for the expires_in query parameter.

API name: expires_in

expiresIn

public final ForecastRequest.Builder expiresIn(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Refer to the description for the expires_in query parameter.

API name: expires_in

jobId

public final ForecastRequest.Builder jobId(java.lang.String value)

Required - Identifier for the anomaly detection job. The job must be open when you create a forecast; otherwise, an error occurs.

API name: job_id

maxModelMemory

public final ForecastRequest.Builder maxModelMemory(@Nullable
java.lang.String value)

Refer to the description for the max_model_memory query parameter.

API name: max_model_memory

self

protected ForecastRequest.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<ForecastRequest.Builder>

build

public ForecastRequest build()

Builds a ForecastRequest.

Specified by:

build in interface ObjectBuilder<ForecastRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.