Class ExplainLifecycleRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.ilm.ExplainLifecycleRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<ExplainLifecycleRequest>
- Enclosing class:
- ExplainLifecycleRequest
public static class ExplainLifecycleRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<ExplainLifecycleRequest>
Builder for
ExplainLifecycleRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description ExplainLifecycleRequest
build()
Builds aExplainLifecycleRequest
.ExplainLifecycleRequest.Builder
index(java.lang.String value)
Required - Comma-separated list of data streams, indices, and aliases to target.ExplainLifecycleRequest.Builder
masterTimeout(Time value)
Period to wait for a connection to the master node.ExplainLifecycleRequest.Builder
masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Period to wait for a connection to the master node.ExplainLifecycleRequest.Builder
onlyErrors(java.lang.Boolean value)
Filters the returned indices to only indices that are managed by ILM.ExplainLifecycleRequest.Builder
onlyManaged(java.lang.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.ExplainLifecycleRequest.Builder
timeout(Time value)
Period to wait for a response.ExplainLifecycleRequest.Builder
timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Period to wait for a response.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
-
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(java.util.function.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.API name:
only_errors
-
onlyManaged
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_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
public final ExplainLifecycleRequest.Builder timeout(java.util.function.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
-
build
Builds aExplainLifecycleRequest
.- Specified by:
build
in interfaceObjectBuilder<ExplainLifecycleRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-