Package org.elasticsearch.cluster

Class SnapshotsInProgress

java.lang.Object
org.elasticsearch.cluster.AbstractNamedDiffable<ClusterState.Custom>
org.elasticsearch.cluster.SnapshotsInProgress
All Implemented Interfaces:
ClusterState.Custom, ClusterState.FeatureAware, Diffable<ClusterState.Custom>, NamedDiffable<ClusterState.Custom>, NamedWriteable, VersionedNamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment
public class SnapshotsInProgress
extends AbstractNamedDiffable<ClusterState.Custom>
implements ClusterState.Custom
Meta data about snapshots that are currently executing

  • Field Details

  • Constructor Details

    • SnapshotsInProgress

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

  • Method Details

    • 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

    • startedEntry

      public static SnapshotsInProgress.Entry startedEntry​(Snapshot snapshot, boolean includeGlobalState, boolean partial, java.util.List<IndexId> indices, java.util.List<java.lang.String> dataStreams, long startTime, long repositoryStateId, ImmutableOpenMap<ShardId,​SnapshotsInProgress.ShardSnapshotStatus> shards, java.util.Map<java.lang.String,​java.lang.Object> userMetadata, Version version, java.util.List<SnapshotFeatureInfo> featureStates)
      Creates the initial SnapshotsInProgress.Entry when starting a snapshot, if no shard-level snapshot work is to be done the resulting entry will be in state SnapshotsInProgress.State.SUCCESS right away otherwise it will be in state SnapshotsInProgress.State.STARTED.

    • startClone

      public static SnapshotsInProgress.Entry startClone​(Snapshot snapshot, SnapshotId source, java.util.List<IndexId> indices, long startTime, long repositoryStateId, Version version)
      Creates the initial snapshot clone entry
      Parameters:
      snapshot - snapshot to clone into
      source - snapshot to clone from
      indices - indices to clone
      startTime - start time
      repositoryStateId - repository state id that this clone is based on
      version - repository metadata version to write
      Returns:
      snapshot clone entry

    • completed

      public static boolean completed​(com.carrotsearch.hppc.ObjectContainer<SnapshotsInProgress.ShardSnapshotStatus> shards)
      Checks if all shards in the list have completed
      Parameters:
      shards - list of shard statuses
      Returns:
      true if all shards have completed (either successfully or failed), false otherwise

    • of

      public static SnapshotsInProgress of​(java.util.List<SnapshotsInProgress.Entry> entries)

    • entries

      public java.util.List<SnapshotsInProgress.Entry> entries()

    • snapshot

      public SnapshotsInProgress.Entry snapshot​(Snapshot snapshot)

    • getWriteableName

      public java.lang.String getWriteableName()
      Description copied from interface: VersionedNamedWriteable
      Returns the name of the writeable object
      Specified by:
      getWriteableName in interface NamedWriteable
      Specified by:
      getWriteableName in interface VersionedNamedWriteable

    • getMinimalSupportedVersion

      public Version getMinimalSupportedVersion()
      Description copied from interface: VersionedNamedWriteable
      The minimal version of the recipient this object can be sent to
      Specified by:
      getMinimalSupportedVersion in interface VersionedNamedWriteable

    • readDiffFrom

      public static NamedDiff<ClusterState.Custom> readDiffFrom​(StreamInput in) 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

    • 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