Package org.elasticsearch.cluster.metadata

Class NodeShutdownComponentStatus

java.lang.Object

org.elasticsearch.cluster.AbstractDiffable<NodeShutdownComponentStatus>

org.elasticsearch.cluster.metadata.NodeShutdownComponentStatus

All Implemented Interfaces:

Diffable<NodeShutdownComponentStatus>, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment

public class NodeShutdownComponentStatus
extends AbstractDiffable<NodeShutdownComponentStatus>
implements org.elasticsearch.common.xcontent.ToXContentFragment

Contains information about the status of a single component (e.g. `shard_migration`, `persistent_tasks`) of the node shutdown process.

Nested Class Summary

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
NodeShutdownComponentStatus()
NodeShutdownComponentStatus(SingleNodeShutdownMetadata.Status status, java.lang.Long startedAtMillis, java.lang.String errorMessage)
NodeShutdownComponentStatus(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.lang.String	getErrorMessage()
java.lang.Long	getStartedAtMillis()
SingleNodeShutdownMetadata.Status	getStatus()
int	hashCode()
static NodeShutdownComponentStatus	parse(org.elasticsearch.common.xcontent.XContentParser parser)
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.cluster.AbstractDiffable

diff, readDiffFrom

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Constructor Details

NodeShutdownComponentStatus

public NodeShutdownComponentStatus()

NodeShutdownComponentStatus

public NodeShutdownComponentStatus(SingleNodeShutdownMetadata.Status status,
@Nullable
java.lang.Long startedAtMillis,
@Nullable
java.lang.String errorMessage)

NodeShutdownComponentStatus

public NodeShutdownComponentStatus(StreamInput in)
                            throws java.io.IOException

Throws:

java.io.IOException

Method Details

parse

public static NodeShutdownComponentStatus parse(org.elasticsearch.common.xcontent.XContentParser parser)

getStatus

public SingleNodeShutdownMetadata.Status getStatus()

Returns:

The overall status of this component.

getStartedAtMillis

@Nullable
public java.lang.Long getStartedAtMillis()

Returns:

The timestamp this component started shutting down. Null if the component has not yet started shutting down.

getErrorMessage

@Nullable
public java.lang.String getErrorMessage()

Returns:

The error message this component encountered while trying to shut down, if any. Null if no errors have been encountered.

toXContent

public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                             throws java.io.IOException

Specified by:

toXContent in interface org.elasticsearch.common.xcontent.ToXContent

Throws:

java.io.IOException

writeTo

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

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object