Package co.elastic.clients.elasticsearch.ilm

Class StopIlmRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ilm.StopIlmRequest

public class StopIlmRequest
extends RequestBase

Stop the ILM plugin. Halt all lifecycle management operations and stop the index lifecycle management plugin. This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices.

The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. Use the get ILM status API to check whether ILM is running.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StopIlmRequest.Builder	Builder for StopIlmRequest.

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<StopIlmRequest,StopIlmResponse,ErrorResponse>	_ENDPOINT	Endpoint "ilm.stop".

Method Summary

Modifier and Type	Method	Description
final Time	masterTimeout()	API name: master_timeout
static StopIlmRequest	of(Function<StopIlmRequest.Builder,ObjectBuilder<StopIlmRequest>> fn)
final Time	timeout()	API name: timeout

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<StopIlmRequest,StopIlmResponse,ErrorResponse> _ENDPOINT

Endpoint "ilm.stop".

Method Details

of

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

masterTimeout

@Nullable
public final Time masterTimeout()

API name: master_timeout

timeout

@Nullable
public final Time timeout()

API name: timeout