StopJobRequest.Builder (java-client 7.17.5 API)

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.elasticsearch.rollup.StopJobRequest.Builder

All Implemented Interfaces:: ObjectBuilder<StopJobRequest>

Enclosing class:: StopJobRequest

public static class StopJobRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<StopJobRequest>

Builder for StopJobRequest.

Constructor Summary

Constructors

Constructor Description

Builder()

Method Summary

Modifier and Type	Method	Description
`StopJobRequest`	`build()`	Builds a `StopJobRequest`.
`StopJobRequest.Builder`	`id(java.lang.String value)`	Required - The ID of the job to stop
`StopJobRequest.Builder`	`timeout(Time value)`	Block for (at maximum) the specified duration while waiting for the job to stop.
`StopJobRequest.Builder`	`timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)`	Block for (at maximum) the specified duration while waiting for the job to stop.
`StopJobRequest.Builder`	`waitForCompletion(java.lang.Boolean value)`	True if the API should block until the job has fully stopped, false if should be executed async.

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Details
- Builder
  
  public Builder()
Method Details
- id
  
  public final StopJobRequest.Builder id(java.lang.String value)
  
  Required - The ID of the job to stop
  API name: id
- timeout
  
  public final StopJobRequest.Builder timeout(@Nullable Time value)
  
  Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s.
  API name: timeout
- timeout
  
  public final StopJobRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
  
  Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s.
  API name: timeout
- waitForCompletion
  
  public final StopJobRequest.Builder waitForCompletion(@Nullable java.lang.Boolean value)
  
  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
- build
  
  public StopJobRequest build()
  
  Builds a StopJobRequest.
  
  Specified by:
  
  build in interface ObjectBuilder<StopJobRequest>
  
  Throws:
  
  java.lang.NullPointerException - if some of the required fields are null.