Package co.elastic.clients.elasticsearch.ml

Class ForecastRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.ForecastRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class ForecastRequest
extends RequestBase
implements JsonpSerializable

Predict future behavior of a time series.

Forecasts are not supported for jobs that perform population analysis; an error occurs if you try to create a forecast for a job that has an over_field_name in its configuration. Forcasts predict future behavior based on historical data.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ForecastRequest.Builder	Builder for ForecastRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<ForecastRequest>	_DESERIALIZER	Json deserializer for ForecastRequest
static final Endpoint<ForecastRequest,ForecastResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.forecast".

Method Summary

Modifier and Type	Method	Description
final Time	duration()	Refer to the description for the duration query parameter.
final Time	expiresIn()	Refer to the description for the expires_in query parameter.
final String	jobId()	Required - Identifier for the anomaly detection job.
final String	maxModelMemory()	Refer to the description for the max_model_memory query parameter.
static ForecastRequest	of(Function<ForecastRequest.Builder,ObjectBuilder<ForecastRequest>> fn)
ForecastRequest.Builder	rebuild()
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupForecastRequestDeserializer(ObjectDeserializer<ForecastRequest.Builder> op)

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ForecastRequest> _DESERIALIZER

Json deserializer for ForecastRequest

_ENDPOINT

public static final Endpoint<ForecastRequest,ForecastResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.forecast".

Method Details

of

public static ForecastRequest of(Function<ForecastRequest.Builder,ObjectBuilder<ForecastRequest>> fn)

duration

@Nullable
public final Time duration()

Refer to the description for the duration query parameter.

API name: duration

expiresIn

@Nullable
public final Time expiresIn()

Refer to the description for the expires_in query parameter.

API name: expires_in

jobId

public final String jobId()

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

@Nullable
public final String maxModelMemory()

Refer to the description for the max_model_memory query parameter.

API name: max_model_memory

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

rebuild

public ForecastRequest.Builder rebuild()

Returns:

New ForecastRequest.Builder initialized with field values of this instance

setupForecastRequestDeserializer

protected static void setupForecastRequestDeserializer(ObjectDeserializer<ForecastRequest.Builder> op)