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:

ToJsonp

public final class AllocationExplainRequest
extends RequestBase
implements ToJsonp

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<AllocationExplainRequest>	DESERIALIZER	Json deserializer for AllocationExplainRequest
static Endpoint<AllocationExplainRequest,AllocationExplainResponse,OpenSearchError>	ENDPOINT	Endpoint "cluster.allocation_explain".

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AllocationExplainRequest(AllocationExplainRequest.Builder builder)

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.
java.lang.Boolean	primary()	If true, returns explanation for the primary shard for the given shard ID.
protected static void	setupAllocationExplainRequestDeserializer(DelegatingDeserializer<AllocationExplainRequest.Builder> op)
java.lang.Number	shard()	Specifies the ID of the shard that you would like an explanation for.
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Methods inherited from class java.lang.Object

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

Field Details

DESERIALIZER

public static final JsonpDeserializer<AllocationExplainRequest> DESERIALIZER

Json deserializer for AllocationExplainRequest

ENDPOINT

public static final Endpoint<AllocationExplainRequest,AllocationExplainResponse,OpenSearchError> ENDPOINT

Endpoint "cluster.allocation_explain".

Constructor Details

AllocationExplainRequest

protected AllocationExplainRequest(AllocationExplainRequest.Builder builder)

Method Details

includeDiskInfo

@Nullable public java.lang.Boolean includeDiskInfo()

If true, returns information about disk usage and shard sizes. API name: include_disk_info

includeYesDecisions

@Nullable public java.lang.Boolean includeYesDecisions()

If true, returns YES decisions in explanation. API name: include_yes_decisions

currentNode

@Nullable public 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

index

@Nullable public java.lang.String index()

Specifies the name of the index that you would like an explanation for. API name: index

primary

@Nullable public java.lang.Boolean primary()

If true, returns explanation for the primary shard for the given shard ID. API name: primary

shard

@Nullable public java.lang.Number shard()

Specifies the ID of the shard that you would like an explanation for. API name: shard

toJsonp

public void toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

toJsonp in interface ToJsonp

toJsonpInternal

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

setupAllocationExplainRequestDeserializer

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