Package org.opensearch.client.opensearch.cluster

Class AllocationExplainResponse.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cluster.AllocationExplainResponse.Builder

All Implemented Interfaces:

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

Enclosing class:

AllocationExplainResponse

public static class AllocationExplainResponse.Builder
extends ObjectBuilderBase
implements CopyableBuilder<AllocationExplainResponse.Builder,AllocationExplainResponse>

Builder for AllocationExplainResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final AllocationExplainResponse.Builder	allocateExplanation(String value)	API name: allocate_explanation
final AllocationExplainResponse.Builder	allocationDelay(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: allocation_delay
final AllocationExplainResponse.Builder	allocationDelay(Time value)	API name: allocation_delay
final AllocationExplainResponse.Builder	allocationDelayInMillis(Long value)	API name: allocation_delay_in_millis
AllocationExplainResponse	build()	Builds a AllocationExplainResponse.
final AllocationExplainResponse.Builder	canAllocate(Decision value)	API name: can_allocate
final AllocationExplainResponse.Builder	canMoveToOtherNode(Decision value)	API name: can_move_to_other_node
final AllocationExplainResponse.Builder	canRebalanceCluster(Decision value)	API name: can_rebalance_cluster
final AllocationExplainResponse.Builder	canRebalanceClusterDecisions(Function<AllocationDecision.Builder,ObjectBuilder<AllocationDecision>> fn)	API name: can_rebalance_cluster_decisions
final AllocationExplainResponse.Builder	canRebalanceClusterDecisions(List<AllocationDecision> list)	API name: can_rebalance_cluster_decisions
final AllocationExplainResponse.Builder	canRebalanceClusterDecisions(AllocationDecision value, AllocationDecision... values)	API name: can_rebalance_cluster_decisions
final AllocationExplainResponse.Builder	canRebalanceToOtherNode(Decision value)	API name: can_rebalance_to_other_node
final AllocationExplainResponse.Builder	canRemainDecisions(Function<AllocationDecision.Builder,ObjectBuilder<AllocationDecision>> fn)	API name: can_remain_decisions
final AllocationExplainResponse.Builder	canRemainDecisions(List<AllocationDecision> list)	API name: can_remain_decisions
final AllocationExplainResponse.Builder	canRemainDecisions(AllocationDecision value, AllocationDecision... values)	API name: can_remain_decisions
final AllocationExplainResponse.Builder	canRemainOnCurrentNode(Decision value)	API name: can_remain_on_current_node
final AllocationExplainResponse.Builder	clusterInfo(Function<ClusterInfo.Builder,ObjectBuilder<ClusterInfo>> fn)	API name: cluster_info
final AllocationExplainResponse.Builder	clusterInfo(ClusterInfo value)	API name: cluster_info
final AllocationExplainResponse.Builder	configuredDelay(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: configured_delay
final AllocationExplainResponse.Builder	configuredDelay(Time value)	API name: configured_delay
final AllocationExplainResponse.Builder	configuredDelayInMillis(Long value)	API name: configured_delay_in_millis
AllocationExplainResponse.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final AllocationExplainResponse.Builder	currentNode(Function<CurrentNode.Builder,ObjectBuilder<CurrentNode>> fn)	API name: current_node
final AllocationExplainResponse.Builder	currentNode(CurrentNode value)	API name: current_node
final AllocationExplainResponse.Builder	currentState(String value)	Required - API name: current_state
final AllocationExplainResponse.Builder	index(String value)	Required - API name: index
final AllocationExplainResponse.Builder	moveExplanation(String value)	API name: move_explanation
final AllocationExplainResponse.Builder	nodeAllocationDecisions(Function<NodeAllocationExplanation.Builder,ObjectBuilder<NodeAllocationExplanation>> fn)	API name: node_allocation_decisions
final AllocationExplainResponse.Builder	nodeAllocationDecisions(List<NodeAllocationExplanation> list)	API name: node_allocation_decisions
final AllocationExplainResponse.Builder	nodeAllocationDecisions(NodeAllocationExplanation value, NodeAllocationExplanation... values)	API name: node_allocation_decisions
final AllocationExplainResponse.Builder	note(String value)	API name: note
final AllocationExplainResponse.Builder	primary(boolean value)	Required - API name: primary
final AllocationExplainResponse.Builder	rebalanceExplanation(String value)	API name: rebalance_explanation
final AllocationExplainResponse.Builder	remainingDelay(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: remaining_delay
final AllocationExplainResponse.Builder	remainingDelay(Time value)	API name: remaining_delay
final AllocationExplainResponse.Builder	remainingDelayInMillis(Long value)	API name: remaining_delay_in_millis
final AllocationExplainResponse.Builder	shard(int value)	Required - API name: shard
final AllocationExplainResponse.Builder	unassignedInfo(Function<UnassignedInformation.Builder,ObjectBuilder<UnassignedInformation>> fn)	API name: unassigned_info
final AllocationExplainResponse.Builder	unassignedInfo(UnassignedInformation value)	API name: unassigned_info

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 AllocationExplainResponse.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<AllocationExplainResponse.Builder,AllocationExplainResponse>

Returns:

a new builder instance.

allocateExplanation

@Nonnull
public final AllocationExplainResponse.Builder allocateExplanation(@Nullable
 String value)

API name: allocate_explanation

allocationDelay

@Nonnull
public final AllocationExplainResponse.Builder allocationDelay(@Nullable
 Time value)

API name: allocation_delay

allocationDelay

@Nonnull
public final AllocationExplainResponse.Builder allocationDelay(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: allocation_delay

allocationDelayInMillis

@Nonnull
public final AllocationExplainResponse.Builder allocationDelayInMillis(@Nullable
 Long value)

API name: allocation_delay_in_millis

canAllocate

@Nonnull
public final AllocationExplainResponse.Builder canAllocate(@Nullable
 Decision value)

API name: can_allocate

canMoveToOtherNode

@Nonnull
public final AllocationExplainResponse.Builder canMoveToOtherNode(@Nullable
 Decision value)

API name: can_move_to_other_node

canRebalanceCluster

@Nonnull
public final AllocationExplainResponse.Builder canRebalanceCluster(@Nullable
 Decision value)

API name: can_rebalance_cluster

canRebalanceClusterDecisions

@Nonnull
public final AllocationExplainResponse.Builder canRebalanceClusterDecisions(List<AllocationDecision> list)

API name: can_rebalance_cluster_decisions

Adds all elements of list to canRebalanceClusterDecisions.

canRebalanceClusterDecisions

@Nonnull
public final AllocationExplainResponse.Builder canRebalanceClusterDecisions(AllocationDecision value,
 AllocationDecision... values)

API name: can_rebalance_cluster_decisions

Adds one or more values to canRebalanceClusterDecisions.

canRebalanceClusterDecisions

@Nonnull
public final AllocationExplainResponse.Builder canRebalanceClusterDecisions(Function<AllocationDecision.Builder,ObjectBuilder<AllocationDecision>> fn)

API name: can_rebalance_cluster_decisions

Adds a value to canRebalanceClusterDecisions using a builder lambda.

canRebalanceToOtherNode

@Nonnull
public final AllocationExplainResponse.Builder canRebalanceToOtherNode(@Nullable
 Decision value)

API name: can_rebalance_to_other_node

canRemainDecisions

@Nonnull
public final AllocationExplainResponse.Builder canRemainDecisions(List<AllocationDecision> list)

API name: can_remain_decisions

Adds all elements of list to canRemainDecisions.

canRemainDecisions

@Nonnull
public final AllocationExplainResponse.Builder canRemainDecisions(AllocationDecision value,
 AllocationDecision... values)

API name: can_remain_decisions

Adds one or more values to canRemainDecisions.

canRemainDecisions

@Nonnull
public final AllocationExplainResponse.Builder canRemainDecisions(Function<AllocationDecision.Builder,ObjectBuilder<AllocationDecision>> fn)

API name: can_remain_decisions

Adds a value to canRemainDecisions using a builder lambda.

canRemainOnCurrentNode

@Nonnull
public final AllocationExplainResponse.Builder canRemainOnCurrentNode(@Nullable
 Decision value)

API name: can_remain_on_current_node

clusterInfo

@Nonnull
public final AllocationExplainResponse.Builder clusterInfo(@Nullable
 ClusterInfo value)

API name: cluster_info

clusterInfo

@Nonnull
public final AllocationExplainResponse.Builder clusterInfo(Function<ClusterInfo.Builder,ObjectBuilder<ClusterInfo>> fn)

API name: cluster_info

configuredDelay

@Nonnull
public final AllocationExplainResponse.Builder configuredDelay(@Nullable
 Time value)

API name: configured_delay

configuredDelay

@Nonnull
public final AllocationExplainResponse.Builder configuredDelay(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: configured_delay

configuredDelayInMillis

@Nonnull
public final AllocationExplainResponse.Builder configuredDelayInMillis(@Nullable
 Long value)

API name: configured_delay_in_millis

currentNode

@Nonnull
public final AllocationExplainResponse.Builder currentNode(@Nullable
 CurrentNode value)

API name: current_node

currentNode

@Nonnull
public final AllocationExplainResponse.Builder currentNode(Function<CurrentNode.Builder,ObjectBuilder<CurrentNode>> fn)

API name: current_node

currentState

@Nonnull
public final AllocationExplainResponse.Builder currentState(String value)

Required - API name: current_state

index

@Nonnull
public final AllocationExplainResponse.Builder index(String value)

Required - API name: index

moveExplanation

@Nonnull
public final AllocationExplainResponse.Builder moveExplanation(@Nullable
 String value)

API name: move_explanation

nodeAllocationDecisions

@Nonnull
public final AllocationExplainResponse.Builder nodeAllocationDecisions(List<NodeAllocationExplanation> list)

API name: node_allocation_decisions

Adds all elements of list to nodeAllocationDecisions.

nodeAllocationDecisions

@Nonnull
public final AllocationExplainResponse.Builder nodeAllocationDecisions(NodeAllocationExplanation value,
 NodeAllocationExplanation... values)

API name: node_allocation_decisions

Adds one or more values to nodeAllocationDecisions.

nodeAllocationDecisions

@Nonnull
public final AllocationExplainResponse.Builder nodeAllocationDecisions(Function<NodeAllocationExplanation.Builder,ObjectBuilder<NodeAllocationExplanation>> fn)

API name: node_allocation_decisions

Adds a value to nodeAllocationDecisions using a builder lambda.

note

@Nonnull
public final AllocationExplainResponse.Builder note(@Nullable
 String value)

API name: note

primary

@Nonnull
public final AllocationExplainResponse.Builder primary(boolean value)

Required - API name: primary

rebalanceExplanation

@Nonnull
public final AllocationExplainResponse.Builder rebalanceExplanation(@Nullable
 String value)

API name: rebalance_explanation

remainingDelay

@Nonnull
public final AllocationExplainResponse.Builder remainingDelay(@Nullable
 Time value)

API name: remaining_delay

remainingDelay

@Nonnull
public final AllocationExplainResponse.Builder remainingDelay(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: remaining_delay

remainingDelayInMillis

@Nonnull
public final AllocationExplainResponse.Builder remainingDelayInMillis(@Nullable
 Long value)

API name: remaining_delay_in_millis

shard

@Nonnull
public final AllocationExplainResponse.Builder shard(int value)

Required - API name: shard

unassignedInfo

@Nonnull
public final AllocationExplainResponse.Builder unassignedInfo(@Nullable
 UnassignedInformation value)

API name: unassigned_info

unassignedInfo

@Nonnull
public final AllocationExplainResponse.Builder unassignedInfo(Function<UnassignedInformation.Builder,ObjectBuilder<UnassignedInformation>> fn)

API name: unassigned_info

build

@Nonnull
public AllocationExplainResponse build()

Builds a AllocationExplainResponse.

Specified by:

build in interface ObjectBuilder<AllocationExplainResponse>

Throws:

NullPointerException - if some of the required fields are null.