Repository

All Superinterfaces:

AutoCloseable, LifecycleComponent<Repository>, Releasable

All Known Implementing Classes:

BlobStoreRepository, FsRepository, URLRepository
```
public interface Repository
extends LifecycleComponent<Repository>
```
Snapshot repository interface.
Responsible for index and cluster level operations. It's called only on master. Shard-level operations are performed using IndexShardRepository interface on data nodes.
Typical snapshot usage pattern:
- Master calls #initializeSnapshot(org.elasticsearch.cluster.metadata.SnapshotId, com.google.common.collect.ImmutableList, org.elasticsearch.cluster.metadata.MetaData) with list of indices that will be included into the snapshot
- Data nodes call IndexShardRepository.snapshot(org.elasticsearch.cluster.metadata.SnapshotId, org.elasticsearch.index.shard.ShardId, org.elasticsearch.index.deletionpolicy.SnapshotIndexCommit, org.elasticsearch.index.snapshots.IndexShardSnapshotStatus) for each shard
- When all shard calls return master calls #finalizeSnapshot(org.elasticsearch.cluster.metadata.SnapshotId, String, int, com.google.common.collect.ImmutableList) with possible list of failures

Method Summary

All Methods

Instance Methods

Abstract Methods
Modifier and Type	Method and Description
`void`	`deleteSnapshot(SnapshotId snapshotId)` Deletes snapshot
`void`	`endVerification(String verificationToken)` Called at the end of repository verification process.
`Snapshot`	`finalizeSnapshot(SnapshotId snapshotId, String failure, int totalShards, <any> shardFailures)` Finalizes snapshotting process This method is called on master after all shards are snapshotted.
`void`	`initializeSnapshot(SnapshotId snapshotId, <any> indices, MetaData metaData)` Starts snapshotting process
`Snapshot`	`readSnapshot(SnapshotId snapshotId)` Reads snapshot description from repository.
`MetaData`	`readSnapshotMetaData(SnapshotId snapshotId, <any> indices)` Returns global metadata associate with the snapshot.
`long`	`restoreThrottleTimeInNanos()` Returns restore throttle time in nanoseconds
`<any>`	`snapshots()` Returns the list of snapshots currently stored in the repository
`long`	`snapshotThrottleTimeInNanos()` Returns snapshot throttle time in nanoseconds
`String`	`startVerification()` Verifies repository on the master node and returns the verification token.

Methods inherited from interface org.elasticsearch.common.component.LifecycleComponent
addLifecycleListener, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from interface org.elasticsearch.common.lease.Releasable
close

- Method Detail
  - readSnapshot
```
Snapshot readSnapshot(SnapshotId snapshotId)
```
    Reads snapshot description from repository.
    
    Parameters:
    
    snapshotId - snapshot ID
    
    Returns:
    
    information about snapshot
  - readSnapshotMetaData
```
MetaData readSnapshotMetaData(SnapshotId snapshotId,
                              <any> indices)
```
    Returns global metadata associate with the snapshot.
    The returned meta data contains global metadata as well as metadata for all indices listed in the indices parameter.
    
    Parameters:
    
    snapshotId - snapshot ID
    
    indices - list of indices
    
    Returns:
    
    information about snapshot
  - snapshots
```
<any> snapshots()
```
    Returns the list of snapshots currently stored in the repository
    
    Returns:
    
    snapshot list
  - initializeSnapshot
```
void initializeSnapshot(SnapshotId snapshotId,
                        <any> indices,
                        MetaData metaData)
```
    Starts snapshotting process
    
    Parameters:
    
    snapshotId - snapshot id
    
    indices - list of indices to be snapshotted
    
    metaData - cluster metadata
  - finalizeSnapshot
```
Snapshot finalizeSnapshot(SnapshotId snapshotId,
                          String failure,
                          int totalShards,
                          <any> shardFailures)
```
    Finalizes snapshotting process
    This method is called on master after all shards are snapshotted.
    
    Parameters:
    
    snapshotId - snapshot id
    
    failure - global failure reason or null
    
    totalShards - total number of shards
    
    shardFailures - list of shard failures
    
    Returns:
    
    snapshot description
  - deleteSnapshot
```
void deleteSnapshot(SnapshotId snapshotId)
```
    Deletes snapshot
    
    Parameters:
    
    snapshotId - snapshot id
  - snapshotThrottleTimeInNanos
```
long snapshotThrottleTimeInNanos()
```
    Returns snapshot throttle time in nanoseconds
  - restoreThrottleTimeInNanos
```
long restoreThrottleTimeInNanos()
```
    Returns restore throttle time in nanoseconds
  - startVerification
```
String startVerification()
```
    Verifies repository on the master node and returns the verification token. If the verification token is not null, it's passed to all data nodes for verification. If it's null - no additional verification is required
    
    Returns:
    
    verification token that should be passed to all Index Shard Repositories for additional verification or null
  - endVerification
```
void endVerification(String verificationToken)
```
    Called at the end of repository verification process. This method should perform all necessary cleanup of the temporary files created in the repository
    
    Parameters:
    
    verificationToken - verification request generated by startVerification() command

Interface Repository

Method Summary

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

Methods inherited from interface org.elasticsearch.common.lease.Releasable

Method Detail

readSnapshot

readSnapshotMetaData

snapshots

initializeSnapshot

finalizeSnapshot

deleteSnapshot

snapshotThrottleTimeInNanos

restoreThrottleTimeInNanos

startVerification

endVerification