Package co.elastic.clients.elasticsearch.cluster

Class AllocationExplainRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<AllocationExplainRequest.Builder>

co.elastic.clients.elasticsearch.cluster.AllocationExplainRequest.Builder

All Implemented Interfaces:

WithJson<AllocationExplainRequest.Builder>, ObjectBuilder<AllocationExplainRequest>

Enclosing class:

AllocationExplainRequest

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

Builder for AllocationExplainRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AllocationExplainRequest	build()	Builds a AllocationExplainRequest.
final AllocationExplainRequest.Builder	currentNode(String value)	Explain a shard only if it is currently located on the specified node name or node ID.
final AllocationExplainRequest.Builder	includeDiskInfo(Boolean value)	If true, returns information about disk usage and shard sizes.
final AllocationExplainRequest.Builder	includeYesDecisions(Boolean value)	If true, returns YES decisions in explanation.
final AllocationExplainRequest.Builder	index(String value)	The name of the index that you would like an explanation for.
final AllocationExplainRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final AllocationExplainRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
final AllocationExplainRequest.Builder	primary(Boolean value)	If true, returns an explanation for the primary shard for the specified shard ID.
protected AllocationExplainRequest.Builder	self()
final AllocationExplainRequest.Builder	shard(Integer value)	An identifier for the shard that you would like an explanation for.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

currentNode

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

Explain a shard only if it is currently located on the specified node name or node ID.

API name: current_node

includeDiskInfo

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

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

API name: include_disk_info

includeYesDecisions

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

If true, returns YES decisions in explanation.

API name: include_yes_decisions

index

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

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

API name: index

masterTimeout

public final AllocationExplainRequest.Builder masterTimeout(@Nullable
 Time value)

Period to wait for a connection to the master node.

API name: master_timeout

masterTimeout

public final AllocationExplainRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to wait for a connection to the master node.

API name: master_timeout

primary

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

If true, returns an explanation for the primary shard for the specified shard ID.

API name: primary

shard

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

An identifier for the shard that you would like an explanation for.

API name: shard

self

protected AllocationExplainRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<AllocationExplainRequest.Builder>

build

public AllocationExplainRequest build()

Builds a AllocationExplainRequest.

Specified by:

build in interface ObjectBuilder<AllocationExplainRequest>

Throws:

NullPointerException - if some of the required fields are null.