- All Implemented Interfaces:
Closeable,AutoCloseable,ClusterStateApplier,LifecycleComponent,Releasable
org.elasticsearch.snapshots for details.
See SnapshotShardsService for the data node snapshotting steps.-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final IndexVersionstatic final IndexVersionSetting that specifies the maximum number of allowed concurrent snapshot create and delete operations in the cluster state.static final Stringstatic final IndexVersionstatic final Stringstatic final IndexVersionstatic final IndexVersionFields inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent
lifecycle -
Constructor Summary
ConstructorsConstructorDescriptionSnapshotsService(Settings settings, ClusterService clusterService, RerouteService rerouteService, IndexNameExpressionResolver indexNameExpressionResolver, RepositoriesService repositoriesService, TransportService transportService, SystemIndices systemIndices, boolean serializeProjectMetadata, SnapshotMetrics snapshotMetrics) -
Method Summary
Modifier and TypeMethodDescriptionvoidCalled when a new cluster state (ClusterChangedEvent.state()needs to be applied.booleanAssert that no in-memory state for any running snapshot-create or -delete operation exists in this instance.voidcloneSnapshot(ProjectId projectId, CloneSnapshotRequest request, ActionListener<Void> listener) voidcreateAndSubmitRequestToUpdateSnapshotState(Snapshot snapshot, ShardId shardId, RepositoryShardId repoShardId, SnapshotsInProgress.ShardSnapshotStatus updatedState, ActionListener<Void> listener) voidcreateSnapshot(ProjectId projectId, CreateSnapshotRequest request, ActionListener<Snapshot> listener) Initializes the snapshotting process.voiddeleteSnapshots(ProjectId projectId, DeleteSnapshotRequest request, ActionListener<Void> listener) Deletes snapshots from the repository.protected voiddoClose()Close this component.protected voiddoStart()Start this component.protected voiddoStop()Stop this component.voidexecuteSnapshot(ProjectId projectId, CreateSnapshotRequest request, ActionListener<SnapshotInfo> listener) Same ascreateSnapshot(ProjectId, CreateSnapshotRequest, ActionListener)but invokes its callback on completion of the snapshot.Methods inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent
addLifecycleListener, close, lifecycleState, start, stop
-
Field Details
-
SHARD_GEN_IN_REPO_DATA_VERSION
-
INDEX_GEN_IN_REPO_DATA_VERSION
-
UUIDS_IN_REPO_DATA_VERSION
-
FILE_INFO_WRITER_UUIDS_IN_SHARD_DATA_VERSION
-
OLD_SNAPSHOT_FORMAT
-
POLICY_ID_METADATA_FIELD
- See Also:
-
NO_FEATURE_STATES_VALUE
- See Also:
-
MAX_CONCURRENT_SNAPSHOT_OPERATIONS_SETTING
Setting that specifies the maximum number of allowed concurrent snapshot create and delete operations in the cluster state. The number of concurrent operations in a cluster state is defined as the sum ofSnapshotsInProgress.count()and the size ofSnapshotDeletionsInProgress.getEntries().
-
-
Constructor Details
-
SnapshotsService
public SnapshotsService(Settings settings, ClusterService clusterService, RerouteService rerouteService, IndexNameExpressionResolver indexNameExpressionResolver, RepositoriesService repositoriesService, TransportService transportService, SystemIndices systemIndices, boolean serializeProjectMetadata, SnapshotMetrics snapshotMetrics)
-
-
Method Details
-
executeSnapshot
public void executeSnapshot(ProjectId projectId, CreateSnapshotRequest request, ActionListener<SnapshotInfo> listener) Same ascreateSnapshot(ProjectId, CreateSnapshotRequest, ActionListener)but invokes its callback on completion of the snapshot.- Parameters:
projectId- the project for creating the snapshotrequest- snapshot requestlistener- snapshot completion listener
-
createSnapshot
public void createSnapshot(ProjectId projectId, CreateSnapshotRequest request, ActionListener<Snapshot> listener) Initializes the snapshotting process.This method is used by clients to start snapshot. It makes sure that there is no snapshots are currently running and creates a snapshot record in cluster state metadata.
- Parameters:
projectId- the project for creating the snapshotrequest- snapshot requestlistener- snapshot creation listener
-
cloneSnapshot
public void cloneSnapshot(ProjectId projectId, CloneSnapshotRequest request, ActionListener<Void> listener) -
applyClusterState
Description copied from interface:ClusterStateApplierCalled when a new cluster state (ClusterChangedEvent.state()needs to be applied. The cluster state to be applied is already committed when this method is called, so an applier must therefore be prepared to deal with any state it receives without throwing an exception. Throwing an exception from an applier is very bad because it will stop the application of this state before it has reached all the other appliers, and will likely result in another attempt to apply the same (or very similar) cluster state which might continue until this node is removed from the cluster.Cluster states are applied one-by-one which means they can be a performance bottleneck. Implementations of this method should therefore be fast, so please consider forking work into the background rather than doing everything inline.
- Specified by:
applyClusterStatein interfaceClusterStateApplier
-
deleteSnapshots
public void deleteSnapshots(ProjectId projectId, DeleteSnapshotRequest request, ActionListener<Void> listener) Deletes snapshots from the repository. In-progress snapshots matched by the delete will be aborted before deleting them. Whenwait_for_completionis set to true, the passed action listener will only complete when all matching snapshots are deleted, when it is false it will complete as soon as the deletes are scheduled- Parameters:
projectId- project to look for the snapshotrequest- delete snapshot requestlistener- listener a listener which will be resolved according to the wait_for_completion parameter
-
doStart
protected void doStart()Description copied from class:AbstractLifecycleComponentStart this component. Typically that means doing things like launching background processes and registering listeners on other components. Other components have been initialized by this point, but may not yet be started.If this method throws an exception then the startup process will fail, but this component will not be stopped before it is closed.
This method is called while synchronized on
AbstractLifecycleComponent.lifecycle. It is only called once in the lifetime of a component, although it may not be called at all if the startup process encountered some kind of fatal error, such as the failure of some other component to initialize or start.- Specified by:
doStartin classAbstractLifecycleComponent
-
doStop
protected void doStop()Description copied from class:AbstractLifecycleComponentStop this component. Typically that means doing the reverse of whateverAbstractLifecycleComponent.doStart()does.This method is called while synchronized on
AbstractLifecycleComponent.lifecycle. It is only called once in the lifetime of a component, after callingAbstractLifecycleComponent.doStart(), although it will not be called at all if this component did not successfully start.- Specified by:
doStopin classAbstractLifecycleComponent
-
doClose
protected void doClose()Description copied from class:AbstractLifecycleComponentClose this component. Typically that means doing the reverse of whatever happened during initialization, such as releasing resources acquired there.This method is called while synchronized on
AbstractLifecycleComponent.lifecycle. It is called once in the lifetime of a component. If the component was started then it will be stopped before it is closed, and once it is closed it will not be started or stopped.- Specified by:
doClosein classAbstractLifecycleComponent
-
assertAllListenersResolved
public boolean assertAllListenersResolved()Assert that no in-memory state for any running snapshot-create or -delete operation exists in this instance. -
createAndSubmitRequestToUpdateSnapshotState
public void createAndSubmitRequestToUpdateSnapshotState(Snapshot snapshot, ShardId shardId, RepositoryShardId repoShardId, SnapshotsInProgress.ShardSnapshotStatus updatedState, ActionListener<Void> listener)
-