Module org.elasticsearch.server

Package org.elasticsearch.repositories

Class SnapshotShardContextHelper

java.lang.Object

org.elasticsearch.repositories.SnapshotShardContextHelper

public class SnapshotShardContextHelper
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	SnapshotShardContextHelper.SnapshotIndexCommitAndShardStateId

Field Summary

Fields

Modifier and Type	Field	Description
static final Logger	logger

Method Summary

Modifier and Type	Method	Description
static SnapshotShardContextHelper.SnapshotIndexCommitAndShardStateId	acquireSnapshotIndexCommit(ClusterService clusterService, IndexShard indexShard, Snapshot snapshot, boolean supportsRelocationDuringSnapshot, IndexShardSnapshotStatus snapshotStatus)	Acquire an index commit for the shard snapshot, validating that the shard is a started primary and no resharding is in progress.
static void	closeSnapshotIndexCommit(SnapshotIndexCommit snapshotIndexCommit, ShardId shardId, Snapshot snapshot)
static void	maybeEnsureNotAborted(IndexShardSnapshotStatus snapshotStatus)
static Releasable	withSnapshotIndexCommitRef(ShardId shardId, SnapshotId snapshotId, SnapshotIndexCommit snapshotIndexCommit, IndexShardSnapshotStatus snapshotStatus)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

logger

public static final Logger logger

Method Details

acquireSnapshotIndexCommit

public static SnapshotShardContextHelper.SnapshotIndexCommitAndShardStateId acquireSnapshotIndexCommit(ClusterService clusterService,
 IndexShard indexShard,
 Snapshot snapshot,
 boolean supportsRelocationDuringSnapshot,
 @Nullable
 IndexShardSnapshotStatus snapshotStatus)
                                                                                                throws IOException

Acquire an index commit for the shard snapshot, validating that the shard is a started primary and no resharding is in progress. A null snapshotStatus means the snapshot is running on a remote node, abort handling and status updates skipped on this node as they are handled on the remote node. When it is non-null, the snapshot is running locally and abort listener is registered.

Throws:

IOException

closeSnapshotIndexCommit

public static void closeSnapshotIndexCommit(SnapshotIndexCommit snapshotIndexCommit,
 ShardId shardId,
 Snapshot snapshot)

withSnapshotIndexCommitRef

public static Releasable withSnapshotIndexCommitRef(ShardId shardId,
 SnapshotId snapshotId,
 SnapshotIndexCommit snapshotIndexCommit,
 @Nullable
 IndexShardSnapshotStatus snapshotStatus)

maybeEnsureNotAborted

public static void maybeEnsureNotAborted(@Nullable
 IndexShardSnapshotStatus snapshotStatus)