model

Documentation

Index

• Constants
• Variables
• type Configuration
  • func (c *Configuration) FromProtobuf(in *pb.Configuration) error
• type Event
• type Experiment
• type Job
• type LoginResponse
• type Module
• type Object
  • func (o *Object) FromProtobuf(in *pb.Object) error
• type Permission
• type Property
  • func (p *Property) FromProtobuf(in *pb.Property) error
• type Response
• type Role
• type Status
• type User
  • func (user *User) ComparePassword(password string) bool
  • func (user *User) HashedPassword() error
• type UserCredentials

Constants

const (
	ExperimentStatusReady = string(iota + 1)
	ExperimentStatusRunning
	ExperimentStatusStarted
	ExperimentStatusStopped
	ExperimentStatusPaused
	ExperimentStatusWaiting
	ExperimentStatusFailed
)

const (
	JobStatusSubmitted = string(iota + 1)
	JobStatusRunning
	JobStatusStopped
	JobStatusPaused
	JobStatusFinished
	JobStatusFailed
	JobStatusCancelled
)

const (
	ModuleStateConnected = string(iota + 1)
	ModuleStateDisconnected
	ModuleStateFaulted
	ModuleStateRunning
	ModuleStatePaused
	ModuleStateStopped
	ModuleStateReady
)

Variables

var (
	ExperimentStatus = map[string]string{
		ExperimentStatusReady:   "READY",
		ExperimentStatusRunning: "RUNNING",
		ExperimentStatusStarted: "STARTED",
		ExperimentStatusStopped: "STOPPED",
		ExperimentStatusPaused:  "PAUSED",
		ExperimentStatusWaiting: "WAITING",
		ExperimentStatusFailed:  "FAILED",
	}
)

var (
	JobStatus = map[string]string{
		JobStatusSubmitted: "SUBMITTED",
		JobStatusRunning:   "RUNNING",
		JobStatusStopped:   "STOPPED",
		JobStatusPaused:    "PAUSED",
		JobStatusFinished:  "FINISHED",
		JobStatusFailed:    "FAILED",
		JobStatusCancelled: "CANCELLED",
	}
)

var (
	ModuleState = map[string]string{
		ModuleStateConnected:    "CONNECTED",
		ModuleStateDisconnected: "DISCONNECTED",
		ModuleStateFaulted:      "FAULTED",
		ModuleStateRunning:      "RUNNING",
		ModuleStatePaused:       "PAUSED",
		ModuleStateStopped:      "STOPPED",
		ModuleStateReady:        "READY",
	}
)

Types

type Configuration

type Configuration struct {
	ID         string
	Name       string
	Namespace  string
	Objects    []*Object
	Properties []*Property
}

func (*Configuration) FromProtobuf

func (c *Configuration) FromProtobuf(in *pb.Configuration) error

type Event

type Event struct {
	ID          int32
	Name        string
	Description string
}

type Experiment

type Experiment struct {
	ID                string
	Status            string
	Name              string
	StartTime         float64
	EstimatedDuration float64
	TimeElapsed       float64
	Modules           []*Module
	Properties        []*Property
}

Experiment links modules with runtimes and results

type Job

type Job struct {
	ID         string
	Status     string
	StartTime  float64
	FinishTime float64
	Module     *Module
	Properties []*Property
}

Job links modules with runtimes and results

type LoginResponse

type LoginResponse struct {
	*Response
	AccessToken string `json:"access_token,omitempty"`
}

type Module

type Module struct {
	ModuleName    string
	ServiceName   string
	State         string
	Properties    []*Property
	Configuration *Configuration
	Status        *Status
	Jobs          []*Job
}

type Object

type Object struct {
	ID         string
	Name       string
	Type       string
	Objects    []*Object
	Properties []*Property
}

func (*Object) FromProtobuf

func (o *Object) FromProtobuf(in *pb.Object) error

type Permission

type Permission struct {
	ID   int64
	Name string
}

type Property

type Property struct {
	Key   string
	Value string
}

Property : Describes the details through KV structure

func (*Property) FromProtobuf

func (p *Property) FromProtobuf(in *pb.Property) error

FromProtobuf : Sets the Property's key and value from the Protobuf property

type Response

type Response struct {
	Code  int    `json:"code"`
	Error string `json:"error,omitempty"`
}

type Role

type Role struct {
	ID        string
	Name      string
	CreatedAt string `db:"created_at"`
}

type Status

type Status struct {
	Enabled bool
	Loaded  bool
	Active  bool
	Details map[string]string
}

type User

type User struct {
	ID        string
	Email     string
	Password  string
	IPAddress string `db:"ip_address"`
	CreatedAt string `db:"created_at"`
	Roles     []*Role
}

func (*User) ComparePassword

func (user *User) ComparePassword(password string) bool

func (*User) HashedPassword

func (user *User) HashedPassword() error

type UserCredentials

type UserCredentials struct {
	Email    string `json:"email"`
	Password string `json:"password"`
}