Package co.elastic.clients.elasticsearch.slm

Class ExecuteLifecycleRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.slm.ExecuteLifecycleRequest

public class ExecuteLifecycleRequest
extends RequestBase

Run a policy.

Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<ExecuteLifecycleRequest,ExecuteLifecycleResponse,ErrorResponse>	_ENDPOINT	Endpoint "slm.execute_lifecycle".

Method Summary

Modifier and Type	Method	Description
final Time	masterTimeout()	The period to wait for a connection to the master node.
static ExecuteLifecycleRequest	of(Function<ExecuteLifecycleRequest.Builder,ObjectBuilder<ExecuteLifecycleRequest>> fn)
final String	policyId()	Required - The id of the snapshot lifecycle policy to be executed
ExecuteLifecycleRequest.Builder	rebuild()
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<ExecuteLifecycleRequest,ExecuteLifecycleResponse,ErrorResponse> _ENDPOINT

Endpoint "slm.execute_lifecycle".

Method Details

of

public static ExecuteLifecycleRequest of(Function<ExecuteLifecycleRequest.Builder,ObjectBuilder<ExecuteLifecycleRequest>> 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.

API name: master_timeout

policyId

public final String policyId()

Required - The id of the snapshot lifecycle policy to be executed

API name: policy_id

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.

API name: timeout

rebuild

public ExecuteLifecycleRequest.Builder rebuild()

Returns:

New ExecuteLifecycleRequest.Builder initialized with field values of this instance