StopJobRequest (java-client 7.15.1 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.rollup.StopJobRequest

All Implemented Interfaces:: ElasticsearchCommonRequest

public final class StopJobRequest
extends RequestBase

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class StopJobRequest.Builder
Builder for StopJobRequest.

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<StopJobRequest,StopJobResponse,ElasticsearchError> ENDPOINT
Endpoint "rollup.stop_job".

Constructor Summary

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

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`id()`	Required - The ID of the job to stop
`java.lang.String`	`timeout()`	Block for (at maximum) the specified duration while waiting for the job to stop.
`java.lang.Boolean`	`waitForCompletion()`	True if the API should block until the job has fully stopped, false if should be executed async.

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<StopJobRequest,StopJobResponse,ElasticsearchError> ENDPOINT
  
  Endpoint "rollup.stop_job".
Constructor Details
- StopJobRequest
  
  public StopJobRequest(StopJobRequest.Builder builder)
- StopJobRequest
  
  public StopJobRequest(java.util.function.Function<StopJobRequest.Builder,StopJobRequest.Builder> fn)
Method Details
- id
  
  public java.lang.String id()
  
  Required - The ID of the job to stop
  API name: id
- timeout
  
  @Nullable public java.lang.String timeout()
  
  Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s.
  API name: timeout
- waitForCompletion
  
  @Nullable public java.lang.Boolean waitForCompletion()
  
  True if the API should block until the job has fully stopped, false if should be executed async. Defaults to false.
  API name: wait_for_completion