Package co.elastic.clients.elasticsearch.slm

Class ExecuteRetentionRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.slm.ExecuteRetentionRequest

public class ExecuteRetentionRequest
extends RequestBase

Run a retention policy. Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. The retention policy is normally applied according to its schedule.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<ExecuteRetentionRequest,ExecuteRetentionResponse,ErrorResponse>	_ENDPOINT	Endpoint "slm.execute_retention".

Method Summary

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

Endpoint "slm.execute_retention".

Method Details

of

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

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