messages

Documentation

Overview

Package messages contains the structs and types as defined by this schema.

Index

• Constants
• type Device
• type DeviceLogs
• type DeviceSnap
• type DeviceUser
• type DeviceVersion
• type Health
• type IoTDeviceTwinToAgentSchemaDefinitions
• type PublishDevice
• type PublishDeviceVersion
• type PublishResponse
• type PublishSnap
• type PublishSnapTask
• type PublishSnaps
• type SchemaDefinitionsForTheRESTAPI
• type ServiceStatus
• type SnapService
• type SnapSnapshot
• type SnapUpdate
• type SubscribeAction

Constants

const (
	SchemaID2188300499 = "schemas.json"
)

Types

type Device

type Device struct {
	Brand       string         `json:"brand,omitempty"`
	Created     time.Time      `json:"created,omitempty"`
	DeviceId    string         `json:"deviceId,omitempty"`
	DeviceKey   string         `json:"deviceKey,omitempty"`
	LastRefresh time.Time      `json:"lastRefresh,omitempty"`
	Model       string         `json:"model,omitempty"`
	OrgId       string         `json:"orgId,omitempty"`
	Serial      string         `json:"serial,omitempty"`
	Store       string         `json:"store,omitempty"`
	Version     *DeviceVersion `json:"version,omitempty"`
}

Device

type DeviceLogs

type DeviceLogs struct {

	// The max number of logs to pull down from snapd api.
	Limit int `json:"limit,omitempty"`

	// A presigned S3 url to PUT logs to
	Url string `json:"url,omitempty"`
}

DeviceLogs

type DeviceSnap

type DeviceSnap struct {
	Channel       string           `json:"channel,omitempty"`
	Config        string           `json:"config,omitempty"`
	Confinement   string           `json:"confinement,omitempty"`
	DeviceId      string           `json:"deviceId,omitempty"`
	Devmode       bool             `json:"devmode,omitempty"`
	InstalledDate time.Time        `json:"installedDate,omitempty"`
	InstalledSize int64            `json:"installedSize,omitempty"`
	Name          string           `json:"name,omitempty"`
	Revision      int              `json:"revision,omitempty"`
	Services      []*ServiceStatus `json:"services,omitempty"`
	Status        string           `json:"status,omitempty"`
	Version       string           `json:"version,omitempty"`
}

DeviceSnap

type DeviceUser

type DeviceUser struct {

	// What action to take on the provided user
	Action string `json:"action,omitempty"`

	// Ubuntu SSO email to use when creating a user
	Email string `json:"email,omitempty"`

	// Force the creation of the user even if the device is managed by a single user
	ForceManaged bool `json:"force-managed,omitempty"`

	// Flag to indicate that the user being created should have sudoer access
	Sudoer bool `json:"sudoer,omitempty"`

	// What username to remove from the device
	Username string `json:"username,omitempty"`
}

DeviceUser

type DeviceVersion

type DeviceVersion struct {
	DeviceId      string `json:"deviceId,omitempty"`
	KernelVersion string `json:"kernelVersion,omitempty"`
	OnClassic     bool   `json:"onClassic,omitempty"`
	OsId          string `json:"osId,omitempty"`
	OsVersionId   string `json:"osVersionId,omitempty"`
	Series        string `json:"series,omitempty"`
	Version       string `json:"version,omitempty"`
}

DeviceVersion

type Health

type Health struct {
	DeviceId string    `json:"deviceId,omitempty"`
	OrgId    string    `json:"orgId,omitempty"`
	Refresh  time.Time `json:"refresh,omitempty"`
}

Health

type IoTDeviceTwinToAgentSchemaDefinitions

type IoTDeviceTwinToAgentSchemaDefinitions interface{}

IoTDeviceTwinToAgentSchemaDefinitions

type PublishDevice

type PublishDevice struct {
	Action  string  `json:"action,omitempty"`
	Id      string  `json:"id,omitempty"`
	Message string  `json:"message,omitempty"`
	Result  *Device `json:"result,omitempty"`
	Success bool    `json:"success,omitempty"`
}

PublishDevice

type PublishDeviceVersion

type PublishDeviceVersion struct {
	Action  string         `json:"action,omitempty"`
	Id      string         `json:"id,omitempty"`
	Message string         `json:"message,omitempty"`
	Result  *DeviceVersion `json:"result,omitempty"`
	Success bool           `json:"success,omitempty"`
}

PublishDeviceVersion

type PublishResponse

type PublishResponse struct {
	Action  string `json:"action,omitempty"`
	Id      string `json:"id,omitempty"`
	Message string `json:"message,omitempty"`
	Success bool   `json:"success,omitempty"`
}

PublishResponse

type PublishSnap

type PublishSnap struct {
	Action  string      `json:"action,omitempty"`
	Id      string      `json:"id,omitempty"`
	Message string      `json:"message,omitempty"`
	Result  *DeviceSnap `json:"result,omitempty"`
	Success bool        `json:"success,omitempty"`
}

PublishSnap

type PublishSnapTask

type PublishSnapTask struct {
	Action  string `json:"action,omitempty"`
	Id      string `json:"id,omitempty"`
	Message string `json:"message,omitempty"`
	Result  string `json:"result,omitempty"`
	Success bool   `json:"success,omitempty"`
}

PublishSnapTask

type PublishSnaps

type PublishSnaps struct {
	Action  string        `json:"action,omitempty"`
	Id      string        `json:"id,omitempty"`
	Message string        `json:"message,omitempty"`
	Result  []*DeviceSnap `json:"result,omitempty"`
	Success bool          `json:"success,omitempty"`
}

PublishSnaps

type SchemaDefinitionsForTheRESTAPI

type SchemaDefinitionsForTheRESTAPI interface{}

SchemaDefinitionsForTheRESTAPI

type ServiceStatus

type ServiceStatus struct {
	Name    string `json:"name"`
	Active  bool   `json:"active"`
	Enabled bool   `json:"enabled"`
	Daemon  string `json:"string"`
}

ServiceStatus

type SnapService

type SnapService struct {

	// A list of services within the snap to take action on (or empty to apply to all)
	Services []string `json:"services,omitempty"`
}

SnapService

type SnapSnapshot

type SnapSnapshot struct {

	// A presigned S3 url to PUT a snapshot of a snap to
	Url string `json:"url,omitempty"`
}

SnapSnapshot

type SnapUpdate

type SnapUpdate struct {
	Data string `json:"data,omitempty"`
}

SnapUpdate

type SubscribeAction

type SubscribeAction struct {
	Action string `json:"action,omitempty"`
	Data   string `json:"data,omitempty"`
	Id     string `json:"id,omitempty"`
	Snap   string `json:"snap,omitempty"`
}

SubscribeAction