Package co.elastic.clients.elasticsearch.cluster

Class AllocationExplainRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.cluster.AllocationExplainRequest.Builder
All Implemented Interfaces:
ObjectBuilder<AllocationExplainRequest>
Enclosing class:
AllocationExplainRequest
public static class AllocationExplainRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<AllocationExplainRequest>
Builder for AllocationExplainRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • currentNode

      public final AllocationExplainRequest.Builder currentNode​(@Nullable java.lang.String value)
      Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node.

      API name: current_node

    • includeDiskInfo

      public final AllocationExplainRequest.Builder includeDiskInfo​(@Nullable java.lang.Boolean value)
      If true, returns information about disk usage and shard sizes.

      API name: include_disk_info

    • includeYesDecisions

      public final AllocationExplainRequest.Builder includeYesDecisions​(@Nullable java.lang.Boolean value)
      If true, returns YES decisions in explanation.

      API name: include_yes_decisions

    • index

      public final AllocationExplainRequest.Builder index​(@Nullable java.lang.String value)
      Specifies the name of the index that you would like an explanation for.

      API name: index

    • primary

      public final AllocationExplainRequest.Builder primary​(@Nullable java.lang.Boolean value)
      If true, returns explanation for the primary shard for the given shard ID.

      API name: primary

    • shard

      public final AllocationExplainRequest.Builder shard​(@Nullable java.lang.Integer value)
      Specifies the ID of the shard that you would like an explanation for.

      API name: shard

    • build

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