DeleteDataFrameAnalyticsRequest (java-client 7.15.1 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.DeleteDataFrameAnalyticsRequest

All Implemented Interfaces:: ElasticsearchCommonRequest

public final class DeleteDataFrameAnalyticsRequest
extends RequestBase

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,ElasticsearchError>`	`ENDPOINT`	Endpoint "`ml.delete_data_frame_analytics`".

Constructor Summary

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

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.
`java.lang.String`	`timeout()`	The time to wait for the job to be 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<DeleteDataFrameAnalyticsRequest,DeleteDataFrameAnalyticsResponse,ElasticsearchError> ENDPOINT
  
  Endpoint "ml.delete_data_frame_analytics".
Constructor Details
- DeleteDataFrameAnalyticsRequest
  
  public DeleteDataFrameAnalyticsRequest(DeleteDataFrameAnalyticsRequest.Builder builder)
- DeleteDataFrameAnalyticsRequest
  
  public DeleteDataFrameAnalyticsRequest(java.util.function.Function<DeleteDataFrameAnalyticsRequest.Builder,DeleteDataFrameAnalyticsRequest.Builder> fn)
Method Details
- id
  
  public java.lang.String id()
  
  Required - Identifier for the data frame analytics job.
  API name: id
- force
  
  @Nullable public 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
- timeout
  
  @Nullable public java.lang.String timeout()
  
  The time to wait for the job to be deleted.
  API name: timeout