Package co.elastic.clients.elasticsearch.slm

Class StartSlmRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.slm.StartSlmRequest

public class StartSlmRequest
extends RequestBase

Start snapshot lifecycle management. Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. Manually starting SLM is necessary only if it has been stopped using the stop SLM API.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<StartSlmRequest,StartSlmResponse,ErrorResponse>	_ENDPOINT	Endpoint "slm.start".

Method Summary

Modifier and Type	Method	Description
final Time	masterTimeout()	The period to wait for a connection to the master node.
static StartSlmRequest	of(Function<StartSlmRequest.Builder,ObjectBuilder<StartSlmRequest>> fn)
final Time	timeout()	The 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<StartSlmRequest,StartSlmResponse,ErrorResponse> _ENDPOINT

Endpoint "slm.start".

Method Details

of

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

masterTimeout

@Nullable
public final Time masterTimeout()

The 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. To indicate that the request should never timeout, set it to -1.

API name: master_timeout

timeout

@Nullable
public final Time timeout()

The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.

API name: timeout