PutLifecycleRequest (java-client 7.16.0 API)

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

Creates a lifecycle policy

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

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`name()`	Required - The name of the index lifecycle policy
`static PutLifecycleRequest`	`of(java.util.function.Function<PutLifecycleRequest.Builder,ObjectBuilder<PutLifecycleRequest>> fn)`
`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)`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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(java.util.function.Function<PutLifecycleRequest.Builder,ObjectBuilder<PutLifecycleRequest>> fn)
- name
  
  public final java.lang.String name()
  
  Required - The name of the index lifecycle policy
  API name: policy
- policy
  
  @Nullable public final IlmPolicy policy()
  
  API name: policy
- 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)