ExplainLifecycleRequest (java-client 7.16.3 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ilm.ExplainLifecycleRequest

public class ExplainLifecycleRequest
extends RequestBase

Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step.

See Also:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class ExplainLifecycleRequest.Builder
Builder for ExplainLifecycleRequest.

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 Endpoint<ExplainLifecycleRequest,ExplainLifecycleResponse,ErrorResponse> _ENDPOINT
Endpoint "ilm.explain_lifecycle".

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`index()`	Required - The name of the index to explain
`static ExplainLifecycleRequest`	`of(java.util.function.Function<ExplainLifecycleRequest.Builder,ObjectBuilder<ExplainLifecycleRequest>> fn)`
`java.lang.Boolean`	`onlyErrors()`	filters the indices included in the response to ones in an ILM error state, implies only_managed
`java.lang.Boolean`	`onlyManaged()`	filters the indices included in the response to ones managed by ILM

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- _ENDPOINT
  
  public static final Endpoint<ExplainLifecycleRequest,ExplainLifecycleResponse,ErrorResponse> _ENDPOINT
  
  Endpoint "ilm.explain_lifecycle".
Method Details
- of
  
  public static ExplainLifecycleRequest of(java.util.function.Function<ExplainLifecycleRequest.Builder,ObjectBuilder<ExplainLifecycleRequest>> fn)
- index
  
  public final java.lang.String index()
  
  Required - The name of the index to explain
  API name: index
- onlyErrors
  
  @Nullable public final java.lang.Boolean onlyErrors()
  
  filters the indices included in the response to ones in an ILM error state, implies only_managed
  API name: only_errors
- onlyManaged
  
  @Nullable public final java.lang.Boolean onlyManaged()
  
  filters the indices included in the response to ones managed by ILM
  API name: only_managed