Package co.elastic.clients.elasticsearch.cluster

Class AllocationExplainRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cluster.AllocationExplainRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class AllocationExplainRequest
extends RequestBase
implements JsonpSerializable
Provides explanations for shard allocations in the cluster.
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static AllocationExplainRequest of​(java.util.function.Function<AllocationExplainRequest.Builder,​ObjectBuilder<AllocationExplainRequest>> fn)

    • currentNode

      @Nullable public final java.lang.String currentNode()
      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

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

      API name: include_disk_info

    • includeYesDecisions

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

      API name: include_yes_decisions

    • index

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

      API name: index

    • primary

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

      API name: primary

    • shard

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

      API name: shard

    • serialize

      public void serialize​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • setupAllocationExplainRequestDeserializer

      protected static void setupAllocationExplainRequestDeserializer​(ObjectDeserializer<AllocationExplainRequest.Builder> op)