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, PlainJsonSerializable, ToCopyableBuilder<AllocationExplainRequest.Builder,AllocationExplainRequest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class AllocationExplainRequest
extends RequestBase
implements PlainJsonSerializable, ToCopyableBuilder<AllocationExplainRequest.Builder,AllocationExplainRequest>

Explains how shards are allocated in the current cluster and provides an explanation for why unassigned shards can't be allocated to a node.

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 final JsonpDeserializer<AllocationExplainRequest>	_DESERIALIZER	Json deserializer for AllocationExplainRequest
static final Endpoint<AllocationExplainRequest,AllocationExplainResponse,ErrorResponse>	_ENDPOINT	Endpoint "cluster.allocation_explain".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static AllocationExplainRequest.Builder	builder()
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.
boolean	equals(Object o)
int	hashCode()
final Boolean	includeDiskInfo()	When true, returns information about disk usage and shard sizes.
final Boolean	includeYesDecisions()	When true, returns any YES decisions in the allocation explanation.
final String	index()	API name: index
static AllocationExplainRequest	of(Function<AllocationExplainRequest.Builder,ObjectBuilder<AllocationExplainRequest>> fn)
final Boolean	primary()	When true, returns a routing explanation for the primary shard based on the node 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)
final Integer	shard()	Specifies the ID of the shard that you would like an explanation for.
AllocationExplainRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_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 Details

of

public static AllocationExplainRequest of(Function<AllocationExplainRequest.Builder,ObjectBuilder<AllocationExplainRequest>> fn)

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()

When true, returns information about disk usage and shard sizes.

API name: include_disk_info

includeYesDecisions

@Nullable
public final Boolean includeYesDecisions()

When true, returns any YES decisions in the allocation explanation. YES decisions indicate when a particular shard allocation attempt was successful for the given node.

API name: include_yes_decisions

index

@Nullable
public final String index()

API name: index

primary

@Nullable
public final Boolean primary()

When true, returns a routing explanation for the primary shard based on the node 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

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)

toBuilder

@Nonnull
public AllocationExplainRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<AllocationExplainRequest.Builder,AllocationExplainRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static AllocationExplainRequest.Builder builder()

setupAllocationExplainRequestDeserializer

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

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object