Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Class ShutdownShardMigrationStatus

java.lang.Object

org.elasticsearch.cluster.metadata.ShutdownShardMigrationStatus

All Implemented Interfaces:

Writeable, ChunkedToXContent, ChunkedToXContentObject

public class ShutdownShardMigrationStatus
extends Object
implements Writeable, ChunkedToXContentObject

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NODE_ALLOCATION_DECISION_KEY

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
ShutdownShardMigrationStatus(SingleNodeShutdownMetadata.Status status, long startedShards, long relocatingShards, long initializingShards)
ShutdownShardMigrationStatus(SingleNodeShutdownMetadata.Status status, long startedShards, long relocatingShards, long initializingShards, String explanation)
ShutdownShardMigrationStatus(SingleNodeShutdownMetadata.Status status, long shardsRemaining, String explanation, ShardAllocationDecision allocationDecision)
ShutdownShardMigrationStatus(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getExplanation()
long	getShardsRemaining()
SingleNodeShutdownMetadata.Status	getStatus()
int	hashCode()
String	toString()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params params)	Create an iterator of ToXContent chunks for a REST response.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

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

toXContentChunkedV7

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

isFragment

Field Details

NODE_ALLOCATION_DECISION_KEY

public static final String NODE_ALLOCATION_DECISION_KEY

See Also:

• Constant Field Values

Constructor Details

ShutdownShardMigrationStatus

public ShutdownShardMigrationStatus(SingleNodeShutdownMetadata.Status status,
 long shardsRemaining,
 @Nullable
 String explanation,
 @Nullable
 ShardAllocationDecision allocationDecision)

ShutdownShardMigrationStatus

public ShutdownShardMigrationStatus(SingleNodeShutdownMetadata.Status status,
 long startedShards,
 long relocatingShards,
 long initializingShards)

ShutdownShardMigrationStatus

public ShutdownShardMigrationStatus(SingleNodeShutdownMetadata.Status status,
 long startedShards,
 long relocatingShards,
 long initializingShards,
 @Nullable
 String explanation)

ShutdownShardMigrationStatus

public ShutdownShardMigrationStatus(StreamInput in)
                             throws IOException

Throws:

IOException

Method Details

getShardsRemaining

public long getShardsRemaining()

getExplanation

public String getExplanation()

getStatus

public SingleNodeShutdownMetadata.Status getStatus()

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params params)

Description copied from interface: ChunkedToXContent

Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. The last chunk in the iterator must always yield at least one byte of output. See also ChunkedToXContentHelper for some handy utilities.

Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.

Specified by:

toXContentChunked in interface ChunkedToXContent

Returns:

iterator over chunks of ToXContent

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object