Package co.elastic.clients.elasticsearch.ilm

Class ExplainLifecycleRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<ExplainLifecycleRequest.Builder>

co.elastic.clients.elasticsearch.ilm.ExplainLifecycleRequest.Builder

All Implemented Interfaces:

WithJson<ExplainLifecycleRequest.Builder>, ObjectBuilder<ExplainLifecycleRequest>

Enclosing class:

ExplainLifecycleRequest

public static class ExplainLifecycleRequest.Builder
extends RequestBase.AbstractBuilder<ExplainLifecycleRequest.Builder>
implements ObjectBuilder<ExplainLifecycleRequest>

Builder for ExplainLifecycleRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ExplainLifecycleRequest	build()	Builds a ExplainLifecycleRequest.
final ExplainLifecycleRequest.Builder	index(String value)	Required - Comma-separated list of data streams, indices, and aliases to target.
final ExplainLifecycleRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final ExplainLifecycleRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
final ExplainLifecycleRequest.Builder	onlyErrors(Boolean value)	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 ExplainLifecycleRequest.Builder	onlyManaged(Boolean value)	Filters the returned indices to only indices that are managed by ILM.
protected ExplainLifecycleRequest.Builder	self()
final ExplainLifecycleRequest.Builder	timeout(Time value)	Period to wait for a response.
final ExplainLifecycleRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a response.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

index

public final ExplainLifecycleRequest.Builder index(String value)

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

public final ExplainLifecycleRequest.Builder masterTimeout(@Nullable
 Time value)

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

masterTimeout

public final ExplainLifecycleRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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

public final ExplainLifecycleRequest.Builder onlyErrors(@Nullable
 Boolean value)

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

public final ExplainLifecycleRequest.Builder onlyManaged(@Nullable
 Boolean value)

Filters the returned indices to only indices that are managed by ILM.

API name: only_managed

timeout

public final ExplainLifecycleRequest.Builder timeout(@Nullable
 Time value)

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

timeout

public final ExplainLifecycleRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

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

self

protected ExplainLifecycleRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ExplainLifecycleRequest.Builder>

build

public ExplainLifecycleRequest build()

Builds a ExplainLifecycleRequest.

Specified by:

build in interface ObjectBuilder<ExplainLifecycleRequest>

Throws:

NullPointerException - if some of the required fields are null.