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
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aExplainLifecycleRequest
.Required - Comma-separated list of data streams, indices, and aliases to target.masterTimeout
(Time value) Period to wait for a connection to the master node.Period to wait for a connection to the master node.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.onlyManaged
(Boolean value) Filters the returned indices to only indices that are managed by ILM.protected ExplainLifecycleRequest.Builder
self()
Period to wait for a response.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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
-
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
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
Filters the returned indices to only indices that are managed by ILM.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
-
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
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<ExplainLifecycleRequest.Builder>
-
build
Builds aExplainLifecycleRequest
.- Specified by:
build
in interfaceObjectBuilder<ExplainLifecycleRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-