Package co.elastic.clients.elasticsearch.rollup

Class StopJobRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<StopJobRequest.Builder>

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

All Implemented Interfaces:

WithJson<StopJobRequest.Builder>, ObjectBuilder<StopJobRequest>

Enclosing class:

StopJobRequest

public static class StopJobRequest.Builder
extends RequestBase.AbstractBuilder<StopJobRequest.Builder>
implements ObjectBuilder<StopJobRequest>

Builder for StopJobRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StopJobRequest	build()	Builds a StopJobRequest.
final StopJobRequest.Builder	id(String value)	Required - The ID of the job to stop
protected StopJobRequest.Builder	self()
final StopJobRequest.Builder	timeout(Time value)	Block for (at maximum) the specified duration while waiting for the job to stop.
final StopJobRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Block for (at maximum) the specified duration while waiting for the job to stop.
final StopJobRequest.Builder	waitForCompletion(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.WithJsonObjectBuilderBase

withJson

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

id

public final StopJobRequest.Builder id(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(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
 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

self

protected StopJobRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<StopJobRequest.Builder>

build

public StopJobRequest build()

Builds a StopJobRequest.

Specified by:

build in interface ObjectBuilder<StopJobRequest>

Throws:

NullPointerException - if some of the required fields are null.