org.elasticsearch.cluster

Class RestoreInProgress

java.lang.Object

org.elasticsearch.cluster.AbstractDiffable<ClusterState.Custom>

org.elasticsearch.cluster.RestoreInProgress

All Implemented Interfaces:

ClusterState.Custom, Diffable<ClusterState.Custom>, Writeable, ToXContent

public class RestoreInProgress
extends AbstractDiffable<ClusterState.Custom>
implements ClusterState.Custom

Meta data about restore processes that are currently executing

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestoreInProgress.Entry Restore metadata
static class	RestoreInProgress.ShardRestoreStatus Represents status of a restored shard
static class	RestoreInProgress.State Shard restore process state

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

Writeable.Reader<R>

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 RestoreInProgress	PROTO
static java.lang.String	TYPE

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
RestoreInProgress(java.util.List<RestoreInProgress.Entry> entries) Constructs new restore metadata
RestoreInProgress(RestoreInProgress.Entry... entries) Constructs new restore metadata

Method Summary

Modifier and Type	Method and Description
java.util.List<RestoreInProgress.Entry>	entries() Returns list of currently running restore processes
boolean	equals(java.lang.Object o)
int	hashCode()
RestoreInProgress	readFrom(StreamInput in) Reads an object of this type from the provided StreamInput.
RestoreInProgress.Entry	snapshot(SnapshotId snapshotId) Returns currently running restore process with corresponding snapshot id or null if this snapshot is not being restored
void	toXContent(RestoreInProgress.Entry entry, XContentBuilder builder, ToXContent.Params params) Serializes single restore operation
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
java.lang.String	type()
void	writeTo(StreamOutput out) Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.cluster.AbstractDiffable

diff, get, readDiffFrom, readDiffFrom

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.cluster.Diffable

diff, readDiffFrom

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

PROTO

public static final RestoreInProgress PROTO

Constructor Detail

RestoreInProgress

public RestoreInProgress(java.util.List<RestoreInProgress.Entry> entries)

Constructs new restore metadata

Parameters:

entries - list of currently running restore processes

RestoreInProgress

public RestoreInProgress(RestoreInProgress.Entry... entries)

Constructs new restore metadata

Parameters:

entries - list of currently running restore processes

Method Detail

entries

public java.util.List<RestoreInProgress.Entry> entries()

Returns list of currently running restore processes

Returns:

list of currently running restore processes

snapshot

public RestoreInProgress.Entry snapshot(SnapshotId snapshotId)

Returns currently running restore process with corresponding snapshot id or null if this snapshot is not being restored

Parameters:

snapshotId - snapshot id

Returns:

restore metadata or null

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

type

public java.lang.String type()

Specified by:

type in interface ClusterState.Custom

readFrom

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

Reads an object of this type from the provided StreamInput. The receiving instance remains unchanged.

Specified by:

readFrom in interface Diffable<ClusterState.Custom>

Throws:

java.io.IOException

writeTo

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

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

toXContent

public void toXContent(RestoreInProgress.Entry entry,
                       XContentBuilder builder,
                       ToXContent.Params params)
                throws java.io.IOException

Serializes single restore operation

Parameters:

entry - restore operation metadata

builder - XContent builder

params - serialization parameters

Throws:

java.io.IOException