Package com.morpheusdata.core
Interface GuidanceRecommendationProvider
-
- All Superinterfaces:
PluginProvider
public interface GuidanceRecommendationProvider extends PluginProvider
This provider allows the creation of custom recommendations that can be shown to the user via the "Guidance" section of Morpheus. These recommendations can represent cost savings as well as be executed upon.- Since:
- 0.13.2
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
calculateRecommendations()
This is the main entry point for creating discoveries / recommendations for the end user.void
execute(AccountDiscovery discovery)
Performs an action based on the data in the discovery object.java.lang.String
getDescription()
Provide a more user friendly description of the guidance recommendationIcon
getIcon()
Returns the Discovery Icon related to this particularly associatedAccountDiscoveryType
java.lang.String
getTitle()
Provide a more user friendly title of the guidance recommendationHTMLResponse
renderTemplate(AccountDiscovery discovery)
Discovery details provided to your rendering engine-
Methods inherited from interface com.morpheusdata.core.PluginProvider
getCode, getMorpheus, getName, getPlugin, isPlugin
-
-
-
-
Method Detail
-
calculateRecommendations
void calculateRecommendations()
This is the main entry point for creating discoveries / recommendations for the end user. This method will perform any logic necessary and generate new discovery records
-
execute
void execute(AccountDiscovery discovery)
Performs an action based on the data in the discovery object.- Parameters:
discovery
- details of the recommendation used for performing an action
-
renderTemplate
HTMLResponse renderTemplate(AccountDiscovery discovery)
Discovery details provided to your rendering engine- Parameters:
discovery
- details of the recommendation used for rendering a detailed recommendation description- Returns:
- result of rendering an template
-
getIcon
Icon getIcon()
Returns the Discovery Icon related to this particularly associatedAccountDiscoveryType
- Returns:
- Icon representation of assets stored in the src/assets of the project.
- Since:
- 0.13.2
-
getTitle
java.lang.String getTitle()
Provide a more user friendly title of the guidance recommendation- Returns:
- the desired title of the discovery type
-
getDescription
java.lang.String getDescription()
Provide a more user friendly description of the guidance recommendation- Returns:
- the desired description of the discovery type
-
-