Class AllocationExplainRequest.Builder
java.lang.Object
org.opensearch.client.opensearch.cluster.AllocationExplainRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<AllocationExplainRequest>
- Enclosing class:
- AllocationExplainRequest
public static class AllocationExplainRequest.Builder extends java.lang.Object implements ObjectBuilder<AllocationExplainRequest>
Builder for
AllocationExplainRequest.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder
ObjectBuilder.Constant<V> -
Constructor Summary
Constructors Constructor Description Builder() -
Method Summary
Modifier and Type Method Description AllocationExplainRequestbuild()Builds aAllocationExplainRequest.AllocationExplainRequest.BuildercurrentNode(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.BuilderincludeDiskInfo(java.lang.Boolean value)If true, returns information about disk usage and shard sizes.AllocationExplainRequest.BuilderincludeYesDecisions(java.lang.Boolean value)If true, returns YES decisions in explanation.AllocationExplainRequest.Builderindex(java.lang.String value)Specifies the name of the index that you would like an explanation for.AllocationExplainRequest.Builderprimary(java.lang.Boolean value)If true, returns explanation for the primary shard for the given shard ID.AllocationExplainRequest.Buildershard(java.lang.Number value)Specifies the ID of the shard that you would like an explanation for.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
includeDiskInfo
If true, returns information about disk usage and shard sizes. API name:include_disk_info -
includeYesDecisions
If true, returns YES decisions in explanation. API name:include_yes_decisions -
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
Specifies the name of the index that you would like an explanation for. API name:index -
primary
If true, returns explanation for the primary shard for the given shard ID. API name:primary -
shard
Specifies the ID of the shard that you would like an explanation for. API name:shard -
build
Builds aAllocationExplainRequest.- Specified by:
buildin interfaceObjectBuilder<AllocationExplainRequest>- Throws:
java.lang.NullPointerException- if some of the required fields are null.
-