Package com.morpheusdata.core.backup
Interface MorpheusBackupProviderService
- All Superinterfaces:
MorpheusDataService<BackupProvider,
BackupProvider>
public interface MorpheusBackupProviderService
extends MorpheusDataService<BackupProvider,BackupProvider>
Context methods for interacting with
BackupProvider
in Morpheus. A backup provider is the primary integration
point between morpheus and an external service.- Since:
- 0.13.4
-
Method Summary
Modifier and TypeMethodDescriptiongetType()
Returns the MorpheusBackupProviderTypeContext used for performing updates/queries onBackupProviderType
related assets within Morpheus.io.reactivex.rxjava3.core.Observable<BackupProvider>
listById
(Collection<Long> ids) Deprecated.io.reactivex.rxjava3.core.Single<Boolean>
updateStatus
(BackupProvider backupProvider, String status, String message) Save a status update to a backup providerMethods inherited from interface com.morpheusdata.core.MorpheusDataService
bulkCreate, bulkRemove, bulkSave, count, create, create, find, get, list, listById, listOptions, remove, remove, save, save, search
-
Method Details
-
getType
MorpheusBackupProviderTypeService getType()Returns the MorpheusBackupProviderTypeContext used for performing updates/queries onBackupProviderType
related assets within Morpheus.- Returns:
- An instance of the BackupProviderTypeContext to be used for calls by various backup providers
-
listById
@Deprecated(since="0.15.4") io.reactivex.rxjava3.core.Observable<BackupProvider> listById(Collection<Long> ids) Deprecated.Lists allBackupProvider
objects by a list of Identifiers. This is commonly used in sync / caching logic.- Parameters:
ids
- list ofBackupProvider
ids to fetch.- Returns:
- an RxJava Observable stream of
BackupProvider
objects for subscription.
-
updateStatus
io.reactivex.rxjava3.core.Single<Boolean> updateStatus(BackupProvider backupProvider, String status, String message) Save a status update to a backup provider- Parameters:
backupProvider
- backup provider to updatestatus
- status to be set on the backup providermessage
- additional context for the current status. Useful in the case of adding details for an error or warning status.- Returns:
- success
-