Package org.elasticsearch.repositories

Class SnapshotShardContext

java.lang.Object

org.elasticsearch.action.ActionListener.Delegating<ShardSnapshotResult,ShardSnapshotResult>

org.elasticsearch.repositories.SnapshotShardContext

All Implemented Interfaces:

ActionListener<ShardSnapshotResult>

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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.action.ActionListener

ActionListener.Delegating<Response,DelegateResponse>, ActionListener.DelegatingActionListener<T>, ActionListener.DelegatingFailureActionListener<T,R>, ActionListener.MappedActionListener<Response,MappedResponse>, ActionListener.RunAfterActionListener<T>, ActionListener.RunBeforeActionListener<T>

Field Summary

Fields inherited from class org.elasticsearch.action.ActionListener.Delegating

delegate

Constructor Summary

Constructors

Constructor	Description
SnapshotShardContext(Store store, MapperService mapperService, SnapshotId snapshotId, IndexId indexId, Engine.IndexCommitRef commitRef, String shardStateIdentifier, IndexShardSnapshotStatus snapshotStatus, Version repositoryMetaVersion, Map<String,Object> userMetadata, ActionListener<ShardSnapshotResult> listener)

Method Summary

Modifier and Type	Method	Description
Version	getRepositoryMetaVersion()
org.apache.lucene.index.IndexCommit	indexCommit()
IndexId	indexId()
MapperService	mapperService()
void	onResponse(ShardSnapshotResult result)	Handle action response.
SnapshotId	snapshotId()
String	stateIdentifier()
IndexShardSnapshotStatus	status()
Store	store()
Map<String,Object>	userMetadata()

Methods inherited from class org.elasticsearch.action.ActionListener.Delegating

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, delegateResponse, map

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)

Parameters:

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.