Package com.morpheusdata.core.providers

Interface GuidanceRecommendationProvider

All Superinterfaces:

PluginProvider, UIExtensionProvider

All Known Implementing Classes:

AbstractGuidanceRecommendationProvider

public interface GuidanceRecommendationProvider
extends PluginProvider, UIExtensionProvider

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	GuidanceRecommendationProvider.ExecutableFacet	Allows the workload to be executed

Method Summary

Modifier and Type	Method	Description
void	calculateRecommendations()	This is the main entry point for creating discoveries / recommendations for the end user.
String	getCategory()	Specifies the guidance category for the recommendation.
String	getDescription()	Provide a more user-friendly description of the guidance recommendation
Icon	getIcon()	Returns the Discovery Icon related to this particularly associated AccountDiscoveryType
String	getTitle()	Provide a more user-friendly title of the guidance recommendation NOTE: Localized versions of the title can be created by creating an i18n key with the format: gomorpheus.discovery.type.${type.code}.title
HTMLResponse	renderTemplate(AccountDiscovery discovery)	Discovery details provided to your rendering engine

Methods inherited from interface com.morpheusdata.core.providers.PluginProvider

getCode, getMorpheus, getName, getPlugin, isPlugin

Methods inherited from interface com.morpheusdata.core.providers.UIExtensionProvider

getContentSecurityPolicy, getRenderer

Method Details

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

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 a template

getIcon

Icon getIcon()

Returns the Discovery Icon related to this particularly associated AccountDiscoveryType

Returns:

Icon representation of assets stored in the src/assets of the project.

Since:

0.13.2

getTitle

String getTitle()

Provide a more user-friendly title of the guidance recommendation NOTE: Localized versions of the title can be created by creating an i18n key with the format: gomorpheus.discovery.type.${type.code}.title

Returns:

the desired title of the discovery type

getCategory

String getCategory()

Specifies the guidance category for the recommendation. i.e. (security, cost savings, utilization, maintenance, etc) NOTE: This Can be localized by creating an i18n key with the format: (TODO)

Returns:

the category string

getDescription

String getDescription()

Provide a more user-friendly description of the guidance recommendation

Returns:

the desired description of the discovery type