org.elasticsearch.cluster.routing.allocation

Class AllocationExplanation

java.lang.Object

org.elasticsearch.cluster.routing.allocation.AllocationExplanation

All Implemented Interfaces:

Streamable

public class AllocationExplanation
extends java.lang.Object
implements Streamable

Instances of this class keeps explanations of decisions that have been made by allocation. An AllocationExplanation consists of a set of per node explanations. Since AllocationExplanation.NodeExplanations are related to shards an AllocationExplanation maps a shards id to a set of AllocationExplanation.NodeExplanations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AllocationExplanation.NodeExplanation Instances of this class keep messages and informations about nodes of an allocation

Field Summary

Fields

Modifier and Type	Field and Description
static AllocationExplanation	EMPTY

Constructor Summary

Constructors

Constructor and Description
AllocationExplanation()

Method Summary

Modifier and Type	Method and Description
AllocationExplanation	add(ShardId shardId, AllocationExplanation.NodeExplanation nodeExplanation) Create and add a node explanation to this explanation referencing a shard
java.util.Map<ShardId,java.util.List<AllocationExplanation.NodeExplanation>>	explanations() List of explanations involved by this AllocationExplanation
static AllocationExplanation	readAllocationExplanation(StreamInput in) Read an AllocationExplanation from an StreamInput
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
void	writeTo(StreamOutput out) Write this object's fields to a StreamOutput.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final AllocationExplanation EMPTY

Constructor Detail

AllocationExplanation

public AllocationExplanation()

Method Detail

add

public AllocationExplanation add(ShardId shardId,
                                 AllocationExplanation.NodeExplanation nodeExplanation)

Create and add a node explanation to this explanation referencing a shard

Parameters:

shardId - id the of the referenced shard

nodeExplanation - Explanation itself

Returns:

AllocationExplanation involving the explanation

explanations

public java.util.Map<ShardId,java.util.List<AllocationExplanation.NodeExplanation>> explanations()

List of explanations involved by this AllocationExplanation

Returns:

Map of shard ids and corresponding explanations

readAllocationExplanation

public static AllocationExplanation readAllocationExplanation(StreamInput in)
                                                       throws java.io.IOException

Read an AllocationExplanation from an StreamInput

Parameters:

in - StreamInput to read from

Returns:

a new AllocationExplanation read from the stream

Throws:

java.io.IOException - if something bad happened while reading

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Throws:

java.io.IOException