Package co.elastic.clients.elasticsearch.ilm

Class ExplainLifecycleRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ilm.ExplainLifecycleRequest

All Implemented Interfaces:

ElasticsearchCommonRequest

public final class ExplainLifecycleRequest
extends RequestBase

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,ElasticsearchError>	ENDPOINT	Endpoint "ilm.explain_lifecycle".

Constructor Summary

Constructors

Constructor	Description
ExplainLifecycleRequest(ExplainLifecycleRequest.Builder builder)
ExplainLifecycleRequest(java.util.function.Function<ExplainLifecycleRequest.Builder,ExplainLifecycleRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.String	index()	The name of the index to explain
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,ElasticsearchError> ENDPOINT

Endpoint "ilm.explain_lifecycle".

Constructor Details

ExplainLifecycleRequest

public ExplainLifecycleRequest(ExplainLifecycleRequest.Builder builder)

ExplainLifecycleRequest

public ExplainLifecycleRequest(java.util.function.Function<ExplainLifecycleRequest.Builder,ExplainLifecycleRequest.Builder> fn)

Method Details

index

public java.lang.String index()

The name of the index to explain

API name: index

onlyErrors

@Nullable
public 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 java.lang.Boolean onlyManaged()

filters the indices included in the response to ones managed by ILM

API name: only_managed