Package com.morpheusdata.core.backup

Interface MorpheusBackupProviderService

All Superinterfaces:

MorpheusDataQueryService<BackupProvider>, 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 Type	Method	Description
MorpheusBackupProviderTypeService	getType()	Returns the MorpheusBackupProviderTypeContext used for performing updates/queries on BackupProviderType 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 provider.

Methods inherited from interface com.morpheusdata.core.MorpheusDataQueryService

count, find, get, list, list, listById, listOptions, listOptions, search

Methods inherited from interface com.morpheusdata.core.MorpheusDataService

bulkCreate, bulkRemove, bulkSave, create, create, remove, remove, save, save

Method Details

getType

MorpheusBackupProviderTypeService getType()

Returns the MorpheusBackupProviderTypeContext used for performing updates/queries on BackupProviderType 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 all BackupProvider objects by a list of Identifiers. This is commonly used in sync / caching logic.

Parameters:

ids - list of BackupProvider 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. When the status is updated to "error" or "offline" an alarm will be created with the message provided. When the status is updated to "online" any alarms on the provider will be cleared.

Parameters:

backupProvider - backup provider to update

status - status to be set on the backup provider

message - additional context for the current status. Useful in the case of adding details for an error or warning status.

Returns:

success