DeleteDataFrameAnalyticsRequest (java-client 8.2.2 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.DeleteDataFrameAnalyticsRequest

public class DeleteDataFrameAnalyticsRequest
extends RequestBase

Deletes a data frame analytics job.

See Also:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class DeleteDataFrameAnalyticsRequest.Builder
Builder for DeleteDataFrameAnalyticsRequest.

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<DeleteDataFrameAnalyticsRequest,DeleteDataFrameAnalyticsResponse,ErrorResponse>`	`_ENDPOINT`	Endpoint "`ml.delete_data_frame_analytics`".

Method Summary

Modifier and Type	Method	Description
`java.lang.Boolean`	`force()`	If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.
`java.lang.String`	`id()`	Required - Identifier for the data frame analytics job.
`static DeleteDataFrameAnalyticsRequest`	`of(java.util.function.Function<DeleteDataFrameAnalyticsRequest.Builder,ObjectBuilder<DeleteDataFrameAnalyticsRequest>> fn)`
`Time`	`timeout()`	The time to wait for the job to be deleted.

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
- _ENDPOINT
  
  public static final Endpoint<DeleteDataFrameAnalyticsRequest,DeleteDataFrameAnalyticsResponse,ErrorResponse> _ENDPOINT
  
  Endpoint "ml.delete_data_frame_analytics".
Method Details
- of
  
  public static DeleteDataFrameAnalyticsRequest of(java.util.function.Function<DeleteDataFrameAnalyticsRequest.Builder,ObjectBuilder<DeleteDataFrameAnalyticsRequest>> fn)
- force
  
  @Nullable public final java.lang.Boolean force()
  
  If true, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job.
  API name: force
- id
  
  public final java.lang.String id()
  
  Required - Identifier for the data frame analytics job.
  API name: id
- timeout
  
  @Nullable public final Time timeout()
  
  The time to wait for the job to be deleted.
  API name: timeout