Package co.elastic.clients.elasticsearch.ilm

Class PutLifecycleRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ilm.PutLifecycleRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutLifecycleRequest
extends RequestBase
implements JsonpSerializable

Create or update a lifecycle policy. If the specified policy exists, it is replaced and the policy version is incremented.

NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<PutLifecycleRequest>	_DESERIALIZER	Json deserializer for PutLifecycleRequest
static final Endpoint<PutLifecycleRequest,PutLifecycleResponse,ErrorResponse>	_ENDPOINT	Endpoint "ilm.put_lifecycle".

Method Summary

Modifier and Type	Method	Description
final Time	masterTimeout()	Period to wait for a connection to the master node.
final String	name()	Required - Identifier for the policy.
static PutLifecycleRequest	of(Function<PutLifecycleRequest.Builder,ObjectBuilder<PutLifecycleRequest>> fn)
final IlmPolicy	policy()	API name: policy
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	setupPutLifecycleRequestDeserializer(ObjectDeserializer<PutLifecycleRequest.Builder> op)
final Time	timeout()	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

_DESERIALIZER

public static final JsonpDeserializer<PutLifecycleRequest> _DESERIALIZER

Json deserializer for PutLifecycleRequest

_ENDPOINT

public static final Endpoint<PutLifecycleRequest,PutLifecycleResponse,ErrorResponse> _ENDPOINT

Endpoint "ilm.put_lifecycle".

Method Details

of

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

masterTimeout

@Nullable
public final Time masterTimeout()

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

name

public final String name()

Required - Identifier for the policy.

API name: policy

policy

@Nullable
public final IlmPolicy policy()

API name: policy

timeout

@Nullable
public final Time timeout()

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

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)

setupPutLifecycleRequestDeserializer

protected static void setupPutLifecycleRequestDeserializer(ObjectDeserializer<PutLifecycleRequest.Builder> op)