DeleteJobRequest (java-client 7.15.1 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.DeleteJobRequest

All Implemented Interfaces:: ElasticsearchCommonRequest

public final class DeleteJobRequest
extends RequestBase

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class DeleteJobRequest.Builder
Builder for DeleteJobRequest.

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<DeleteJobRequest,DeleteJobResponse,ElasticsearchError> ENDPOINT
Endpoint "ml.delete_job".

Constructor Summary

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

Method Summary

Modifier and Type	Method	Description
`java.lang.Boolean`	`force()`	True if the job should be forcefully deleted
`java.lang.String`	`jobId()`	Required - The ID of the job to delete
`java.lang.Boolean`	`waitForCompletion()`	Should this request wait until the operation has completed before returning

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<DeleteJobRequest,DeleteJobResponse,ElasticsearchError> ENDPOINT
  
  Endpoint "ml.delete_job".
Constructor Details
- DeleteJobRequest
  
  public DeleteJobRequest(DeleteJobRequest.Builder builder)
- DeleteJobRequest
  
  public DeleteJobRequest(java.util.function.Function<DeleteJobRequest.Builder,DeleteJobRequest.Builder> fn)
Method Details
- jobId
  
  public java.lang.String jobId()
  
  Required - The ID of the job to delete
  API name: job_id
- force
  
  @Nullable public java.lang.Boolean force()
  
  True if the job should be forcefully deleted
  API name: force
- waitForCompletion
  
  @Nullable public java.lang.Boolean waitForCompletion()
  
  Should this request wait until the operation has completed before returning
  API name: wait_for_completion