types

type Cmd struct {
	Name               string       // human readable string
	ShouldReportStatus bool         // determines if running this should report the status of the run command
	FailExitCode       int          // exitCode to use when commands fail
	Functions          CmdFunctions // functions used by the command
}

type CmdFunctions struct {
	Invoke       cmdFunc          // associated function
	Pre          preFunc          // executed before any status is reported
	ReportStatus reportStatusFunc // function to report status. Useful to write in .status file for RC and report to HGAP for Immediate Run Command.
	Cleanup      cleanupFunc      // function called after the extension has reached a terminal state to perform cleanup steps
}

type ExecutionState string

type FormattedMessage struct {
	Lang    string `json:"lang"`
	Message string `json:"message"`
}

type GoalStateKey struct {
	ExtensionName        string
	SeqNumber            int
	RuntimeSettingsState string
}

type HandlerEnvironment struct {
	Version            float64 `json:"version"`
	Name               string  `json:"name"`
	HandlerEnvironment struct {
		HeartbeatFile       string `json:"heartbeatFile"`
		StatusFolder        string `json:"statusFolder"`
		ConfigFolder        string `json:"configFolder"`
		LogFolder           string `json:"logFolder"`
		EventsFolder        string `json:"eventsFolder"`
		EventsFolderPreview string `json:"eventsFolder_preview"`
		DeploymentID        string `json:"deploymentid"`
		RoleName            string `json:"rolename"`
		Instance            string `json:"instance"`
		HostResolverAddress string `json:"hostResolverAddress"`
	}
}

type RCMetadata struct {
	// Most recent sequence, which was previously traced by seqNumFile. This was
	// incorrect. The correct way is mrseq.  This file is auto-preserved by the agent.
	MostRecentSequence string

	// Filename where active process keeps track of process id and process start time
	PidFilePath string

	// DownloadDir is where we store the downloaded files in the "{downloadDir}/{seqnum}/file"
	// format and the logs as "{downloadDir}/{seqnum}/std(out|err)". Stored under dataDir
	// multiconfig support - when extName is set we use {downloadDir}/{extName}/...
	DownloadDir string

	// Download path is the full path where the files are stored.
	// E.g., /var/lib/waagent/run-command-handler/{downloadDir}/{seqnum}/file
	DownloadPath string

	// The name of the current extension. E.g., RC0001
	ExtName string

	// The sequence number. E.g., 1
	SeqNum int
}

type RunCommandInstanceView struct {
	ExecutionState   ExecutionState `json:"executionState"`
	ExecutionMessage string         `json:"executionMessage"`
	Output           string         `json:"output"`
	Error            string         `json:"error"`
	ExitCode         int            `json:"exitCode"`
	StartTime        string         `json:"startTime"`
	EndTime          string         `json:"endTime"`
}

type Status struct {
	Name             string           `json:"name"`
	Operation        string           `json:"operation"`
	Status           StatusType       `json:"status"`
	FormattedMessage FormattedMessage `json:"formattedMessage"`
}

type StatusEventArgs struct {
	TopLevelStatus StatusItem
	StatusKey      GoalStateKey
}

type StatusItem struct {
	Version      int    `json:"version"`
	TimestampUTC string `json:"timestampUTC"`
	Status       Status `json:"status"`
}

type StatusReport []StatusItem

type StatusType string