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

Get the status for a data stream lifecycle. Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.

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 - Comma-separated list of index names to explain
final Time	masterTimeout()	The period to wait for a connection to the master node.
static ExplainDataLifecycleRequest	of(Function<ExplainDataLifecycleRequest.Builder,ObjectBuilder<ExplainDataLifecycleRequest>> fn)
ExplainDataLifecycleRequest.Builder	rebuild()

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 - Comma-separated list of index names to explain

API name: index

masterTimeout

@Nullable
public final Time masterTimeout()

The period to wait for a connection to the master node.

API name: master_timeout

rebuild

public ExplainDataLifecycleRequest.Builder rebuild()

Returns:

New ExplainDataLifecycleRequest.Builder initialized with field values of this instance