Package org.elasticsearch.snapshots

Class RestoreInfo

java.lang.Object

org.elasticsearch.snapshots.RestoreInfo

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class RestoreInfo
extends Object
implements ToXContentObject, Writeable

Information about successfully completed restore operation.

Returned as part of RestoreSnapshotResponse

Nested Class Summary

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 inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RestoreInfo(String name, List<String> indices, int totalShards, int successfulShards)
RestoreInfo(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	failedShards()	Number of failed shards
static RestoreInfo	fromXContent(XContentParser parser)
int	hashCode()
List<String>	indices()	List of restored indices
String	name()	Snapshot name
static RestoreInfo	readOptionalRestoreInfo(StreamInput in)	Reads optional restore info from StreamInput
RestStatus	status()	REST status of the operation
int	successfulShards()	Number of successful shards
String	toString()
int	totalShards()	Number of shards being restored
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
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.xcontent.ToXContentObject

isFragment

Constructor Details

RestoreInfo

public RestoreInfo(String name,
 List<String> indices,
 int totalShards,
 int successfulShards)

RestoreInfo

public RestoreInfo(StreamInput in)
            throws IOException

Throws:

IOException

Method Details

name

public String name()

Snapshot name

Returns:

snapshot name

indices

public List<String> indices()

List of restored indices

Returns:

list of restored indices

totalShards

public int totalShards()

Number of shards being restored

Returns:

number of being restored

failedShards

public int failedShards()

Number of failed shards

Returns:

number of failed shards

successfulShards

public int successfulShards()

Number of successful shards

Returns:

number of successful shards

status

public RestStatus status()

REST status of the operation

Returns:

REST status

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static RestoreInfo fromXContent(XContentParser parser)
                                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

readOptionalRestoreInfo

public static RestoreInfo readOptionalRestoreInfo(StreamInput in)
                                           throws IOException

Reads optional restore info from StreamInput

Parameters:

in - stream input

Returns:

restore info

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