capresponse

Documentation

Overview

Package capresponse ...

Package capresponse ...

Package capresponse ...

Package capresponse ...

Index

• func SetErrorResponse(ctx iris.Context, statusCode int32, statusMsg, errMsg string, ...)
• type Device
• type EmbQueue
• type EventMessageBus
• type Manager
• type ManagerStatus
• type ManagersCollection
• type PluginStatusResponse
• type Status

Functions

func SetErrorResponse

func SetErrorResponse(ctx iris.Context, statusCode int32, statusMsg, errMsg string, msgArgs []interface{})

SetErrorResponse will accepts the iris context, error string and status code it will set error resopnse to ctx

Types

type Device

type Device struct {
	ServerIP   string `json:"ServerIP"`
	Username   string `json:"Username"`
	DeviceUUID string `json:"device_UUID"`
}

Device struct definition

type EmbQueue

type EmbQueue struct {
	QueueName string `json:"EmbQueueName"`
	QueueDesc string `json:"EmbQueueDesc"`
}

EmbQueue holds the information of Queue Name and Queue Description

type EventMessageBus

type EventMessageBus struct {
	EmbType  string     `json:"EmbType"`
	EmbQueue []EmbQueue `json:"EmbQueue"`
}

EventMessageBus holds the information of EMB Broker type and EMBQueue information

type Manager

type Manager struct {
	OdataContext    string         `json:"@odata.context"`
	Etag            string         `json:"@odata.etag,omitempty"`
	OdataID         string         `json:"@odata.id"`
	OdataType       string         `json:"@odata.type"`
	Name            string         `json:"Name"`
	ManagerType     string         `json:"ManagerType"`
	ID              string         `json:"Id"`
	UUID            string         `json:"UUID"`
	FirmwareVersion string         `json:"FirmwareVersion"`
	Status          *ManagerStatus `json:"Status,omitempty"`
}

Manager struct for manager deta

type ManagerStatus

type ManagerStatus struct {
	State string `json:"State"`
}

ManagerStatus struct is to define the status of the manager

type ManagersCollection

type ManagersCollection struct {
	OdataContext string           `json:"@odata.context"`
	Etag         string           `json:"@odata.etag,omitempty"`
	OdataID      string           `json:"@odata.id"`
	OdataType    string           `json:"@odata.type"`
	Description  string           `json:"Description"`
	Name         string           `json:"Name"`
	Members      []dmtfmodel.Link `json:"Members"`
	MembersCount int              `json:"Members@odata.count"`
}

ManagersCollection for Plugin

type PluginStatusResponse

type PluginStatusResponse struct {
	Comment         string          `json:"_comment"`
	Name            string          `json:"Name"`
	Version         string          `json:"Version"`
	Status          Status          `json:"Status"`
	EventMessageBus EventMessageBus `json:"EventMessageBus"`
}

PluginStatusResponse holds the information of response of PluginStatus

type Status

type Status struct {
	Available string `json:"Available"`
	Uptime    string `json:"Uptime"`
	TimeStamp string `json:"TimeStamp"`
}

Status holds information of Plugin Status