models

Documentation

Index

• Constants
• type CheckResult
  • func (m *CheckResult) MarshalBinary() ([]byte, error)
  • func (m *CheckResult) UnmarshalBinary(b []byte) error
  • func (m *CheckResult) Validate(formats strfmt.Registry) error
• type Error
  • func (m *Error) MarshalBinary() ([]byte, error)
  • func (m *Error) UnmarshalBinary(b []byte) error
  • func (m *Error) Validate(formats strfmt.Registry) error
• type Plugin
  • func (m *Plugin) MarshalBinary() ([]byte, error)
  • func (m *Plugin) UnmarshalBinary(b []byte) error
  • func (m *Plugin) Validate(formats strfmt.Registry) error
• type PluginAction
  • func (m *PluginAction) MarshalBinary() ([]byte, error)
  • func (m *PluginAction) UnmarshalBinary(b []byte) error
  • func (m *PluginAction) Validate(formats strfmt.Registry) error

Constants

const (

	// CheckResultCheckStatusRED captures enum value "RED"
	CheckResultCheckStatusRED string = "RED"

	// CheckResultCheckStatusYELLOW captures enum value "YELLOW"
	CheckResultCheckStatusYELLOW string = "YELLOW"

	// CheckResultCheckStatusGREEN captures enum value "GREEN"
	CheckResultCheckStatusGREEN string = "GREEN"
)

const CheckResultPrefix = "/analyze/check_results/"

const PluginPrefix = "/analyze/plugins/"

Types

type CheckResult

type CheckResult struct {

	// shows check status
	// Enum: [RED YELLOW GREEN]
	CheckStatus string `json:"checkStatus,omitempty"`

	// date/Time of check execution
	// Format: date-time
	CompletedAt strfmt.DateTime `json:"completedAt,omitempty"`

	// detailed check result description
	Description string `json:"description,omitempty"`

	// shows check execution errors
	ExecutionStatus string `json:"executionStatus,omitempty"`

	// unique UUID of Check function invocation of specific plugin
	ID string `json:"id,omitempty"`

	// check name
	Name string `json:"name,omitempty"`

	// list of possible actions to fix caveats check was found
	PossibleActions []*PluginAction `json:"possibleActions"`
}

CheckResult CheckResult represents the single result of Check function invocation of specific plugin. swagger:model checkResult

func (*CheckResult) MarshalBinary

func (m *CheckResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CheckResult) UnmarshalBinary

func (m *CheckResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CheckResult) Validate

func (m *CheckResult) Validate(formats strfmt.Registry) error

Validate validates this check result

type Error

type Error struct {

	// code
	Code int64 `json:"code,omitempty"`

	// message
	// Required: true
	Message *string `json:"message"`
}

Error error swagger:model error

func (*Error) MarshalBinary

func (m *Error) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Error) UnmarshalBinary

func (m *Error) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Error) Validate

func (m *Error) Validate(formats strfmt.Registry) error

Validate validates this error

type Plugin

type Plugin struct {

	// detailed plugin description
	Description string `json:"description,omitempty"`

	// unique ID of installed plugin
	// basically it is slugged URI of plugin repository name e. g. supergiant-request-limits-check
	//
	ID string `json:"id,omitempty"`

	// date/Time the plugin was installed
	// Format: date-time
	InstalledAt strfmt.DateTime `json:"installedAt,omitempty"`

	// name is the name of the plugin.
	Name string `json:"name,omitempty"`

	// plugin status
	Status string `json:"status,omitempty"`

	// plugin version, major version shall be equal to robots version
	Version string `json:"version,omitempty"`
}

Plugin plugin represents the installed recommendation plugin swagger:model plugin

func (*Plugin) MarshalBinary

func (m *Plugin) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Plugin) UnmarshalBinary

func (m *Plugin) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Plugin) Validate

func (m *Plugin) Validate(formats strfmt.Registry) error

Validate validates this plugin

type PluginAction

type PluginAction struct {

	// detailed action description
	Description string `json:"description,omitempty"`

	// unique UUID of plugin action
	ID string `json:"id,omitempty"`

	// name of plugin action
	Name string `json:"name,omitempty"`
}

PluginAction CheckResult represents the single result of Check function invocation of specific plugin. swagger:model pluginAction

func (*PluginAction) MarshalBinary

func (m *PluginAction) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PluginAction) UnmarshalBinary

func (m *PluginAction) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PluginAction) Validate

func (m *PluginAction) Validate(formats strfmt.Registry) error

Validate validates this plugin action