Module org.elasticsearch.server

Package org.elasticsearch.cluster

Class RestoreInProgress

java.lang.Object

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

org.elasticsearch.cluster.RestoreInProgress

All Implemented Interfaces:

Iterable<RestoreInProgress.Entry>, ClusterState.Custom, Diffable<ClusterState.Custom>, NamedDiffable<ClusterState.Custom>, NamedWriteable, VersionedNamedWriteable, Writeable, ToXContent, ToXContentFragment

public class RestoreInProgress
extends AbstractNamedDiffable<ClusterState.Custom>
implements ClusterState.Custom, Iterable<RestoreInProgress.Entry>

Meta data about restore processes that are currently executing

Nested Class Summary

Nested Classes

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

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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 RestoreInProgress	EMPTY
static final String	TYPE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RestoreInProgress(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
RestoreInProgress.Entry	get(String restoreUUID)
Version	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
boolean	isEmpty()
Iterator<RestoreInProgress.Entry>	iterator()
static NamedDiff<ClusterState.Custom>	readDiffFrom(StreamInput in)
String	toString()
static void	toXContent(RestoreInProgress.Entry entry, XContentBuilder builder)	Serializes single restore operation
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)	Serialize this ClusterState.Custom for diagnostic purposes, exposed by the
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.cluster.AbstractNamedDiffable

diff, get, readDiffFrom

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.cluster.ClusterState.Custom

isPrivate

Methods inherited from interface org.elasticsearch.cluster.Diffable

diff

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

EMPTY

public static final RestoreInProgress EMPTY

Constructor Details

RestoreInProgress

public RestoreInProgress(StreamInput in)
                  throws IOException

Throws:

IOException

Method Details

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

get

public RestoreInProgress.Entry get(String restoreUUID)

isEmpty

public boolean isEmpty()

iterator

public Iterator<RestoreInProgress.Entry> iterator()

Specified by:

iterator in interface Iterable<RestoreInProgress.Entry>

getWriteableName

public String getWriteableName()

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getMinimalSupportedVersion

public Version getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

readDiffFrom

public static NamedDiff<ClusterState.Custom> readDiffFrom(StreamInput in)
                                                   throws IOException

Throws:

IOException

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

toXContent

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

Description copied from interface: ClusterState.Custom

Serialize this ClusterState.Custom for diagnostic purposes, exposed by the

GET _cluster/state

API etc. The XContent representation does not need to be 100% faithful since we never reconstruct a cluster state from its XContent representation, but the more faithful it is the more useful it is for diagnostics.

Specified by:

toXContent in interface ClusterState.Custom

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toXContent

public static void toXContent(RestoreInProgress.Entry entry,
 XContentBuilder builder)
                       throws IOException

Serializes single restore operation

Parameters:

entry - restore operation metadata

builder - XContent builder

Throws:

IOException