Package co.elastic.clients.elasticsearch.indices

Class ExplainDataLifecycleRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.ExplainDataLifecycleRequest

public class ExplainDataLifecycleRequest
extends RequestBase

Retrieves information about the index's current DLM lifecycle, such as any potential encountered error, time since creation etc.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExplainDataLifecycleRequest.Builder	Builder for ExplainDataLifecycleRequest.

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<ExplainDataLifecycleRequest,ExplainDataLifecycleResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.explain_data_lifecycle".

Method Summary

Modifier and Type	Method	Description
final Boolean	includeDefaults()	indicates if the API should return the default values the system uses for the index's lifecycle
final List<String>	index()	Required - The name of the index to explain
final Time	masterTimeout()	Specify timeout for connection to master
static ExplainDataLifecycleRequest	of(Function<ExplainDataLifecycleRequest.Builder,ObjectBuilder<ExplainDataLifecycleRequest>> fn)

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<ExplainDataLifecycleRequest,ExplainDataLifecycleResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.explain_data_lifecycle".

Method Details

of

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

includeDefaults

@Nullable
public final Boolean includeDefaults()

indicates if the API should return the default values the system uses for the index's lifecycle

API name: include_defaults

index

public final List<String> index()

Required - The name of the index to explain

API name: index

masterTimeout

@Nullable
public final Time masterTimeout()

Specify timeout for connection to master

API name: master_timeout