Package com.morpheusdata.core.synchronous.backup

Interface MorpheusSynchronousBackupProviderService

All Superinterfaces:

MorpheusSynchronousDataService<BackupProvider,BackupProvider>

public interface MorpheusSynchronousBackupProviderService
extends MorpheusSynchronousDataService<BackupProvider,BackupProvider>

Synchronous context methods for interacting with BackupProvider in Morpheus. A backup provider is the primary integration point between morpheus and an external service.

Since:

1.3.1

Method Summary

Modifier and Type	Method	Description
MorpheusSynchronousBackupProviderTypeService	getType()	Returns the MorpheusBackupProviderTypeContext used for performing updates/queries on BackupProviderType related assets within Morpheus.
Boolean	updateStatus(BackupProvider backupProvider, String status, String message)	Save a status update to a backup provider.

Methods inherited from interface com.morpheusdata.core.MorpheusSynchronousDataService

bulkCreate, bulkRemove, bulkSave, count, create, create, find, get, getDataService, list, listById, listOptions, remove, remove, save, save, search

Method Details

getType

MorpheusSynchronousBackupProviderTypeService 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

updateStatus

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