org.elasticsearch.index.gateway
Interface IndexShardGateway

All Superinterfaces:

CloseableIndexComponent, IndexShardComponent

All Known Implementing Classes:

BlobStoreIndexShardGateway, FsIndexShardGateway, NoneIndexShardGateway

public interface IndexShardGateway
extends IndexShardComponent, CloseableIndexComponent

Nested Class Summary

static class	IndexShardGateway.RecoveryStatus
static class	IndexShardGateway.Snapshot
static class	IndexShardGateway.SnapshotStatus

Method Summary

IndexShardGateway.RecoveryStatus	recover() Recovers the state of the shard from the gateway.
boolean	requiresSnapshotScheduling() Returns true if this gateway requires scheduling management for snapshot operations.
IndexShardGateway.SnapshotStatus	snapshot(IndexShardGateway.Snapshot snapshot) Snapshots the given shard into the gateway.
java.lang.String	type()

Methods inherited from interface org.elasticsearch.index.shard.IndexShardComponent

indexSettings, shardId

Methods inherited from interface org.elasticsearch.common.component.CloseableIndexComponent

close

Method Detail

type

java.lang.String type()

recover

IndexShardGateway.RecoveryStatus recover()
                                         throws IndexShardGatewayRecoveryException

Recovers the state of the shard from the gateway.

Throws:

IndexShardGatewayRecoveryException

snapshot

IndexShardGateway.SnapshotStatus snapshot(IndexShardGateway.Snapshot snapshot)
                                          throws IndexShardGatewaySnapshotFailedException

Snapshots the given shard into the gateway.

Throws:

IndexShardGatewaySnapshotFailedException

requiresSnapshotScheduling

boolean requiresSnapshotScheduling()

Returns true if this gateway requires scheduling management for snapshot operations.