org.elasticsearch.snapshots

Class RestoreInfo

java.lang.Object

org.elasticsearch.snapshots.RestoreInfo

All Implemented Interfaces:

Streamable, ToXContent

public class RestoreInfo
extends java.lang.Object
implements ToXContent, Streamable

Information about successfully completed restore operation.

Returned as part of RestoreSnapshotResponse

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
RestoreInfo(java.lang.String name, java.util.List<java.lang.String> indices, int totalShards, int successfulShards)

Method Summary

Modifier and Type	Method and Description
int	failedShards() Number of failed shards
java.util.List<java.lang.String>	indices() List of restored indices
java.lang.String	name() Snapshot name
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
static RestoreInfo	readOptionalRestoreInfo(StreamInput in) Reads optional restore info from StreamInput
static RestoreInfo	readRestoreInfo(StreamInput in) Reads restore info from StreamInput
RestStatus	status() REST status of the operation
int	successfulShards() Number of successful shards
int	totalShards() Number of shards being restored
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out) Write this object's fields to a StreamOutput.

Methods inherited from class java.lang.Object

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

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

isFragment

Constructor Detail

RestoreInfo

public RestoreInfo(java.lang.String name,
                   java.util.List<java.lang.String> indices,
                   int totalShards,
                   int successfulShards)

Method Detail

name

public java.lang.String name()

Snapshot name

Returns:

snapshot name

indices

public java.util.List<java.lang.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 java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

readFrom

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

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Throws:

java.io.IOException

writeTo

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

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Throws:

java.io.IOException

readRestoreInfo

public static RestoreInfo readRestoreInfo(StreamInput in)
                                   throws java.io.IOException

Reads restore info from StreamInput

Parameters:

in - stream input

Returns:

restore info

Throws:

java.io.IOException

readOptionalRestoreInfo

public static RestoreInfo readOptionalRestoreInfo(StreamInput in)
                                           throws java.io.IOException

Reads optional restore info from StreamInput

Parameters:

in - stream input

Returns:

restore info

Throws:

java.io.IOException