Class SnapshotFiles
java.lang.Object
org.opensearch.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 nameBlobStoreIndexShardSnapshot.FileInfo
findPhysicalIndexFile(java.lang.String physicalName)
Returns information about a physical file with the given namejava.util.List<BlobStoreIndexShardSnapshot.FileInfo>
indexFiles()
Returns a list of file in the snapshotboolean
isSame(SnapshotFiles other)
Checks if the given other instance contains the same files as well as the sameshardStateIdentifier
.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 nameSnapshotFiles
withSnapshotName(java.lang.String snapshotName)
Creates a new instance with the given snapshot name but otherwise identical to the current instance.
-
Constructor Details
-
SnapshotFiles
public SnapshotFiles(java.lang.String snapshot, java.util.List<BlobStoreIndexShardSnapshot.FileInfo> indexFiles, @Nullable java.lang.String shardStateIdentifier)- Parameters:
snapshot
- snapshot nameindexFiles
- index filesshardStateIdentifier
- 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
Creates a new instance with the given snapshot name but otherwise identical to the current instance. -
isSame
Checks if the given other instance contains the same files as well as the sameshardStateIdentifier
. -
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
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
Returns information about a physical file with the given name- Parameters:
physicalName
- the original file name- Returns:
- information about this file
-