Module org.elasticsearch.server

Package org.elasticsearch.repositories

Class FinalizeSnapshotContext

java.lang.Object

org.elasticsearch.action.DelegatingActionListener<RepositoryData,RepositoryData>

org.elasticsearch.repositories.FinalizeSnapshotContext

All Implemented Interfaces:

ActionListener<RepositoryData>

public final class FinalizeSnapshotContext
extends DelegatingActionListener<RepositoryData,RepositoryData>

Context for finalizing a snapshot.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FinalizeSnapshotContext.UpdatedShardGenerations	A record used to track the new shard generations that have been written for each shard in a snapshot.

Field Summary

Fields inherited from class org.elasticsearch.action.DelegatingActionListener

delegate

Constructor Summary

Constructors

Constructor	Description
FinalizeSnapshotContext(FinalizeSnapshotContext.UpdatedShardGenerations updatedShardGenerations, long repositoryStateId, Metadata clusterMetadata, SnapshotInfo snapshotInfo, IndexVersion repositoryMetaVersion, ActionListener<RepositoryData> listener, Runnable onDone)

Method Summary

Modifier and Type	Method	Description
Metadata	clusterMetadata()
Map<RepositoryShardId,Set<ShardGeneration>>	obsoleteShardGenerations()
void	onDone()
void	onResponse(RepositoryData repositoryData)	Complete this listener with a successful (or at least, non-exceptional) response.
IndexVersion	repositoryMetaVersion()
long	repositoryStateId()
SnapshotInfo	snapshotInfo()
ClusterState	updatedClusterState(ClusterState state)	Returns a new ClusterState, based on the given state with the create-snapshot entry removed.
FinalizeSnapshotContext.UpdatedShardGenerations	updatedShardGenerations()

Methods inherited from class org.elasticsearch.action.DelegatingActionListener

onFailure, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.ActionListener

delegateFailure, delegateFailureAndWrap, delegateFailureIgnoreResponseAndWrap, delegateResponse, map, safeMap

Constructor Details

FinalizeSnapshotContext

public FinalizeSnapshotContext(FinalizeSnapshotContext.UpdatedShardGenerations updatedShardGenerations,
 long repositoryStateId,
 Metadata clusterMetadata,
 SnapshotInfo snapshotInfo,
 IndexVersion repositoryMetaVersion,
 ActionListener<RepositoryData> listener,
 Runnable onDone)

Parameters:

updatedShardGenerations - updated shard generations for both live and deleted indices

repositoryStateId - the unique id identifying the state of the repository when the snapshot began

clusterMetadata - cluster metadata

snapshotInfo - SnapshotInfo instance to write for this snapshot

repositoryMetaVersion - version of the updated repository metadata to write

listener - listener to be invoked with the new RepositoryData after the snapshot has been successfully added to the repository

onDone - consumer of the new SnapshotInfo for the snapshot that is invoked after the listener once all cleanup operations after snapshot completion have executed

Method Details

repositoryStateId

public long repositoryStateId()

updatedShardGenerations

public FinalizeSnapshotContext.UpdatedShardGenerations updatedShardGenerations()

snapshotInfo

public SnapshotInfo snapshotInfo()

repositoryMetaVersion

public IndexVersion repositoryMetaVersion()

clusterMetadata

public Metadata clusterMetadata()

obsoleteShardGenerations

public Map<RepositoryShardId,Set<ShardGeneration>> obsoleteShardGenerations()

updatedClusterState

public ClusterState updatedClusterState(ClusterState state)

Returns a new ClusterState, based on the given state with the create-snapshot entry removed.

onDone

public void onDone()

onResponse

public void onResponse(RepositoryData repositoryData)

Description copied from interface: ActionListener

Complete this listener with a successful (or at least, non-exceptional) response.