ForecastRequest (java-client 7.15.1 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.ForecastRequest

All Implemented Interfaces:: ElasticsearchCommonRequest, JsonpSerializable

@JsonpDeserializable
public final class ForecastRequest
extends RequestBase
implements JsonpSerializable

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 JsonpDeserializer<ForecastRequest>`	`_DESERIALIZER`	Json deserializer for `ForecastRequest`
`static Endpoint<ForecastRequest,ForecastResponse,ElasticsearchError>`	`ENDPOINT`	Endpoint "`ml.forecast`".

Constructor Summary

Constructors
Constructor	Description
`ForecastRequest(ForecastRequest.Builder builder)`
`ForecastRequest(java.util.function.Function<ForecastRequest.Builder,ForecastRequest.Builder> fn)`

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`duration()`	API name: `duration`
`java.lang.String`	`expiresIn()`	API name: `expires_in`
`java.lang.String`	`jobId()`	Required - The ID of the job to forecast for
`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(DelegatingDeserializer<ForecastRequest.Builder> op)`

Methods inherited from class java.lang.Object

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

Field Details
- _DESERIALIZER
  
  public static final JsonpDeserializer<ForecastRequest> _DESERIALIZER
  
  Json deserializer for ForecastRequest
- ENDPOINT
  
  public static final Endpoint<ForecastRequest,ForecastResponse,ElasticsearchError> ENDPOINT
  
  Endpoint "ml.forecast".
Constructor Details
- ForecastRequest
  
  public ForecastRequest(ForecastRequest.Builder builder)
- ForecastRequest
  
  public ForecastRequest(java.util.function.Function<ForecastRequest.Builder,ForecastRequest.Builder> fn)
Method Details
- jobId
  
  public java.lang.String jobId()
  
  Required - The ID of the job to forecast for
  API name: job_id
- duration
  
  @Nullable public java.lang.String duration()
  
  API name: duration
- expiresIn
  
  @Nullable public java.lang.String expiresIn()
  
  API name: expires_in
- 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)
- setupForecastRequestDeserializer
  
  protected static void setupForecastRequestDeserializer(DelegatingDeserializer<ForecastRequest.Builder> op)