Class RestoreOnlyRepository

java.lang.Object
org.opensearch.common.lifecycle.AbstractLifecycleComponent
org.opensearch.index.shard.RestoreOnlyRepository
All Implemented Interfaces:
Closeable, AutoCloseable, org.opensearch.common.lease.Releasable, org.opensearch.common.lifecycle.LifecycleComponent, org.opensearch.repositories.Repository
public abstract class RestoreOnlyRepository extends org.opensearch.common.lifecycle.AbstractLifecycleComponent implements org.opensearch.repositories.Repository
A dummy repository for testing which just needs restore overridden

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.opensearch.repositories.Repository

    org.opensearch.repositories.Repository.Factory

  • Field Summary

    Fields inherited from class org.opensearch.common.lifecycle.AbstractLifecycleComponent

    lifecycle

  • Constructor Summary

    Constructors
    Constructor
    Description
    RestoreOnlyRepository(String indexName)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cloneRemoteStoreIndexShardSnapshot(org.opensearch.snapshots.SnapshotId source, org.opensearch.snapshots.SnapshotId target, org.opensearch.repositories.RepositoryShardId shardId, String shardGeneration, org.opensearch.index.store.lockmanager.RemoteStoreLockManagerFactory remoteStoreLockManagerFactory, org.opensearch.core.action.ActionListener<String> listener)
     
    void
    cloneShardSnapshot(org.opensearch.snapshots.SnapshotId source, org.opensearch.snapshots.SnapshotId target, org.opensearch.repositories.RepositoryShardId repositoryShardId, String shardGeneration, org.opensearch.core.action.ActionListener<String> listener)
     
    void
    deleteSnapshots(Collection<org.opensearch.snapshots.SnapshotId> snapshotIds, long repositoryStateId, org.opensearch.Version repositoryMetaVersion, org.opensearch.core.action.ActionListener<org.opensearch.repositories.RepositoryData> listener)
     
    protected void
    doClose()
     
    protected void
    doStart()
     
    protected void
    doStop()
     
    void
    endVerification(String verificationToken)
     
    void
    executeConsistentStateUpdate(Function<org.opensearch.repositories.RepositoryData, org.opensearch.cluster.ClusterStateUpdateTask> createUpdateTask, String source, Consumer<Exception> onFailure)
     
    void
    finalizeSnapshot(org.opensearch.repositories.ShardGenerations shardGenerations, long repositoryStateId, org.opensearch.cluster.metadata.Metadata clusterMetadata, org.opensearch.snapshots.SnapshotInfo snapshotInfo, org.opensearch.Version repositoryMetaVersion, Function<org.opensearch.cluster.ClusterState, org.opensearch.cluster.ClusterState> stateTransformer, org.opensearch.common.Priority repositoryUpdatePriority, org.opensearch.core.action.ActionListener<org.opensearch.repositories.RepositoryData> listener)
     
    void
    finalizeSnapshot(org.opensearch.repositories.ShardGenerations shardGenerations, long repositoryStateId, org.opensearch.cluster.metadata.Metadata clusterMetadata, org.opensearch.snapshots.SnapshotInfo snapshotInfo, org.opensearch.Version repositoryMetaVersion, Function<org.opensearch.cluster.ClusterState, org.opensearch.cluster.ClusterState> stateTransformer, org.opensearch.core.action.ActionListener<org.opensearch.repositories.RepositoryData> listener)
     
    long
    getLowPriorityRemoteDownloadThrottleTimeInNanos()
     
    org.opensearch.cluster.metadata.RepositoryMetadata
    getMetadata()
     
    long
    getRemoteDownloadThrottleTimeInNanos()
     
    long
    getRemoteUploadThrottleTimeInNanos()
     
    void
    getRepositoryData(org.opensearch.core.action.ActionListener<org.opensearch.repositories.RepositoryData> listener)
     
    long
    getRestoreThrottleTimeInNanos()
     
    org.opensearch.index.snapshots.IndexShardSnapshotStatus
    getShardSnapshotStatus(org.opensearch.snapshots.SnapshotId snapshotId, org.opensearch.repositories.IndexId indexId, org.opensearch.core.index.shard.ShardId shardId)
     
    org.opensearch.cluster.metadata.Metadata
    getSnapshotGlobalMetadata(org.opensearch.snapshots.SnapshotId snapshotId)
     
    org.opensearch.cluster.metadata.IndexMetadata
    getSnapshotIndexMetaData(org.opensearch.repositories.RepositoryData repositoryData, org.opensearch.snapshots.SnapshotId snapshotId, org.opensearch.repositories.IndexId index)
     
    org.opensearch.snapshots.SnapshotInfo
    getSnapshotInfo(org.opensearch.snapshots.SnapshotId snapshotId)
     
    long
    getSnapshotThrottleTimeInNanos()
     
    boolean
    isReadOnly()
     
    boolean
    isSystemRepository()
     
    void
    snapshotShard(org.opensearch.index.store.Store store, org.opensearch.index.mapper.MapperService mapperService, org.opensearch.snapshots.SnapshotId snapshotId, org.opensearch.repositories.IndexId indexId, org.apache.lucene.index.IndexCommit snapshotIndexCommit, String shardStateIdentifier, org.opensearch.index.snapshots.IndexShardSnapshotStatus snapshotStatus, org.opensearch.Version repositoryMetaVersion, Map<String,Object> userMetadata, org.opensearch.core.action.ActionListener<String> listener)
     
    String
    startVerification()
     
    void
    updateState(org.opensearch.cluster.ClusterState state)
     
    void
    verify(String verificationToken, org.opensearch.cluster.node.DiscoveryNode localNode)
     

    Methods inherited from class org.opensearch.common.lifecycle.AbstractLifecycleComponent

    addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.opensearch.common.lifecycle.LifecycleComponent

    addLifecycleListener, lifecycleState, removeLifecycleListener, start, stop

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

    close

    Methods inherited from interface org.opensearch.repositories.Repository

    adaptUserMetadata, deleteSnapshotsAndReleaseLockFiles, deleteSnapshotsInternal, deleteSnapshotsWithPinnedTimestamp, getLowPriorityRemoteUploadThrottleTimeInNanos, getRemoteStoreShallowCopyShardMetadata, getRestrictedSystemRepositorySettings, getShardSnapshotStatus, isReloadable, isReloadableSettings, reload, restoreShard, snapshotRemoteStoreIndexShard, snapshotRemoteStoreIndexShard, stats, validateMetadata

  • Constructor Details

    • RestoreOnlyRepository

      public RestoreOnlyRepository(String indexName)

  • Method Details

    • doStart

      protected void doStart()
      Specified by:
      doStart in class org.opensearch.common.lifecycle.AbstractLifecycleComponent

    • doStop

      protected void doStop()
      Specified by:
      doStop in class org.opensearch.common.lifecycle.AbstractLifecycleComponent

    • doClose

      protected void doClose()
      Specified by:
      doClose in class org.opensearch.common.lifecycle.AbstractLifecycleComponent

    • getMetadata

      public org.opensearch.cluster.metadata.RepositoryMetadata getMetadata()
      Specified by:
      getMetadata in interface org.opensearch.repositories.Repository

    • getSnapshotInfo

      public org.opensearch.snapshots.SnapshotInfo getSnapshotInfo(org.opensearch.snapshots.SnapshotId snapshotId)
      Specified by:
      getSnapshotInfo in interface org.opensearch.repositories.Repository

    • getSnapshotGlobalMetadata

      public org.opensearch.cluster.metadata.Metadata getSnapshotGlobalMetadata(org.opensearch.snapshots.SnapshotId snapshotId)
      Specified by:
      getSnapshotGlobalMetadata in interface org.opensearch.repositories.Repository

    • getSnapshotIndexMetaData

      public org.opensearch.cluster.metadata.IndexMetadata getSnapshotIndexMetaData(org.opensearch.repositories.RepositoryData repositoryData, org.opensearch.snapshots.SnapshotId snapshotId, org.opensearch.repositories.IndexId index)
      Specified by:
      getSnapshotIndexMetaData in interface org.opensearch.repositories.Repository

    • getRepositoryData

      public void getRepositoryData(org.opensearch.core.action.ActionListener<org.opensearch.repositories.RepositoryData> listener)
      Specified by:
      getRepositoryData in interface org.opensearch.repositories.Repository

    • finalizeSnapshot

      public void finalizeSnapshot(org.opensearch.repositories.ShardGenerations shardGenerations, long repositoryStateId, org.opensearch.cluster.metadata.Metadata clusterMetadata, org.opensearch.snapshots.SnapshotInfo snapshotInfo, org.opensearch.Version repositoryMetaVersion, Function<org.opensearch.cluster.ClusterState, org.opensearch.cluster.ClusterState> stateTransformer, org.opensearch.core.action.ActionListener<org.opensearch.repositories.RepositoryData> listener)
      Specified by:
      finalizeSnapshot in interface org.opensearch.repositories.Repository

    • finalizeSnapshot

      public void finalizeSnapshot(org.opensearch.repositories.ShardGenerations shardGenerations, long repositoryStateId, org.opensearch.cluster.metadata.Metadata clusterMetadata, org.opensearch.snapshots.SnapshotInfo snapshotInfo, org.opensearch.Version repositoryMetaVersion, Function<org.opensearch.cluster.ClusterState, org.opensearch.cluster.ClusterState> stateTransformer, org.opensearch.common.Priority repositoryUpdatePriority, org.opensearch.core.action.ActionListener<org.opensearch.repositories.RepositoryData> listener)
      Specified by:
      finalizeSnapshot in interface org.opensearch.repositories.Repository

    • deleteSnapshots

      public void deleteSnapshots(Collection<org.opensearch.snapshots.SnapshotId> snapshotIds, long repositoryStateId, org.opensearch.Version repositoryMetaVersion, org.opensearch.core.action.ActionListener<org.opensearch.repositories.RepositoryData> listener)
      Specified by:
      deleteSnapshots in interface org.opensearch.repositories.Repository

    • getSnapshotThrottleTimeInNanos

      public long getSnapshotThrottleTimeInNanos()
      Specified by:
      getSnapshotThrottleTimeInNanos in interface org.opensearch.repositories.Repository

    • getRestoreThrottleTimeInNanos

      public long getRestoreThrottleTimeInNanos()
      Specified by:
      getRestoreThrottleTimeInNanos in interface org.opensearch.repositories.Repository

    • getRemoteUploadThrottleTimeInNanos

      public long getRemoteUploadThrottleTimeInNanos()
      Specified by:
      getRemoteUploadThrottleTimeInNanos in interface org.opensearch.repositories.Repository

    • getRemoteDownloadThrottleTimeInNanos

      public long getRemoteDownloadThrottleTimeInNanos()
      Specified by:
      getRemoteDownloadThrottleTimeInNanos in interface org.opensearch.repositories.Repository

    • getLowPriorityRemoteDownloadThrottleTimeInNanos

      public long getLowPriorityRemoteDownloadThrottleTimeInNanos()
      Specified by:
      getLowPriorityRemoteDownloadThrottleTimeInNanos in interface org.opensearch.repositories.Repository

    • startVerification

      public String startVerification()
      Specified by:
      startVerification in interface org.opensearch.repositories.Repository

    • endVerification

      public void endVerification(String verificationToken)
      Specified by:
      endVerification in interface org.opensearch.repositories.Repository

    • isReadOnly

      public boolean isReadOnly()
      Specified by:
      isReadOnly in interface org.opensearch.repositories.Repository

    • isSystemRepository

      public boolean isSystemRepository()
      Specified by:
      isSystemRepository in interface org.opensearch.repositories.Repository

    • snapshotShard

      public void snapshotShard(org.opensearch.index.store.Store store, org.opensearch.index.mapper.MapperService mapperService, org.opensearch.snapshots.SnapshotId snapshotId, org.opensearch.repositories.IndexId indexId, org.apache.lucene.index.IndexCommit snapshotIndexCommit, String shardStateIdentifier, org.opensearch.index.snapshots.IndexShardSnapshotStatus snapshotStatus, org.opensearch.Version repositoryMetaVersion, Map<String,Object> userMetadata, org.opensearch.core.action.ActionListener<String> listener)
      Specified by:
      snapshotShard in interface org.opensearch.repositories.Repository

    • getShardSnapshotStatus

      public org.opensearch.index.snapshots.IndexShardSnapshotStatus getShardSnapshotStatus(org.opensearch.snapshots.SnapshotId snapshotId, org.opensearch.repositories.IndexId indexId, org.opensearch.core.index.shard.ShardId shardId)
      Specified by:
      getShardSnapshotStatus in interface org.opensearch.repositories.Repository

    • verify

      public void verify(String verificationToken, org.opensearch.cluster.node.DiscoveryNode localNode)
      Specified by:
      verify in interface org.opensearch.repositories.Repository

    • updateState

      public void updateState(org.opensearch.cluster.ClusterState state)
      Specified by:
      updateState in interface org.opensearch.repositories.Repository

    • executeConsistentStateUpdate

      public void executeConsistentStateUpdate(Function<org.opensearch.repositories.RepositoryData, org.opensearch.cluster.ClusterStateUpdateTask> createUpdateTask, String source, Consumer<Exception> onFailure)
      Specified by:
      executeConsistentStateUpdate in interface org.opensearch.repositories.Repository

    • cloneShardSnapshot

      public void cloneShardSnapshot(org.opensearch.snapshots.SnapshotId source, org.opensearch.snapshots.SnapshotId target, org.opensearch.repositories.RepositoryShardId repositoryShardId, String shardGeneration, org.opensearch.core.action.ActionListener<String> listener)
      Specified by:
      cloneShardSnapshot in interface org.opensearch.repositories.Repository

    • cloneRemoteStoreIndexShardSnapshot

      public void cloneRemoteStoreIndexShardSnapshot(org.opensearch.snapshots.SnapshotId source, org.opensearch.snapshots.SnapshotId target, org.opensearch.repositories.RepositoryShardId shardId, String shardGeneration, org.opensearch.index.store.lockmanager.RemoteStoreLockManagerFactory remoteStoreLockManagerFactory, org.opensearch.core.action.ActionListener<String> listener)
      Specified by:
      cloneRemoteStoreIndexShardSnapshot in interface org.opensearch.repositories.Repository