Package co.elastic.clients.elasticsearch.ilm

Class ExplainLifecycleRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ilm.ExplainLifecycleRequest

public class ExplainLifecycleRequest
extends RequestBase

Explain the lifecycle state. Get the current lifecycle status for one or more indices. For data streams, the API retrieves the current lifecycle status for the stream's backing indices.

The response indicates when the index entered each lifecycle state, provides the definition of the running phase, and information about any failures.

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

Method Summary

Modifier and Type	Method	Description
final String	index()	Required - Comma-separated list of data streams, indices, and aliases to target.
final Time	masterTimeout()	Period to wait for a connection to the master node.
static ExplainLifecycleRequest	of(Function<ExplainLifecycleRequest.Builder,ObjectBuilder<ExplainLifecycleRequest>> fn)
final Boolean	onlyErrors()	Filters the returned indices to only indices that are managed by ILM and are in an error state, either due to an encountering an error while executing the policy, or attempting to use a policy that does not exist.
final Boolean	onlyManaged()	Filters the returned indices to only indices that are managed by ILM.

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

_ENDPOINT

public static final Endpoint<ExplainLifecycleRequest,ExplainLifecycleResponse,ErrorResponse> _ENDPOINT

Endpoint "ilm.explain_lifecycle".

Method Details

of

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

index

public final String index()

Required - Comma-separated list of data streams, indices, and aliases to target. Supports wildcards (*). To target all data streams and indices, use * or _all.

API name: index

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

onlyErrors

@Nullable
public final Boolean onlyErrors()

Filters the returned indices to only indices that are managed by ILM and are in an error state, either due to an encountering an error while executing the policy, or attempting to use a policy that does not exist.

API name: only_errors

onlyManaged

@Nullable
public final Boolean onlyManaged()

Filters the returned indices to only indices that are managed by ILM.

API name: only_managed