Package co.elastic.clients.elasticsearch.ilm

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 Details

    • Builder

      public Builder()

  • Method Details

    • index

      public final ExplainLifecycleRequest.Builder index​(java.lang.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​(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

      public final ExplainLifecycleRequest.Builder onlyErrors​(@Nullable java.lang.Boolean value)
      Filters the returned indices to only indices that are managed by ILM.

      API name: only_errors

    • onlyManaged

      public final ExplainLifecycleRequest.Builder onlyManaged​(@Nullable 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.

      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​(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

      public ExplainLifecycleRequest build()
      Builds a ExplainLifecycleRequest.
      Specified by:
      build in interface ObjectBuilder<ExplainLifecycleRequest>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.