datatypes

Documentation

Index

• type DependencyDescription
• type Hash
• type Links
• type OperationStatus
• type Protocol
• type RemoveAction
• type SoftwareArtifactAction
• type SoftwareModuleAction
• type SoftwareModuleID
• type Status
• type UpdateAction

Types

type DependencyDescription

type DependencyDescription struct {
	Group   string `json:"group,omitempty"`
	Name    string `json:"name"`
	Version string `json:"version"`
	Type    string `json:"type,omitempty"`
}

DependencyDescription represents the DependencyDescription Vorto SUv2 datatype

type Hash

type Hash string

Hash represents the supported hashing algorithms

const (
	// SHA1 algorithm
	SHA1 Hash = "SHA1"
	// SHA256 algorithm
	SHA256 Hash = "SHA256"
	// MD5 algorithm
	MD5 Hash = "MD5"
)

type Links

type Links struct {
	URL    string `json:"url"`
	MD5URL string `json:"md5url"`
}

Links represents the Links Vorto SUv2 datatype

type OperationStatus

type OperationStatus struct {
	CorrelationID  string                   `json:"correlationId"`
	Status         Status                   `json:"status"`
	SoftwareModule *SoftwareModuleID        `json:"softwareModule,omitempty"`
	Software       []*DependencyDescription `json:"software,omitempty"`
	Progress       int                      `json:"progress,omitempty"`
	Message        string                   `json:"message,omitempty"`
	StatusCode     string                   `json:"statusCode,omitempty"`
}

OperationStatus represents the OperationStatus Vorto SUv2 datatype

type Protocol

type Protocol string

Protocol represents the Protocol Vorto SUv2 datatype

const (
	// HTTP scheme
	HTTP Protocol = "HTTP"
	// HTTPS scheme
	HTTPS Protocol = "HTTPS"
	// FTP scheme
	FTP Protocol = "FTP"
	// SFTP scheme
	SFTP Protocol = "SFTP"
)

type RemoveAction

type RemoveAction struct {
	CorrelationID string                   `json:"correlationId"`
	Software      []*DependencyDescription `json:"software"`
	Weight        int                      `json:"weight,omitempty"`
	Metadata      map[string]string        `json:"metadata,omitempty"`
	Forced        bool                     `json:"forced,omitempty"`
}

RemoveAction represents the SoftwareRemoveAction Vorto SUv2 datatype

type SoftwareArtifactAction

type SoftwareArtifactAction struct {
	FileName  string              `json:"filename"`
	Download  map[Protocol]*Links `json:"download"`
	Checksums map[Hash]string     `json:"checksums"`
	Size      uint64              `json:"size"`
}

SoftwareArtifactAction represents the SoftwareArtifactAction Vorto SUv2 datatype

type SoftwareModuleAction

type SoftwareModuleAction struct {
	SoftwareModule *SoftwareModuleID         `json:"softwareModule,omitempty"`
	Artifacts      []*SoftwareArtifactAction `json:"artifacts,omitempty"`
	MetaData       map[string]string         `json:"metadata,omitempty"`
}

SoftwareModuleAction represents the SoftwareModuleAction Vorto SUv2 datatype

type SoftwareModuleID

type SoftwareModuleID struct {
	Name    string `json:"name"`
	Version string `json:"version"`
}

SoftwareModuleID represents the SoftwareModuleID Vorto SUv2 datatype

type Status

type Status string

Status represents the Status Vorto SUv2 datatype

const (
	// Started operation status
	Started Status = "STARTED"
	// Downloading operation status
	Downloading Status = "DOWNLOADING"
	// DownloadingWaiting operation status
	DownloadingWaiting Status = "DOWNLOADING_WAITING"
	// Downloaded operation status
	Downloaded Status = "DOWNLOADED"
	// Installing operation status
	Installing Status = "INSTALLING"
	// InstallingWaiting operation status
	InstallingWaiting Status = "INSTALLING_WAITING"
	// Installed operation status
	Installed Status = "INSTALLED"
	// Removing operation status
	Removing Status = "REMOVING"
	// RemovingWaiting operation status
	RemovingWaiting Status = "REMOVING_WAITING"
	// Removed operation status
	Removed Status = "REMOVED"
	// Canceling operation status
	Canceling Status = "CANCELING"
	// CancelingWaiting operation status
	CancelingWaiting Status = "CANCELING_WAITING"
	// CancelRejected operation status
	CancelRejected Status = "CANCEL_REJECTED"
	// FinishedCanceled operation status
	FinishedCanceled Status = "FINISHED_CANCELED"
	// FinishedError operation status
	FinishedError Status = "FINISHED_ERROR"
	// FinishedSuccess operation status
	FinishedSuccess Status = "FINISHED_SUCCESS"
	// FinishedWarning operation status
	FinishedWarning Status = "FINISHED_WARNING"
	// FinishedRejected operation status
	FinishedRejected Status = "FINISHED_REJECTED"
)

type UpdateAction

type UpdateAction struct {
	CorrelationID   string                  `json:"correlationId"`
	SoftwareModules []*SoftwareModuleAction `json:"softwareModules"`
	Weight          int                     `json:"weight,omitempty"`
	Metadata        map[string]string       `json:"metadata,omitempty"`
	Forced          bool                    `json:"forced,omitempty"`
}

UpdateAction represents the SoftwareUpdateAction Vorto SUv2 datatype