Class ExplainLifecycleRequest
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. Shows when the index entered
each one, 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 forExplainLifecycleRequest
.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 - Comma-separated list of data streams, indices, and aliases to target.Time
masterTimeout()
Period to wait for a connection to the master node.static ExplainLifecycleRequest
of(java.util.function.Function<ExplainLifecycleRequest.Builder,ObjectBuilder<ExplainLifecycleRequest>> fn)
java.lang.Boolean
onlyErrors()
Filters the returned indices to only indices that are managed by ILM.java.lang.Boolean
onlyManaged()
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.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
-
_ENDPOINT
public static final Endpoint<ExplainLifecycleRequest,ExplainLifecycleResponse,ErrorResponse> _ENDPOINTEndpoint "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 - 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
@Nullable public final java.lang.Boolean onlyErrors()Filters the returned indices to only indices that are managed by ILM.API name:
only_errors
-
onlyManaged
@Nullable public final java.lang.Boolean onlyManaged()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_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
-