public interface SnapshotTaskClient
Modifier and Type | Method and Description |
---|---|
CleanupSnapshotTaskResult |
cleanupSnapshot(String spaceId)
Cleans up content that is no longer needed now that the snapshot
has been transferred successfully.
|
CompleteSnapshotTaskResult |
completeSnapshot(String spaceId)
Completes the snapshot.
|
CreateSnapshotTaskResult |
createSnapshot(String spaceId,
String description,
String userEmail)
Begins the process of creating a snapshot by collecting the necessary
information and passing it down to the snapshot bridge application.
|
GetRestoreTaskResult |
getRestore(String restoreId)
Gets the status and details of a snapshot restore action based on the
ID of the restore.
|
GetRestoreTaskResult |
getRestoreBySnapshot(String snapshotId)
Gets the status and details of a snapshot restore action based on the
ID of the original snapshot.
|
GetSnapshotTaskResult |
getSnapshot(String snapshotId)
Gets the status and details of a snapshot action.
|
GetSnapshotContentsTaskResult |
getSnapshotContents(String snapshotId,
int pageNumber,
int pageSize,
String prefix)
Gets the list of content items that are contained in the snapshot.
|
GetSnapshotListTaskResult |
getSnapshots()
Gets a listing of snapshots which are accessible to this account
|
RestoreSnapshotTaskResult |
restoreSnapshot(String snapshotId,
String userEmail)
Begins the process of restoring a snapshot by creating a landing space and
informing the snapshot bridge application that a restore action needs to be
performed.
|
CreateSnapshotTaskResult createSnapshot(String spaceId, String description, String userEmail) throws ContentStoreException
spaceId
- the ID of the space where the content to snapshot residesdescription
- of the snapshotuserEmail
- address to inform when the snapshot is completeContentStoreException
- on errorGetSnapshotTaskResult getSnapshot(String snapshotId) throws ContentStoreException
snapshotId
- the ID of the snapshot to retrieveContentStoreException
- on errorCleanupSnapshotTaskResult cleanupSnapshot(String spaceId) throws ContentStoreException
spaceId
- ContentStoreException
CompleteSnapshotTaskResult completeSnapshot(String spaceId) throws ContentStoreException
spaceId
- the ID of the space that hosted the snapshot contentContentStoreException
- on errorGetSnapshotListTaskResult getSnapshots() throws ContentStoreException
ContentStoreException
- on errorGetSnapshotContentsTaskResult getSnapshotContents(String snapshotId, int pageNumber, int pageSize, String prefix) throws ContentStoreException
snapshotId
- the ID of the snapshot to retrievepageNumber
- the page number of result set pagespageSize
- the maximum number of content items to include in the result setprefix
- an optional prefix used to find content itemsContentStoreException
- on errorRestoreSnapshotTaskResult restoreSnapshot(String snapshotId, String userEmail) throws ContentStoreException
snapshotId
- the ID of the snapshot to restoreuserEmail
- address to inform when restoration is completeContentStoreException
- on errorGetRestoreTaskResult getRestore(String restoreId) throws ContentStoreException
restoreId
- ContentStoreException
- on errorGetRestoreTaskResult getRestoreBySnapshot(String snapshotId) throws ContentStoreException
snapshotId
- ContentStoreException
- on errorCopyright © 2009–2014 DuraSpace. All rights reserved.