Package org.elasticsearch.snapshots
Class RestoreInfo
- java.lang.Object
-
- org.elasticsearch.snapshots.RestoreInfo
-
- All Implemented Interfaces:
Streamable
,ToXContent
,ToXContentObject
public class RestoreInfo extends java.lang.Object implements ToXContentObject, 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 Description RestoreInfo(java.lang.String name, java.util.List<java.lang.String> indices, int totalShards, int successfulShards)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
failedShards()
Number of failed shardsjava.util.List<java.lang.String>
indices()
List of restored indicesjava.lang.String
name()
Snapshot namevoid
readFrom(StreamInput in)
Set this object's fields from a StreamInput.static RestoreInfo
readOptionalRestoreInfo(StreamInput in)
Reads optional restore info fromStreamInput
static RestoreInfo
readRestoreInfo(StreamInput in)
Reads restore info fromStreamInput
RestStatus
status()
REST status of the operationint
successfulShards()
Number of successful shardsint
totalShards()
Number of shards being restoredXContentBuilder
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.io.stream.Streamable
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
-
-
-
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 interfaceToXContent
- 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 interfaceStreamable
- 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 interfaceStreamable
- Throws:
java.io.IOException
-
readRestoreInfo
public static RestoreInfo readRestoreInfo(StreamInput in) throws java.io.IOException
Reads restore info fromStreamInput
- 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 fromStreamInput
- Parameters:
in
- stream input- Returns:
- restore info
- Throws:
java.io.IOException
-
-