Class SnapshotShardContext

All Implemented Interfaces:

public final class SnapshotShardContext extends ActionListener.Delegating<ShardSnapshotResult,ShardSnapshotResult>
Context holding the state for creating a shard snapshot via Repository.snapshotShard(SnapshotShardContext). Wraps a Engine.IndexCommitRef that is released once this instances is completed by invoking either its onResponse(ShardSnapshotResult) or ActionListener.Delegating.onFailure(Exception) callback.
  • Constructor Details

    • SnapshotShardContext

      public SnapshotShardContext(Store store, MapperService mapperService, SnapshotId snapshotId, IndexId indexId, Engine.IndexCommitRef commitRef, @Nullable String shardStateIdentifier, IndexShardSnapshotStatus snapshotStatus, Version repositoryMetaVersion, Map<String,Object> userMetadata, ActionListener<ShardSnapshotResult> listener)
      store - store to be snapshotted
      mapperService - the shards mapper service
      snapshotId - snapshot id
      indexId - id for the index being snapshotted
      commitRef - commit point reference
      shardStateIdentifier - a unique identifier of the state of the shard that is stored with the shard's snapshot and used to detect if the shard has changed between snapshots. If null is passed as the identifier snapshotting will be done by inspecting the physical files referenced by snapshotIndexCommit
      snapshotStatus - snapshot status
      repositoryMetaVersion - version of the updated repository metadata to write
      userMetadata - user metadata of the snapshot found in SnapshotsInProgress.Entry.userMetadata()
      listener - listener invoked on completion
  • Method Details

    • store

      public Store store()
    • mapperService

      public MapperService mapperService()
    • snapshotId

      public SnapshotId snapshotId()
    • indexId

      public IndexId indexId()
    • indexCommit

      public org.apache.lucene.index.IndexCommit indexCommit()
    • stateIdentifier

      @Nullable public String stateIdentifier()
    • status

      public IndexShardSnapshotStatus status()
    • getRepositoryMetaVersion

      public Version getRepositoryMetaVersion()
    • userMetadata

      public Map<String,Object> userMetadata()
    • onResponse

      public void onResponse(ShardSnapshotResult result)
      Description copied from interface: ActionListener
      Handle action response. This response may constitute a failure or a success but it is up to the listener to make that decision.