Package co.elastic.clients.elasticsearch.ilm

Class MoveToStepRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ilm.MoveToStepRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class MoveToStepRequest
extends RequestBase
implements JsonpSerializable

Move to a lifecycle step. Manually move an index into a specific step in the lifecycle policy and run that step.

WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API.

You must specify both the current step and the step to be executed in the body of the request. The request will fail if the current step does not match the step currently running for the index This is to prevent the index from being moved from an unexpected step into the next step.

When specifying the target (next_step) to which the index will be moved, either the name or both the action and name fields are optional. If only the phase is specified, the index will move to the first step of the first action in the target phase. If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. Only actions specified in the ILM policy are considered valid. An index cannot move to a step that is not part of its policy.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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 JsonpDeserializer<MoveToStepRequest>	_DESERIALIZER	Json deserializer for MoveToStepRequest
static final Endpoint<MoveToStepRequest,MoveToStepResponse,ErrorResponse>	_ENDPOINT	Endpoint "ilm.move_to_step".

Method Summary

Modifier and Type	Method	Description
final StepKey	currentStep()	Required - The step that the index is expected to be in.
final String	index()	Required - The name of the index whose lifecycle step is to change
final StepKey	nextStep()	Required - The step that you want to run.
static MoveToStepRequest	of(Function<MoveToStepRequest.Builder,ObjectBuilder<MoveToStepRequest>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupMoveToStepRequestDeserializer(ObjectDeserializer<MoveToStepRequest.Builder> op)

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

_DESERIALIZER

public static final JsonpDeserializer<MoveToStepRequest> _DESERIALIZER

Json deserializer for MoveToStepRequest

_ENDPOINT

public static final Endpoint<MoveToStepRequest,MoveToStepResponse,ErrorResponse> _ENDPOINT

Endpoint "ilm.move_to_step".

Method Details

of

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

currentStep

public final StepKey currentStep()

Required - The step that the index is expected to be in.

API name: current_step

index

public final String index()

Required - The name of the index whose lifecycle step is to change

API name: index

nextStep

public final StepKey nextStep()

Required - The step that you want to run.

API name: next_step

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupMoveToStepRequestDeserializer

protected static void setupMoveToStepRequestDeserializer(ObjectDeserializer<MoveToStepRequest.Builder> op)