model

Documentation

Overview

Package model contains message struct for MDS/SSM messages.

Index

• type CancelCommandState
• type CancelPayload
• type CommandState
• type DocumentInfo
• type PluginState
• type SendCommandPayload
• type SendReplyPayload

Types

type CancelCommandState

type CancelCommandState struct {
	Destination     string
	MessageID       string
	RunID           string
	CreatedDate     string
	Status          contracts.ResultStatus
	CancelMessageID string
	CancelCommandID string
	Payload         string
	DebugInfo       string
}

CancelCommandState represents information relevant to a cancel-command that agent receives TODO This might be revisited when Agent-cli is written to list previously executed commands

type CancelPayload

type CancelPayload struct {
	CancelMessageID string `json:"CancelMessageId"`
}

CancelPayload represents the json structure of a cancel command MDS message payload.

type CommandState

type CommandState struct {
	DocumentInformation DocumentInfo
	PluginsInformation  map[string]PluginState
}

CommandState represents information relevant to a command that gets executed by agent

type DocumentInfo

type DocumentInfo struct {
	AdditionalInfo      contracts.AdditionalInfo
	CommandID           string
	Destination         string
	MessageID           string
	RunID               string
	CreatedDate         string
	DocumentName        string
	IsCommand           bool
	DocumentStatus      contracts.ResultStatus
	DocumentTraceOutput string
	RuntimeStatus       map[string]*contracts.PluginRuntimeStatus
	RunCount            int
}

DocumentInfo represents information stored as interim state for a document

type PluginState

type PluginState struct {
	Configuration contracts.Configuration
	Result        contracts.PluginResult
	HasExecuted   bool
}

PluginState represents information stored as interim state for any plugin This has both the configuration with which a plugin gets executed and a corresponding plugin result.

type SendCommandPayload

type SendCommandPayload struct {
	Parameters         map[string]interface{}    `json:"Parameters"`
	DocumentContent    contracts.DocumentContent `json:"DocumentContent"`
	CommandID          string                    `json:"CommandId"`
	DocumentName       string                    `json:"DocumentName"`
	OutputS3KeyPrefix  string                    `json:"OutputS3KeyPrefix"`
	OutputS3BucketName string                    `json:"OutputS3BucketName"`
}

SendCommandPayload parallels the structure of a send command MDS message payload.

type SendReplyPayload

type SendReplyPayload struct {
	AdditionalInfo      contracts.AdditionalInfo                  `json:"additionalInfo"`
	DocumentStatus      contracts.ResultStatus                    `json:"documentStatus"`
	DocumentTraceOutput string                                    `json:"documentTraceOutput"`
	RuntimeStatus       map[string]*contracts.PluginRuntimeStatus `json:"runtimeStatus"`
}

SendReplyPayload represents the json structure of a reply sent to MDS.