org.apache.ratis.statemachine

Interface SnapshotInfo

All Known Implementing Classes:

FileListSnapshotInfo, SingleFileSnapshotInfo

public interface SnapshotInfo

SnapshotInfo represents a durable state by the state machine. The state machine implementation is responsible for the layout of the snapshot files as well as making the data durable. Latest term, latest index, and the raft configuration must be saved together with any data files in the snapshot.

Method Summary

Modifier and Type	Method and Description
List<FileInfo>	getFiles() Returns a list of files corresponding to this snapshot.
long	getIndex() Returns the index corresponding to this snapshot.
long	getTerm() Returns the term corresponding to this snapshot.
TermIndex	getTermIndex() Returns the term and index corresponding to this snapshot.

Method Detail

getTermIndex

TermIndex getTermIndex()

Returns the term and index corresponding to this snapshot.

Returns:

The term and index corresponding to this snapshot.

getTerm

long getTerm()

Returns the term corresponding to this snapshot.

Returns:

The term corresponding to this snapshot.

getIndex

long getIndex()

Returns the index corresponding to this snapshot.

Returns:

The index corresponding to this snapshot.

getFiles

List<FileInfo> getFiles()

Returns a list of files corresponding to this snapshot. This list should include all the files that the state machine keeps in its data directory. This list of files will be copied as to other replicas in install snapshot RPCs.

Returns:

a list of Files corresponding to the this snapshot.