- All Implemented Interfaces:
JsonpSerializable
Provides explanations for shard allocations in the cluster.
- See Also:
-
-
Nested Class Summary
Nested Classes
-
Field Summary
Fields
Endpoint "cluster.allocation_explain
".
-
Method Summary
Specifies the node ID or the name of the node to only explain a shard that is
currently located on the specified node.
If true, returns information about disk usage and shard sizes.
If true, returns YES decisions in explanation.
Specifies the name of the index that you would like an explanation for.
If true, returns explanation for the primary shard for the given shard ID.
void
Serialize this object to JSON.
protected void
protected static void
Specifies the ID of the shard that you would like an explanation for.
-
Field Details
-
-
_ENDPOINT
Endpoint "cluster.allocation_explain
".
-
Method Details
-
-
currentNode
@Nullable
public final 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 Boolean includeDiskInfo()
If true, returns information about disk usage and shard sizes.
API name: include_disk_info
-
includeYesDecisions
@Nullable
public final Boolean includeYesDecisions()
If true, returns YES decisions in explanation.
API name: include_yes_decisions
-
index
@Nullable
public final String index()
Specifies the name of the index that you would like an explanation for.
API name: index
-
primary
@Nullable
public final Boolean primary()
If true, returns explanation for the primary shard for the given shard ID.
API name: primary
-
shard
@Nullable
public final Integer shard()
Specifies the ID of the shard that you would like an explanation for.
API name: shard
-
-
serializeInternal
protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
JsonpMapper mapper)
-
setupAllocationExplainRequestDeserializer