Package org.opensearch.client.opensearch.cluster

Class AllocationExplainRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.cluster.AllocationExplainRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class AllocationExplainRequest
extends RequestBase
implements JsonpSerializable

Provides explanations for shard allocations in the cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AllocationExplainRequest.Builder	Builder for AllocationExplainRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<AllocationExplainRequest>	_DESERIALIZER	Json deserializer for AllocationExplainRequest
static Endpoint<AllocationExplainRequest,AllocationExplainResponse,ErrorResponse>	_ENDPOINT	Endpoint "cluster.allocation_explain".

Method Summary

Modifier and Type	Method	Description
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.
java.lang.Boolean	includeDiskInfo()	If true, returns information about disk usage and shard sizes.
java.lang.Boolean	includeYesDecisions()	If true, returns YES decisions in explanation.
java.lang.String	index()	Specifies the name of the index that you would like an explanation for.
static AllocationExplainRequest	of(java.util.function.Function<AllocationExplainRequest.Builder,ObjectBuilder<AllocationExplainRequest>> fn)
java.lang.Boolean	primary()	If true, returns explanation for the primary shard for the given shard ID.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupAllocationExplainRequestDeserializer(ObjectDeserializer<AllocationExplainRequest.Builder> op)
java.lang.Integer	shard()	Specifies the ID of the shard that you would like an explanation for.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<AllocationExplainRequest> _DESERIALIZER

Json deserializer for AllocationExplainRequest

_ENDPOINT

public static final Endpoint<AllocationExplainRequest,AllocationExplainResponse,ErrorResponse> _ENDPOINT

Endpoint "cluster.allocation_explain".

Method Detail

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)