Module org.elasticsearch.server
Package org.elasticsearch.snapshots

Enum Class SnapshotState

java.lang.Object
java.lang.Enum<SnapshotState>
org.elasticsearch.snapshots.SnapshotState
All Implemented Interfaces:
Serializable, Comparable<SnapshotState>, Constable
public enum SnapshotState extends Enum<SnapshotState>
Represents the state of a snapshot.

The state is determined during snapshot finalization and stored in the SnapshotInfo object in the repository, and this is also duplicated in RepositoryData.SnapshotDetails. These values can be read back by the get-snapshots and restore-snapshots APIs.

  • Enum Constant Details

    • IN_PROGRESS

      public static final SnapshotState IN_PROGRESS
      Snapshot process has started

    • SUCCESS

      public static final SnapshotState SUCCESS
      Snapshot process completed successfully

    • FAILED

      public static final SnapshotState FAILED
      Snapshots stored in the repository are only in state FAILED if they were aborted because deletion was requested while they were running. The existence of such a snapshot is usually temporary since the deletion of the now-finalized snapshot is enqueued at the same time, and (unless the deletion fails) will remove the FAILED snapshot from the repository once all running snapshots have finished.

      FAILED snapshots are not available for restore; see PARTIAL for partial backups that are retained.

    • PARTIAL

      public static final SnapshotState PARTIAL
      Snapshot completed with at least one shard failure (e.g. because a node left the cluster) but was not aborted. The snapshot remains in the repository and successful shards may be restored.

    • INCOMPATIBLE

      public static final SnapshotState INCOMPATIBLE
      Snapshot is incompatible with the current version of the cluster

  • Method Details

    • values

      public static SnapshotState[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SnapshotState valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • value

      public byte value()
      Returns code that represents the snapshot state
      Returns:
      code for the state

    • completed

      public boolean completed()
      Returns true if snapshot completed (successfully or not)
      Returns:
      true if snapshot completed, false otherwise

    • restorable

      public boolean restorable()
      Returns true if snapshot can be restored (at least partially)
      Returns:
      true if snapshot can be restored, false otherwise

    • fromValue

      public static SnapshotState fromValue(byte value)
      Generate snapshot state from code
      Parameters:
      value - the state code
      Returns:
      state