Package com.morpheusdata.core.backup
Interface MorpheusBackupService
- All Superinterfaces:
MorpheusDataService<Backup,
,BackupIdentityProjection> MorpheusIdentityService<BackupIdentityProjection>
public interface MorpheusBackupService
extends MorpheusDataService<Backup,BackupIdentityProjection>, MorpheusIdentityService<BackupIdentityProjection>
Context methods for interacting with
Backups
in Morpheus- Since:
- 0.13.4
-
Method Summary
Modifier and TypeMethodDescriptionio.reactivex.rxjava3.core.Single<Boolean>
executeBackup
(Long backupId) Initiates the execution of a backupBackup
.Returns the BackupJobContext used for performing updates or queries onBackupJob
related assets within Morpheus.Returns the BackupRestoreContext used for performing updates or queries onBackupRestore
related assets within Morpheus.Returns the BackupResultContext used for performing updates or queries onBackupResult
related assets within Morpheus.Returns the MorpheusReplicationContext used for performing updates/queries onReplication
related assets within Morpheus.getType()
Returns the MorpheusBackupTypeContext used for performing updates/queries onBackupType
related assets within Morpheus.io.reactivex.rxjava3.core.Observable<Backup>
listByAccountIdAndBackupJobIdAndActive
(Long accountId, Long backupJobId, Boolean active) Deprecated, for removal: This API element is subject to removal in a future version.io.reactivex.rxjava3.core.Observable<Backup>
listByBackupJobIdAndActive
(Long backupJobId, Boolean active) Deprecated, for removal: This API element is subject to removal in a future version.io.reactivex.rxjava3.core.Observable<Backup>
listById
(Collection<Long> ids) Deprecated, for removal: This API element is subject to removal in a future version.io.reactivex.rxjava3.core.Observable<BackupIdentityProjection>
listIdentityProjections
(BackupProvider backupProvider) Deprecated, for removal: This API element is subject to removal in a future version.io.reactivex.rxjava3.core.Observable<BackupIdentityProjection>
listIdentityProjections
(Cloud cloud) Deprecated, for removal: This API element is subject to removal in a future version.Methods inherited from interface com.morpheusdata.core.MorpheusDataService
bulkCreate, bulkRemove, bulkSave, count, create, create, find, get, list, listById, listOptions, remove, remove, save, save, search
Methods inherited from interface com.morpheusdata.core.MorpheusIdentityService
getIdentityProperties, listIdentityProjections
-
Method Details
-
getType
MorpheusBackupTypeService getType()Returns the MorpheusBackupTypeContext used for performing updates/queries onBackupType
related assets within Morpheus.- Returns:
- An instance of the BackupTypeContext to be used for calls by various backup providers
-
getBackupJob
MorpheusBackupJobService getBackupJob()Returns the BackupJobContext used for performing updates or queries onBackupJob
related assets within Morpheus. Typically this would be called by aBackupProvider
- Returns:
- An instance of the Backup Job Context to be used for calls by various backup providers
-
getBackupResult
MorpheusBackupResultService getBackupResult()Returns the BackupResultContext used for performing updates or queries onBackupResult
related assets within Morpheus. Typically this would be called by aBackupProvider
.- Returns:
- An instance of the Backup Result Context to be used for calls by various backup providers
-
getBackupRestore
MorpheusBackupRestoreService getBackupRestore()Returns the BackupRestoreContext used for performing updates or queries onBackupRestore
related assets within Morpheus. Typically this would be called by aBackupProvider
.- Returns:
- An instance of the Backup Restore Context to be used for calls by various backup providers
-
getReplication
MorpheusReplicationService getReplication()Returns the MorpheusReplicationContext used for performing updates/queries onReplication
related assets within Morpheus.- Returns:
- An instance of the MorpheusReplicationContext to be used for calls by various backup providers
-
listIdentityProjections
@Deprecated(since="0.15.3", forRemoval=true) io.reactivex.rxjava3.core.Observable<BackupIdentityProjection> listIdentityProjections(BackupProvider backupProvider) Deprecated, for removal: This API element is subject to removal in a future version.Lists all backup projection objects for a specified backup provider id. The projection is a subset of the properties on a fullBackup
object for sync matching.- Parameters:
backupProvider
- theAbstractBackupProvider
identifier associated to the backups to be listed.- Returns:
- an RxJava Observable stream of result projection objects.
-
listIdentityProjections
@Deprecated(since="0.15.3", forRemoval=true) io.reactivex.rxjava3.core.Observable<BackupIdentityProjection> listIdentityProjections(Cloud cloud) Deprecated, for removal: This API element is subject to removal in a future version.Lists all backup projection objects for a specified cloud. The projection is a subset of the properties on a fullBackup
object for sync matching.- Parameters:
cloud
- theCloud
identifier associated to the domains to be listed.- Returns:
- an RxJava Observable stream of result projection objects.
-
listById
@Deprecated(since="0.15.3", forRemoval=true) io.reactivex.rxjava3.core.Observable<Backup> listById(Collection<Long> ids) Deprecated, for removal: This API element is subject to removal in a future version.Lists allBackup
objects by a list of Identifiers. This is commonly used in sync / caching logic. -
listByBackupJobIdAndActive
@Deprecated(since="0.15.3", forRemoval=true) io.reactivex.rxjava3.core.Observable<Backup> listByBackupJobIdAndActive(Long backupJobId, Boolean active) Deprecated, for removal: This API element is subject to removal in a future version. -
listByAccountIdAndBackupJobIdAndActive
@Deprecated(since="0.15.3", forRemoval=true) io.reactivex.rxjava3.core.Observable<Backup> listByAccountIdAndBackupJobIdAndActive(Long accountId, Long backupJobId, Boolean active) Deprecated, for removal: This API element is subject to removal in a future version. -
executeBackup
Initiates the execution of a backupBackup
. Be mindful this is an RxJava implementation and must be subscribed to for any action to actually take place.- Parameters:
backupId
- the ID of theBackup
to begin execution.- Returns:
- the Single Observable containing the success or failure of the backup execution call
-