org.elasticsearch.cluster.routing

Class UnassignedInfo

java.lang.Object

org.elasticsearch.cluster.routing.UnassignedInfo

All Implemented Interfaces:

StreamableReader<UnassignedInfo>, Writeable<UnassignedInfo>, ToXContent

public class UnassignedInfo
extends Object
implements ToXContent, Writeable<UnassignedInfo>

Holds additional information as to why the shard is in unassigned state.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UnassignedInfo.Reason Reason why the shard is in unassigned state.

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static FormatDateTimeFormatter	DATE_TIME_FORMATTER
static String	INDEX_DELAYED_NODE_LEFT_TIMEOUT_SETTING

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
UnassignedInfo(UnassignedInfo.Reason reason, String message) creates an UnassingedInfo object based **current** time
UnassignedInfo(UnassignedInfo.Reason reason, String message, Throwable failure, long unassignedTimeNanos, long unassignedTimeMillis)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
static long	findNextDelayedAllocationIn(ClusterState state) Finds the next (closest) delay expiration of an unassigned shard in nanoseconds.
static long	findSmallestDelayedAllocationSettingNanos(Settings settings, ClusterState state) Finds the smallest delay expiration setting in nanos of all unassigned shards that are still delayed.
long	getAllocationDelayTimeoutSettingNanos(Settings settings, Settings indexSettings) The allocation delay value in nano seconds associated with the index (defaulting to node settings if not set).
String	getDetails() Builds a string representation of the message and the failure if exists.
Throwable	getFailure() Returns additional failure exception details if exists.
long	getLastComputedLeftDelayNanos() The delay in nanoseconds until this unassigned shard can be reassigned.
String	getMessage() Returns optional details explaining the reasons.
static int	getNumberOfDelayedUnassigned(ClusterState state) Returns the number of shards that are unassigned and currently being delayed.
UnassignedInfo.Reason	getReason() The reason why the shard is unassigned.
long	getUnassignedTimeInMillis() The timestamp in milliseconds when the shard became unassigned, based on System.currentTimeMillis().
long	getUnassignedTimeInNanos() The timestamp in nanoseconds when the shard became unassigned, based on System.nanoTime().
int	hashCode()
UnassignedInfo	readFrom(StreamInput in) Reads a copy of an object with the same type form the stream input The caller object remains unchanged.
String	shortSummary()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
long	updateDelay(long nanoTimeNow, Settings settings, Settings indexSettings) Updates delay left based on current time (in nanoseconds) and index/node settings.
void	writeTo(StreamOutput out) Writes the current object into the output stream out

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DATE_TIME_FORMATTER

public static final FormatDateTimeFormatter DATE_TIME_FORMATTER

INDEX_DELAYED_NODE_LEFT_TIMEOUT_SETTING

public static final String INDEX_DELAYED_NODE_LEFT_TIMEOUT_SETTING

See Also:

Constant Field Values

Constructor Detail

UnassignedInfo

public UnassignedInfo(UnassignedInfo.Reason reason,
              String message)

creates an UnassingedInfo object based **current** time

Parameters:

reason - the cause for making this shard unassigned. See UnassignedInfo.Reason for more information.

message - more information about cause.

UnassignedInfo

public UnassignedInfo(UnassignedInfo.Reason reason,
              @Nullable
              String message,
              @Nullable
              Throwable failure,
              long unassignedTimeNanos,
              long unassignedTimeMillis)

Parameters:

reason - the cause for making this shard unassigned. See UnassignedInfo.Reason for more information.

message - more information about cause.

failure - the shard level failure that caused this shard to be unassigned, if exists.

unassignedTimeNanos - the time to use as the base for any delayed re-assignment calculation

unassignedTimeMillis - the time of unassignment used to display to in our reporting.

Method Detail

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Writes the current object into the output stream out

Specified by:

writeTo in interface Writeable<UnassignedInfo>

Throws:

IOException

readFrom

public UnassignedInfo readFrom(StreamInput in)
                        throws IOException

Description copied from interface: StreamableReader

Reads a copy of an object with the same type form the stream input The caller object remains unchanged.

Specified by:

readFrom in interface StreamableReader<UnassignedInfo>

Throws:

IOException

getReason

public UnassignedInfo.Reason getReason()

The reason why the shard is unassigned.

getUnassignedTimeInMillis

public long getUnassignedTimeInMillis()

The timestamp in milliseconds when the shard became unassigned, based on System.currentTimeMillis(). Note, we use timestamp here since we want to make sure its preserved across node serializations.

getUnassignedTimeInNanos

public long getUnassignedTimeInNanos()

The timestamp in nanoseconds when the shard became unassigned, based on System.nanoTime(). Used to calculate the delay for delayed shard allocation. ONLY EXPOSED FOR TESTS!

getMessage

@Nullable
public String getMessage()

Returns optional details explaining the reasons.

getFailure

@Nullable
public Throwable getFailure()

Returns additional failure exception details if exists.

getDetails

@Nullable
public String getDetails()

Builds a string representation of the message and the failure if exists.

getAllocationDelayTimeoutSettingNanos

public long getAllocationDelayTimeoutSettingNanos(Settings settings,
                                         Settings indexSettings)

The allocation delay value in nano seconds associated with the index (defaulting to node settings if not set).

getLastComputedLeftDelayNanos

public long getLastComputedLeftDelayNanos()

The delay in nanoseconds until this unassigned shard can be reassigned. This value is cached and might be slightly out-of-date. See also the updateDelay(long, Settings, Settings) method.

updateDelay

public long updateDelay(long nanoTimeNow,
               Settings settings,
               Settings indexSettings)

Updates delay left based on current time (in nanoseconds) and index/node settings.

Returns:

updated delay in nanoseconds

getNumberOfDelayedUnassigned

public static int getNumberOfDelayedUnassigned(ClusterState state)

Returns the number of shards that are unassigned and currently being delayed.

findSmallestDelayedAllocationSettingNanos

public static long findSmallestDelayedAllocationSettingNanos(Settings settings,
                                             ClusterState state)

Finds the smallest delay expiration setting in nanos of all unassigned shards that are still delayed. Returns 0 if there are none.

findNextDelayedAllocationIn

public static long findNextDelayedAllocationIn(ClusterState state)

Finds the next (closest) delay expiration of an unassigned shard in nanoseconds. Returns 0 if there are none.

shortSummary

public String shortSummary()

toString

public String toString()

Overrides:

toString in class Object

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                         ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object