Package org.opensearch.client.opensearch.cluster

Class AllocationExplainRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

ObjectBuilder<AllocationExplainRequest>

Enclosing class:

AllocationExplainRequest

public static class AllocationExplainRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<AllocationExplainRequest>

Builder for AllocationExplainRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AllocationExplainRequest	build()	Builds a AllocationExplainRequest.
AllocationExplainRequest.Builder	currentNode(java.lang.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.
AllocationExplainRequest.Builder	includeDiskInfo(java.lang.Boolean value)	If true, returns information about disk usage and shard sizes.
AllocationExplainRequest.Builder	includeYesDecisions(java.lang.Boolean value)	If true, returns YES decisions in explanation.
AllocationExplainRequest.Builder	index(java.lang.String value)	Specifies the name of the index that you would like an explanation for.
AllocationExplainRequest.Builder	primary(java.lang.Boolean value)	If true, returns explanation for the primary shard for the given shard ID.
AllocationExplainRequest.Builder	shard(java.lang.Integer value)	Specifies the ID of the shard that you would like an explanation for.

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

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

currentNode

public final AllocationExplainRequest.Builder currentNode(@Nullable
                                                          java.lang.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

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

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

API name: include_disk_info

includeYesDecisions

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

If true, returns YES decisions in explanation.

API name: include_yes_decisions

index

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

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

API name: index

primary

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

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

API name: primary

shard

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

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

API name: shard

build

public AllocationExplainRequest build()

Builds a AllocationExplainRequest.

Specified by:

build in interface ObjectBuilder<AllocationExplainRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.