Package co.elastic.clients.elasticsearch.ilm

Class StartIlmRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ilm.StartIlmRequest

public class StartIlmRequest
extends RequestBase

Start the ILM plugin. Start the index lifecycle management plugin if it is currently stopped. ILM is started automatically when the cluster is formed. Restarting ILM is necessary only when it has been stopped using the stop ILM API.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<StartIlmRequest,StartIlmResponse,ErrorResponse>	_ENDPOINT	Endpoint "ilm.start".

Method Summary

Modifier and Type	Method	Description
final Time	masterTimeout()	Period to wait for a connection to the master node.
static StartIlmRequest	of(Function<StartIlmRequest.Builder,ObjectBuilder<StartIlmRequest>> fn)
final Time	timeout()	Period to wait for a response.

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<StartIlmRequest,StartIlmResponse,ErrorResponse> _ENDPOINT

Endpoint "ilm.start".

Method Details

of

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

masterTimeout

@Nullable
public final Time masterTimeout()

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

timeout

@Nullable
public final Time timeout()

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout