org.elasticsearch.snapshots

Class SnapshotShardsService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.common.component.AbstractLifecycleComponent<SnapshotShardsService>

org.elasticsearch.snapshots.SnapshotShardsService

All Implemented Interfaces:

AutoCloseable, ClusterStateListener, LifecycleComponent<SnapshotShardsService>, Releasable

public class SnapshotShardsService
extends AbstractLifecycleComponent<SnapshotShardsService>
implements ClusterStateListener

This service runs on data and master nodes and controls currently snapshotted shards on these nodes. It is responsible for starting and stopping shard level snapshots

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SnapshotShardsService.UpdateIndexShardSnapshotStatusRequest Internal request that is used to send changes in snapshot status to master

Field Summary

Fields

Modifier and Type	Field and Description
static String	UPDATE_SNAPSHOT_ACTION_NAME

Fields inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

lifecycle

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
SnapshotShardsService(Settings settings, ClusterService clusterService, SnapshotsService snapshotsService, ThreadPool threadPool, TransportService transportService, IndicesService indicesService)

Method Summary

Methods

Modifier and Type	Method and Description
void	clusterChanged(ClusterChangedEvent event) Called when cluster state changes.
Map<ShardId,IndexShardSnapshotStatus>	currentSnapshotShards(SnapshotId snapshotId) Returns status of shards that are snapshotted on the node and belong to the given snapshot
protected void	doClose()
protected void	doStart()
protected void	doStop()
void	updateIndexShardSnapshotStatus(SnapshotId snapshotId, ShardId shardId, SnapshotsInProgress.ShardSnapshotStatus status) Updates the shard status

Methods inherited from class org.elasticsearch.common.component.AbstractLifecycleComponent

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Field Detail

UPDATE_SNAPSHOT_ACTION_NAME

public static final String UPDATE_SNAPSHOT_ACTION_NAME

See Also:

Constant Field Values

Constructor Detail

SnapshotShardsService

@Inject
public SnapshotShardsService(Settings settings,
                            ClusterService clusterService,
                            SnapshotsService snapshotsService,
                            ThreadPool threadPool,
                            TransportService transportService,
                            IndicesService indicesService)

Method Detail

doStart

protected void doStart()

Specified by:

doStart in class AbstractLifecycleComponent<SnapshotShardsService>

doStop

protected void doStop()

Specified by:

doStop in class AbstractLifecycleComponent<SnapshotShardsService>

doClose

protected void doClose()

Specified by:

doClose in class AbstractLifecycleComponent<SnapshotShardsService>

clusterChanged

public void clusterChanged(ClusterChangedEvent event)

Description copied from interface: ClusterStateListener

Called when cluster state changes.

Specified by:

clusterChanged in interface ClusterStateListener

currentSnapshotShards

public Map<ShardId,IndexShardSnapshotStatus> currentSnapshotShards(SnapshotId snapshotId)

Returns status of shards that are snapshotted on the node and belong to the given snapshot

This method is executed on data node

Parameters:

snapshotId - snapshot id

Returns:

map of shard id to snapshot status

updateIndexShardSnapshotStatus

public void updateIndexShardSnapshotStatus(SnapshotId snapshotId,
                                  ShardId shardId,
                                  SnapshotsInProgress.ShardSnapshotStatus status)

Updates the shard status