model

type IDList struct {
	IDs []uuid.UUID `json:"ids"`
}

type IDResp struct {
	ID uuid.UUID `json:"id"`
}

type LocationParameter struct {
	Xname     string `json:"xname" db:"xname"`
	DeputyKey string `json:"deputyKey,omitempty" db:"deputy_key"`
}

type LocationParameterSlice []LocationParameter

type ManagementStateFilter int

type Operation int

type Passback struct {
	StatusCode int
	Obj        interface{}
	Error      Problem7807
	IsError    bool
}

type PowerCapComponent struct {
	Xname          string             `json:"xname"`
	Error          string             `json:"error,omitempty"`
	Limits         *PowerCapabilities `json:"limits,omitempty"`
	PowerCapLimits []PowerCapControls `json:"powerCapLimits,omitempty"`
}

type PowerCapComponentParameter struct {
	Xname    string                     `json:"xname"`
	Controls []PowerCapControlParameter `json:"controls"`
}

type PowerCapComponentSlice []PowerCapComponent

type PowerCapControlParameter struct {
	Name  string `json:"name"`
	Value int    `json:"value"` //TODO is this the right data type? can it be double?
}

type PowerCapControls struct {
	Name         string `json:"name"`
	CurrentValue *int   `json:"currentValue,omitempty"`
	MaximumValue *int   `json:"maximumValue,omitempty"`
	MinimumValue *int   `json:"minimumValue,omitempty"`
}

type PowerCapOperation struct {
	OperationID uuid.UUID         `json:"operationID" db:"id"`
	TaskID      uuid.UUID         `json:"taskID" db:"task_id"`
	Type        string            `json:"type" db:"type"`
	Status      string            `json:"status" db:"status"`
	Component   PowerCapComponent `json:"Component" db:"component"`

	// unclear if we should store this in the DB. as best I can tell these are always pulled from SMD when we need to
	// use them. AFAICT we never skip a pull from SMD if we've pulled this data previously.
	//
	// These are populated and used in domain.doPowerCapTask(), and its child functions
	// domain.generatePowerCapPayload() and domain.parsePowerCapRFData(). The PowerCapOperation fields are direct
	// copies of values from a https://github.com/Cray-HPE/hms-power-control/blob/v2.13.0/internal/hsm/models.go#L63-L81
	// struct.
	//
	// The etcd storage engine does persist these by virtue of saving complete objects, but since PCS apparently
	// doesn't use the stored values and isn't authoritative for them, they're omitted from the Postgres schema.
	//
	// From HSM /Inventory/ComponentEndpoints
	RfFQDN                string                  `json:"RfFQDN"`
	PowerCapURI           string                  `json:"powerCapURI"`
	PowerCapTargetURI     string                  `json:"powerCapTargetURI"`
	PowerCapControlsCount int                     `json:"powerCapControlsCount"`
	PowerCapCtlInfoCount  int                     `json:"powerCapCtlInfoCount"`
	PowerCaps             map[string]hsm.PowerCap `json:"powerCap"`
}

type PowerCapPatchParameter struct {
	Components []PowerCapComponentParameter `json:"components"`
}

type PowerCapSnapshotParameter struct {
	Xnames []string `json:"xnames"`
}

type PowerCapTask struct {
	TaskID                  uuid.UUID                  `json:"taskID" db:"id"`
	Type                    string                     `json:"type" db:"type"`
	SnapshotParameters      *PowerCapSnapshotParameter `json:"snapshotParameters,omitempty" db:"snapshot_parameters"`
	PatchParameters         *PowerCapPatchParameter    `json:"patchParameters,omitempty" db:"patch_parameters"`
	TaskCreateTime          time.Time                  `json:"taskCreateTime" db:"created"`
	AutomaticExpirationTime time.Time                  `json:"automaticExpirationTime" db:"expires"`
	TaskStatus              string                     `json:"taskStatus" db:"status"`
	OperationIDs            []uuid.UUID

	// Only populated when the task is completed, but stored in the DB, not just calculated. these save an operation
	// list summary, since we delete operation rows after completing a task.
	IsCompressed bool                   `json:"isCompressed" db:"compressed"`
	TaskCounts   PowerCapTaskCounts     `json:"taskCounts" db:"task_counts,omitempty"`
	Components   PowerCapComponentSlice `json:"components,omitempty" db:"components,omitempty"`
}

type PowerCapTaskCounts struct {
	Total       int `json:"total"`
	New         int `json:"new"`
	InProgress  int `json:"in-progress"`
	Failed      int `json:"failed"`
	Succeeded   int `json:"succeeded"`
	Unsupported int `json:"un-supported"`
}

type PowerCapTaskCreation struct {
	TaskID uuid.UUID `json:"taskID"`
}

type PowerCapTaskResp struct {
	TaskID                  uuid.UUID              `json:"taskID"`
	Type                    string                 `json:"type"`
	TaskCreateTime          time.Time              `json:"taskCreateTime"`
	AutomaticExpirationTime time.Time              `json:"automaticExpirationTime"`
	TaskStatus              string                 `json:"taskStatus"`
	TaskCounts              PowerCapTaskCounts     `json:"taskCounts"`
	Components              PowerCapComponentSlice `json:"components,omitempty"`
}

type PowerCapTaskRespArray struct {
	Tasks []PowerCapTaskResp `json:"tasks"`
}

type PowerCapabilities struct {
	HostLimitMax *int `json:"hostLimitMax,omitempty"`
	HostLimitMin *int `json:"hostLimitMin,omitempty"`
	PowerupPower *int `json:"powerupPower,omitempty"`
}

