Package org.elasticsearch.snapshots

Class RestoreInfo

java.lang.Object
org.elasticsearch.snapshots.RestoreInfo
All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class RestoreInfo
extends java.lang.Object
implements org.elasticsearch.common.xcontent.ToXContentObject, Writeable
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

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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.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)  
    RestoreInfo​(StreamInput in)  

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object o)  
    int failedShards()
    Number of failed shards
    static RestoreInfo fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)  
    int hashCode()  
    java.util.List<java.lang.String> indices()
    List of restored indices
    java.lang.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
    java.lang.String toString()  
    int totalShards()
    Number of shards being restored
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.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.common.xcontent.ToXContentObject

    isFragment

  • Constructor Details

    • RestoreInfo

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

    • RestoreInfo

      public RestoreInfo​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

  • Method Details

    • 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 org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • fromXContent

      public static RestoreInfo fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) 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

    • 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

    • 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