Package co.elastic.clients.elasticsearch.rollup

Class StopJobRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.rollup.StopJobRequest

@Deprecated
public class StopJobRequest
extends RequestBase

Deprecated.

8.11.0

Stop rollup jobs. If you try to stop a job that does not exist, an exception occurs. If you try to stop a job that is already stopped, nothing happens.

Since only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped. This is accomplished with the wait_for_completion query parameter, and optionally a timeout. For example:

 POST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s
 
 

The parameter blocks the API call from returning until either the job has moved to STOPPED or the specified time has elapsed. If the specified time elapses without the job moving to STOPPED, a timeout exception occurs.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StopJobRequest.Builder	Deprecated.

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	Deprecated. Endpoint "rollup.stop_job".

Method Summary

Modifier and Type	Method	Description
final String	id()	Deprecated. Required - Identifier for the rollup job.
static StopJobRequest	of(Function<StopJobRequest.Builder,ObjectBuilder<StopJobRequest>> fn)	Deprecated.
final Time	timeout()	Deprecated. If wait_for_completion is true, the API blocks for (at maximum) the specified duration while waiting for the job to stop.
final Boolean	waitForCompletion()	Deprecated. If set to true, causes the API to block until the indexer state completely stops.

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

Deprecated.

Endpoint "rollup.stop_job".

Method Details

of

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

Deprecated.

id

public final String id()

Deprecated.

Required - Identifier for the rollup job.

API name: id

timeout

@Nullable
public final Time timeout()

Deprecated.

If wait_for_completion is true, the API blocks for (at maximum) the specified duration while waiting for the job to stop. If more than timeout time has passed, the API throws a timeout exception. NOTE: Even if a timeout occurs, the stop request is still processing and eventually moves the job to STOPPED. The timeout simply means the API call itself timed out while waiting for the status change.

API name: timeout

waitForCompletion

@Nullable
public final Boolean waitForCompletion()

Deprecated.

If set to true, causes the API to block until the indexer state completely stops. If set to false, the API returns immediately and the indexer is stopped asynchronously in the background.

API name: wait_for_completion