type PowerStateFilter int

type PowerStatus struct {
	Status []PowerStatusComponent `json:"status"`
}

type PowerStatusComponent struct {
	XName                     string    `json:"xname" db:"xname"`
	PowerState                string    `json:"powerState" db:"power_state"`
	ManagementState           string    `json:"managementState" db:"management_state"`
	Error                     string    `json:"error" db:"error"`
	SupportedPowerTransitions []string  `json:"supportedPowerTransitions" db:"supported_power_transitions"`
	LastUpdated               time.Time `json:"lastUpdated" db:"last_updated"`
}

type PowerStatusParameter struct {
	Xnames                []string `json:"xname"`
	PowerStateFilter      string   `json:"powerStateFilter"`
	ManagementStateFilter string   `json:"managementStateFilter"`
}

type Problem7807 struct {
	Type_    string `json:"type"`
	Detail   string `json:"detail,omitempty"`
	Instance string `json:"instance,omitempty"`
	Status   int    `json:"status,omitempty"`
	Title    string `json:"title,omitempty"`
}

type TaskState int

type Transition struct {
	// TransitionID is the transition's ID.
	TransitionID uuid.UUID `json:"transitionID" db:"id"`
	// Operation indicates the operation to perform, such as off or soft restart.
	Operation Operation `json:"operation" db:"operation"`
	// TaskDeadline is the time limit for completing the transition.
	TaskDeadline int `json:"taskDeadlineMinutes" db:"deadline"`
	// Location contains a list of xnames and associated credentials to apply the transition to.
	Location LocationParameterSlice `json:"location" db:"location"`
	// CreateTime is the time the transition was requested.
	CreateTime time.Time `json:"createTime" db:"created"`
	// LastActiveTime is a timestamp the power service updates regularly as long as it considers the transition active.
	// This is used to reap old transitions that have been inactive for longer than a time threshold.
	LastActiveTime time.Time `json:"lastActiveTime" db:"active"`
	// AutomaticExpirationTime is a timestamp that will always reap a transition, regardless of its active status.
	AutomaticExpirationTime time.Time `json:"automaticExpirationTime" db:"expires"`
	// Status is the current phase of the transition lifecycle.
	Status string `json:"transitionStatus" db:"status"`
	// TaskIDs are the IDs of individual tasks in the transition/
	TaskIDs []uuid.UUID

	// IsCompressed indicates if the transition has its task counts tallied.
	IsCompressed bool `json:"isCompressed" db:"compressed"`
	// TaskCounts holds aggregate counts for task states.
	TaskCounts TransitionTaskCounts `json:"taskCounts" db:"task_counts"`
	// Tasks is a list of metadata about the transition's Tasks.
	Tasks TransitionTaskRespSlice `json:"tasks,omitempty" db:"tasks"`
}

type TransitionAbortResp struct {
	AbortStatus string `json:"abortStatus"`
}

type TransitionCreation struct {
	TransitionID uuid.UUID `json:"transitionID"`
	Operation    string    `json:"operation"`
}

type TransitionPage struct {
	ID           string               `json:"ID"`
	TransitionID uuid.UUID            `json:"transitionID"`
	Index        int                  `json:"index"`
	Location     []LocationParameter  `json:"location"`
	Tasks        []TransitionTaskResp `json:"tasks,omitempty"`
	TaskIDs      []uuid.UUID
}

type TransitionParameter struct {
	Operation    string              `json:"operation"`
	TaskDeadline *int                `json:"taskDeadlineMinutes"`
	Location     []LocationParameter `json:"location"`
}

type TransitionResp struct {
	TransitionID            uuid.UUID               `json:"transitionID"`
	Operation               string                  `json:"operation"`
	CreateTime              time.Time               `json:"createTime"`
	AutomaticExpirationTime time.Time               `json:"automaticExpirationTime"`
	TransitionStatus        string                  `json:"transitionStatus"`
	TaskCounts              TransitionTaskCounts    `json:"taskCounts"`
	Tasks                   TransitionTaskRespSlice `json:"tasks,omitempty"`
}

type TransitionRespArray struct {
	Transitions []TransitionResp `json:"transitions"`
}

type TransitionTask struct {
	TaskID         uuid.UUID `json:"taskID" db:"id"`
	TransitionID   uuid.UUID `json:"transitionID" db:"transition_id"`
	Operation      Operation `json:"operation" db:"operation"` // != Transition.Operation Tasks the redfish power command being issued (for recovery purposes)
	State          TaskState `json:"TaskState" db:"state"`
	Xname          string    `json:"xname" db:"xname"`
	ReservationKey string    `json:"reservationKey,omitempty" db:"reservation_key"`
	DeputyKey      string    `json:"deputyKey,omitempty" db:"deputy_key"`
	Status         string    `json:"taskStatus" db:"status"`
	StatusDesc     string    `json:"taskStatusDescription" db:"status_desc"`
	Error          string    `json:"error,omitempty" db:"error"`
}

type TransitionTaskCounts struct {
	Total       int `json:"total"`
	New         int `json:"new"`
	InProgress  int `json:"in-progress"`
	Failed      int `json:"failed"`
	Succeeded   int `json:"succeeded"`
	Unsupported int `json:"un-supported"`
}

type TransitionTaskResp struct {
	Xname          string `json:"xname"`
	TaskStatus     string `json:"taskStatus"`
	TaskStatusDesc string `json:"taskStatusDescription"`
	Error          string `json:"error,omitempty"`
}

type TransitionTaskRespSlice []TransitionTaskResp