Package co.elastic.clients.elasticsearch.rollup

Class StopJobRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.rollup.StopJobRequest

public class StopJobRequest
extends RequestBase

Stops an existing, started rollup job.

See Also:

• API specification

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 final Endpoint<StopJobRequest,StopJobResponse,ErrorResponse>	_ENDPOINT	Endpoint "rollup.stop_job".

Method Summary

Modifier and Type	Method	Description
final String	id()	Required - The ID of the job to stop
static StopJobRequest	of(Function<StopJobRequest.Builder,ObjectBuilder<StopJobRequest>> fn)
final Time	timeout()	Block for (at maximum) the specified duration while waiting for the job to stop.
final Boolean	waitForCompletion()	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.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_ENDPOINT

public static final Endpoint<StopJobRequest,StopJobResponse,ErrorResponse> _ENDPOINT

Endpoint "rollup.stop_job".

Method Details

of

public static StopJobRequest of(Function<StopJobRequest.Builder,ObjectBuilder<StopJobRequest>> fn)

id

public final String id()

Required - The ID of the job to stop

API name: id

timeout

@Nullable
public final Time timeout()

Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s.

API name: timeout

waitForCompletion

@Nullable
public final 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