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

Manually moves an index into the specified step and executes that step.

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()	API name: current_step
final String	index()	Required - The name of the index whose lifecycle step is to change
final StepKey	nextStep()	API name: next_step
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

@Nullable
public final StepKey currentStep()

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

@Nullable
public final StepKey nextStep()

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)