Documentation
¶
Index ¶
- func GetImmediateRunCommandGoalStates(ctx *log.Context, communicator hostgacommunicator.IHostGACommunicator, ...) ([]hostgacommunicator.ImmediateExtensionGoalState, string, error)
- func HandleImmediateGoalState(ctx *log.Context, setting settings.SettingsCommon, notifier *observer.Notifier) (int, error)
- func ReportFinalStatusForImmediateGoalState(ctx *log.Context, notifier *observer.Notifier, goalStateKey types.GoalStateKey, ...) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetImmediateRunCommandGoalStates ¶
func GetImmediateRunCommandGoalStates(ctx *log.Context, communicator hostgacommunicator.IHostGACommunicator, lastProcessedETag string) ([]hostgacommunicator.ImmediateExtensionGoalState, string, error)
func HandleImmediateGoalState ¶
func HandleImmediateGoalState(ctx *log.Context, setting settings.SettingsCommon, notifier *observer.Notifier) (int, error)
HandleImmediateGoalState handles the immediate goal state by executing the command and waiting for it to finish. ctx: The logger context. setting: The settings for the command. notifier: The notifier to send the status to the HGAP. This is a notifier that must have been initialized and a status observer must have been added to it. Returns the exit code and an error if there was an issue executing the goal state.
func ReportFinalStatusForImmediateGoalState ¶ added in v1.3.14
func ReportFinalStatusForImmediateGoalState(ctx *log.Context, notifier *observer.Notifier, goalStateKey types.GoalStateKey, statusType types.StatusType, instanceview *types.RunCommandInstanceView) error
ReportFinalStatusForImmediateGoalState reports the final status of the immediate goal state to the HGAP. Reporting the status to HGAP is done by notifying the observer previously added to the notifier. This function is called when the goal state is skipped or when the goal state fails to execute. It is important to get the instance view from the goal state and report it to the HGAP so that the user can see the final status of the goal state. The instance view is normally added as a message to the status item.
Types ¶
This section is empty.