java.lang.Object

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

org.elasticsearch.cluster.RestoreInProgress

All Implemented Interfaces:: java.lang.Iterable<RestoreInProgress.Entry>, ClusterState.Custom, ClusterState.FeatureAware, Diffable<ClusterState.Custom>, NamedDiffable<ClusterState.Custom>, NamedWriteable, VersionedNamedWriteable, Writeable, ToXContent, ToXContentFragment

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

Meta data about restore processes that are currently executing

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`RestoreInProgress.Builder`
`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.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 java.lang.String`	`BWC_UUID`	Fallback UUID used for restore operations that were started before v6.6 and don't have a uuid in the cluster state.
`static java.lang.String`	`TYPE`

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor Description

RestoreInProgress(StreamInput in)

Method Summary

Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object o)`
`RestoreInProgress.Entry`	`get(java.lang.String restoreUUID)`
`Version`	`getMinimalSupportedVersion()`	The minimal version of the recipient this object can be sent to
`java.lang.String`	`getWriteableName()`	Returns the name of the writeable object
`int`	`hashCode()`
`boolean`	`isEmpty()`
`java.util.Iterator<RestoreInProgress.Entry>`	`iterator()`
`static NamedDiff<ClusterState.Custom>`	`readDiffFrom(StreamInput in)`
`java.lang.String`	`toString()`
`void`	`toXContent(RestoreInProgress.Entry entry, XContentBuilder builder)`	Serializes single restore operation
`XContentBuilder`	`toXContent(XContentBuilder builder, ToXContent.Params params)`
`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.ClusterState.FeatureAware

getRequiredFeature

Methods inherited from interface org.elasticsearch.cluster.Diffable

diff

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

isFragment

Field Details
- BWC_UUID
  
  public static final java.lang.String BWC_UUID
  
  Fallback UUID used for restore operations that were started before v6.6 and don't have a uuid in the cluster state.
- TYPE
  
  public static final java.lang.String TYPE
  
  See Also:
  
  Constant Field Values
Constructor Details
- RestoreInProgress
  
  public RestoreInProgress(StreamInput in) throws java.io.IOException
  
  Throws:
  
  java.io.IOException
Method Details
- 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
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object
- get
  
  public RestoreInProgress.Entry get(java.lang.String restoreUUID)
- isEmpty
  
  public boolean isEmpty()
- iterator
  
  public java.util.Iterator<RestoreInProgress.Entry> iterator()
  
  Specified by:
  
  iterator in interface java.lang.Iterable<RestoreInProgress.Entry>
- getWriteableName
  
  public java.lang.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 java.io.IOException
  
  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
- 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) throws java.io.IOException
  
  Serializes single restore operation
  
  Parameters:
  
  entry - restore operation metadata
  
  builder - XContent builder
  
  Throws:
  
  java.io.IOException

Class RestoreInProgress