Package org.elasticsearch.index.snapshots.blobstore

Class SnapshotFiles

java.lang.Object
org.elasticsearch.index.snapshots.blobstore.SnapshotFiles
public class SnapshotFiles
extends java.lang.Object
Contains a list of files participating in a snapshot

  • Constructor Summary

    Constructors
    Constructor Description
    SnapshotFiles​(java.lang.String snapshot, java.util.List<BlobStoreIndexShardSnapshot.FileInfo> indexFiles, java.lang.String shardStateIdentifier)  

  • Method Summary

    Modifier and Type Method Description
    boolean containPhysicalIndexFile​(java.lang.String physicalName)
    Returns true if this snapshot contains a file with a given original name
    BlobStoreIndexShardSnapshot.FileInfo findPhysicalIndexFile​(java.lang.String physicalName)
    Returns information about a physical file with the given name
    java.util.List<BlobStoreIndexShardSnapshot.FileInfo> indexFiles()
    Returns a list of file in the snapshot
    boolean isSame​(SnapshotFiles other)
    Checks if the given other instance contains the same files as well as the same shardStateIdentifier.
    java.lang.String shardStateIdentifier()
    Returns an identifier for the shard state that can be used to check whether a shard has changed between snapshots or not.
    java.lang.String snapshot()
    Returns snapshot name
    java.lang.String toString()  
    SnapshotFiles withSnapshotName​(java.lang.String snapshotName)
    Creates a new instance with the given snapshot name but otherwise identical to the current instance.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SnapshotFiles

      public SnapshotFiles​(java.lang.String snapshot, java.util.List<BlobStoreIndexShardSnapshot.FileInfo> indexFiles, @Nullable java.lang.String shardStateIdentifier)
      Parameters:
      snapshot - snapshot name
      indexFiles - index files
      shardStateIdentifier - unique identifier for the state of the shard that this snapshot was taken from

  • Method Details

    • snapshot

      public java.lang.String snapshot()
      Returns snapshot name
      Returns:
      snapshot name

    • withSnapshotName

      public SnapshotFiles withSnapshotName​(java.lang.String snapshotName)
      Creates a new instance with the given snapshot name but otherwise identical to the current instance.

    • isSame

      public boolean isSame​(SnapshotFiles other)
      Checks if the given other instance contains the same files as well as the same shardStateIdentifier.

    • shardStateIdentifier

      @Nullable public java.lang.String shardStateIdentifier()
      Returns an identifier for the shard state that can be used to check whether a shard has changed between snapshots or not.

    • indexFiles

      public java.util.List<BlobStoreIndexShardSnapshot.FileInfo> indexFiles()
      Returns a list of file in the snapshot

    • containPhysicalIndexFile

      public boolean containPhysicalIndexFile​(java.lang.String physicalName)
      Returns true if this snapshot contains a file with a given original name
      Parameters:
      physicalName - original file name
      Returns:
      true if the file was found, false otherwise

    • findPhysicalIndexFile

      public BlobStoreIndexShardSnapshot.FileInfo findPhysicalIndexFile​(java.lang.String physicalName)
      Returns information about a physical file with the given name
      Parameters:
      physicalName - the original file name
      Returns:
      information about this file

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object