Package org.opensearch.client.opensearch.cluster

Class AllocationExplainRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<AllocationExplainRequest.Builder>

org.opensearch.client.opensearch.cluster.AllocationExplainRequest.Builder

All Implemented Interfaces:

CopyableBuilder<AllocationExplainRequest.Builder,AllocationExplainRequest>, MutableBuilder<AllocationExplainRequest.Builder,AllocationExplainRequest>, ObjectBuilder<AllocationExplainRequest>

Enclosing class:

AllocationExplainRequest

public static class AllocationExplainRequest.Builder
extends RequestBase.AbstractBuilder<AllocationExplainRequest.Builder>
implements CopyableBuilder<AllocationExplainRequest.Builder,AllocationExplainRequest>

Builder for AllocationExplainRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AllocationExplainRequest	build()	Builds a AllocationExplainRequest.
AllocationExplainRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final AllocationExplainRequest.Builder	currentNode(String value)	Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node.
final AllocationExplainRequest.Builder	includeDiskInfo(Boolean value)	When true, returns information about disk usage and shard sizes.
final AllocationExplainRequest.Builder	includeYesDecisions(Boolean value)	When true, returns any YES decisions in the allocation explanation.
final AllocationExplainRequest.Builder	index(String value)	API name: index
final AllocationExplainRequest.Builder	primary(Boolean value)	When true, returns a routing explanation for the primary shard based on the node ID.
protected AllocationExplainRequest.Builder	self()
final AllocationExplainRequest.Builder	shard(Integer value)	Specifies the ID of the shard that you would like an explanation for.

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

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public AllocationExplainRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<AllocationExplainRequest.Builder,AllocationExplainRequest>

Returns:

a new builder instance.

self

@Nonnull
protected AllocationExplainRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<AllocationExplainRequest.Builder>

currentNode

@Nonnull
public final AllocationExplainRequest.Builder currentNode(@Nullable
 String value)

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

@Nonnull
public final AllocationExplainRequest.Builder includeDiskInfo(@Nullable
 Boolean value)

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

API name: include_disk_info

includeYesDecisions

@Nonnull
public final AllocationExplainRequest.Builder includeYesDecisions(@Nullable
 Boolean value)

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

@Nonnull
public final AllocationExplainRequest.Builder index(@Nullable
 String value)

API name: index

primary

@Nonnull
public final AllocationExplainRequest.Builder primary(@Nullable
 Boolean value)

When true, returns a routing explanation for the primary shard based on the node ID.

API name: primary

shard

@Nonnull
public final AllocationExplainRequest.Builder shard(@Nullable
 Integer value)

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

API name: shard

build

@Nonnull
public AllocationExplainRequest build()

Builds a AllocationExplainRequest.

Specified by:

build in interface ObjectBuilder<AllocationExplainRequest>

Throws:

NullPointerException - if some of the required fields are null.