Class ExplainLifecycleRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ilm.ExplainLifecycleRequest
Retrieves information about the index’s current lifecycle state, such as the
currently executing phase, action, and step. Shows when the index entered
each one, the definition of the running phase, and information about any
failures.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<ExplainLifecycleRequest,
ExplainLifecycleResponse, ErrorResponse> Endpoint "ilm.explain_lifecycle
". -
Method Summary
Modifier and TypeMethodDescriptionfinal String
index()
Required - Comma-separated list of data streams, indices, and aliases to target.final Time
Period to wait for a connection to the master node.static ExplainLifecycleRequest
final Boolean
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
Filters the returned indices to only indices that are managed by ILM.final Time
timeout()
Period to wait for a response.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
public static final Endpoint<ExplainLifecycleRequest,ExplainLifecycleResponse, _ENDPOINTErrorResponse> Endpoint "ilm.explain_lifecycle
".
-
-
Method Details
-
of
public static ExplainLifecycleRequest of(Function<ExplainLifecycleRequest.Builder, ObjectBuilder<ExplainLifecycleRequest>> fn) -
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
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
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
Filters the returned indices to only indices that are managed by ILM.API name:
only_managed
-
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
-