DeleteForecastRequest (java-client 7.15.1 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.DeleteForecastRequest

All Implemented Interfaces:: ElasticsearchCommonRequest

public final class DeleteForecastRequest
extends RequestBase

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class DeleteForecastRequest.Builder
Builder for DeleteForecastRequest.

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 Endpoint<DeleteForecastRequest,DeleteForecastResponse,ElasticsearchError> ENDPOINT
Endpoint "ml.delete_forecast".

Constructor Summary

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

Method Summary

Modifier and Type	Method	Description
`java.lang.Boolean`	`allowNoForecasts()`	Whether to ignore if `_all` matches no forecasts
`java.lang.String`	`forecastId()`	The ID of the forecast to delete, can be comma delimited list.
`java.lang.String`	`jobId()`	Required - The ID of the job from which to delete forecasts
`java.lang.String`	`timeout()`	Controls the time to wait until the forecast(s) are deleted.

Methods inherited from class java.lang.Object

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

Field Details
- ENDPOINT
  
  public static final Endpoint<DeleteForecastRequest,DeleteForecastResponse,ElasticsearchError> ENDPOINT
  
  Endpoint "ml.delete_forecast".
Constructor Details
- DeleteForecastRequest
  
  public DeleteForecastRequest(DeleteForecastRequest.Builder builder)
- DeleteForecastRequest
  
  public DeleteForecastRequest(java.util.function.Function<DeleteForecastRequest.Builder,DeleteForecastRequest.Builder> fn)
Method Details
- jobId
  
  public java.lang.String jobId()
  
  Required - The ID of the job from which to delete forecasts
  API name: job_id
- forecastId
  
  @Nullable public java.lang.String forecastId()
  
  The ID of the forecast to delete, can be comma delimited list. Leaving blank implies _all
  API name: forecast_id
- allowNoForecasts
  
  @Nullable public java.lang.Boolean allowNoForecasts()
  
  Whether to ignore if _all matches no forecasts
  API name: allow_no_forecasts
- timeout
  
  @Nullable public java.lang.String timeout()
  
  Controls the time to wait until the forecast(s) are deleted. Default to 30 seconds
  API name: timeout