Documentation
¶
Index ¶
- Variables
- type Configuration
- func (*Configuration) Descriptor() ([]byte, []int)
- func (m *Configuration) GetArgs() []string
- func (m *Configuration) GetCommand() string
- func (m *Configuration) GetPorts() []string
- func (m *Configuration) GetVolumes() []string
- func (m *Configuration) GetVolumesFrom() []string
- func (*Configuration) ProtoMessage()
- func (m *Configuration) Reset()
- func (m *Configuration) String() string
- func (m *Configuration) XXX_DiscardUnknown()
- func (m *Configuration) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Configuration) XXX_Merge(src proto.Message)
- func (m *Configuration) XXX_Size() int
- func (m *Configuration) XXX_Unmarshal(b []byte) error
- type Dependency
- func (*Dependency) Descriptor() ([]byte, []int)
- func (m *Dependency) GetArgs() []string
- func (m *Dependency) GetCommand() string
- func (m *Dependency) GetImage() string
- func (m *Dependency) GetKey() string
- func (m *Dependency) GetPorts() []string
- func (m *Dependency) GetVolumes() []string
- func (m *Dependency) GetVolumesFrom() []string
- func (*Dependency) ProtoMessage()
- func (m *Dependency) Reset()
- func (m *Dependency) String() string
- func (m *Dependency) XXX_DiscardUnknown()
- func (m *Dependency) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Dependency) XXX_Merge(src proto.Message)
- func (m *Dependency) XXX_Size() int
- func (m *Dependency) XXX_Unmarshal(b []byte) error
- type Event
- func (*Event) Descriptor() ([]byte, []int)
- func (m *Event) GetData() []*Parameter
- func (m *Event) GetDescription() string
- func (m *Event) GetKey() string
- func (m *Event) GetName() string
- func (*Event) ProtoMessage()
- func (m *Event) Reset()
- func (m *Event) String() string
- func (m *Event) XXX_DiscardUnknown()
- func (m *Event) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Event) XXX_Merge(src proto.Message)
- func (m *Event) XXX_Size() int
- func (m *Event) XXX_Unmarshal(b []byte) error
- type Execution
- func (*Execution) Descriptor() ([]byte, []int)
- func (m *Execution) GetError() string
- func (m *Execution) GetEventID() string
- func (m *Execution) GetHash() string
- func (m *Execution) GetInputs() string
- func (m *Execution) GetOutputs() string
- func (m *Execution) GetParentHash() string
- func (m *Execution) GetServiceHash() string
- func (m *Execution) GetStatus() Status
- func (m *Execution) GetTags() []string
- func (m *Execution) GetTaskKey() string
- func (*Execution) ProtoMessage()
- func (m *Execution) Reset()
- func (m *Execution) String() string
- func (m *Execution) XXX_DiscardUnknown()
- func (m *Execution) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Execution) XXX_Merge(src proto.Message)
- func (m *Execution) XXX_Size() int
- func (m *Execution) XXX_Unmarshal(b []byte) error
- type Parameter
- func (*Parameter) Descriptor() ([]byte, []int)
- func (m *Parameter) GetDescription() string
- func (m *Parameter) GetKey() string
- func (m *Parameter) GetName() string
- func (m *Parameter) GetObject() []*Parameter
- func (m *Parameter) GetOptional() bool
- func (m *Parameter) GetRepeated() bool
- func (m *Parameter) GetType() string
- func (*Parameter) ProtoMessage()
- func (m *Parameter) Reset()
- func (m *Parameter) String() string
- func (m *Parameter) XXX_DiscardUnknown()
- func (m *Parameter) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Parameter) XXX_Merge(src proto.Message)
- func (m *Parameter) XXX_Size() int
- func (m *Parameter) XXX_Unmarshal(b []byte) error
- type Service
- func (*Service) Descriptor() ([]byte, []int)
- func (m *Service) GetConfiguration() *Configuration
- func (m *Service) GetDependencies() []*Dependency
- func (m *Service) GetDescription() string
- func (m *Service) GetEvents() []*Event
- func (m *Service) GetHash() string
- func (m *Service) GetName() string
- func (m *Service) GetRepository() string
- func (m *Service) GetSid() string
- func (m *Service) GetSource() string
- func (m *Service) GetTasks() []*Task
- func (*Service) ProtoMessage()
- func (m *Service) Reset()
- func (m *Service) String() string
- func (m *Service) XXX_DiscardUnknown()
- func (m *Service) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Service) XXX_Merge(src proto.Message)
- func (m *Service) XXX_Size() int
- func (m *Service) XXX_Unmarshal(b []byte) error
- type Status
- type Task
- func (*Task) Descriptor() ([]byte, []int)
- func (m *Task) GetDescription() string
- func (m *Task) GetInputs() []*Parameter
- func (m *Task) GetKey() string
- func (m *Task) GetName() string
- func (m *Task) GetOutputs() []*Parameter
- func (*Task) ProtoMessage()
- func (m *Task) Reset()
- func (m *Task) String() string
- func (m *Task) XXX_DiscardUnknown()
- func (m *Task) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *Task) XXX_Merge(src proto.Message)
- func (m *Task) XXX_Size() int
- func (m *Task) XXX_Unmarshal(b []byte) error
Constants ¶
This section is empty.
Variables ¶
View Source
var Status_name = map[int32]string{
0: "Unknown",
1: "Created",
2: "InProgress",
3: "Completed",
4: "Failed",
}
View Source
var Status_value = map[string]int32{
"Unknown": 0,
"Created": 1,
"InProgress": 2,
"Completed": 3,
"Failed": 4,
}
Functions ¶
This section is empty.
Types ¶
type Configuration ¶
type Configuration struct { Volumes []string `protobuf:"bytes,1,rep,name=volumes,proto3" json:"volumes,omitempty"` VolumesFrom []string `protobuf:"bytes,2,rep,name=volumesFrom,proto3" json:"volumesFrom,omitempty"` Ports []string `protobuf:"bytes,3,rep,name=ports,proto3" json:"ports,omitempty"` Args []string `protobuf:"bytes,4,rep,name=args,proto3" json:"args,omitempty"` Command string `protobuf:"bytes,5,opt,name=command,proto3" json:"command,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*Configuration) Descriptor ¶
func (*Configuration) Descriptor() ([]byte, []int)
func (*Configuration) GetArgs ¶
func (m *Configuration) GetArgs() []string
func (*Configuration) GetCommand ¶
func (m *Configuration) GetCommand() string
func (*Configuration) GetPorts ¶
func (m *Configuration) GetPorts() []string
func (*Configuration) GetVolumes ¶
func (m *Configuration) GetVolumes() []string
func (*Configuration) GetVolumesFrom ¶
func (m *Configuration) GetVolumesFrom() []string
func (*Configuration) ProtoMessage ¶
func (*Configuration) ProtoMessage()
func (*Configuration) Reset ¶
func (m *Configuration) Reset()
func (*Configuration) String ¶
func (m *Configuration) String() string
func (*Configuration) XXX_DiscardUnknown ¶
func (m *Configuration) XXX_DiscardUnknown()
func (*Configuration) XXX_Marshal ¶
func (m *Configuration) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*Configuration) XXX_Merge ¶
func (dst *Configuration) XXX_Merge(src proto.Message)
func (*Configuration) XXX_Size ¶
func (m *Configuration) XXX_Size() int
func (*Configuration) XXX_Unmarshal ¶
func (m *Configuration) XXX_Unmarshal(b []byte) error
type Dependency ¶
type Dependency struct { Key string `protobuf:"bytes,8,opt,name=key,proto3" json:"key,omitempty"` Image string `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"` Volumes []string `protobuf:"bytes,2,rep,name=volumes,proto3" json:"volumes,omitempty"` VolumesFrom []string `protobuf:"bytes,3,rep,name=volumesFrom,proto3" json:"volumesFrom,omitempty"` Ports []string `protobuf:"bytes,4,rep,name=ports,proto3" json:"ports,omitempty"` Args []string `protobuf:"bytes,6,rep,name=args,proto3" json:"args,omitempty"` Command string `protobuf:"bytes,5,opt,name=command,proto3" json:"command,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
A dependency is a configuration of an other container that runs separately from the service.
func (*Dependency) Descriptor ¶
func (*Dependency) Descriptor() ([]byte, []int)
func (*Dependency) GetArgs ¶
func (m *Dependency) GetArgs() []string
func (*Dependency) GetCommand ¶
func (m *Dependency) GetCommand() string
func (*Dependency) GetImage ¶
func (m *Dependency) GetImage() string
func (*Dependency) GetKey ¶
func (m *Dependency) GetKey() string
func (*Dependency) GetPorts ¶
func (m *Dependency) GetPorts() []string
func (*Dependency) GetVolumes ¶
func (m *Dependency) GetVolumes() []string
func (*Dependency) GetVolumesFrom ¶
func (m *Dependency) GetVolumesFrom() []string
func (*Dependency) ProtoMessage ¶
func (*Dependency) ProtoMessage()
func (*Dependency) Reset ¶
func (m *Dependency) Reset()
func (*Dependency) String ¶
func (m *Dependency) String() string
func (*Dependency) XXX_DiscardUnknown ¶
func (m *Dependency) XXX_DiscardUnknown()
func (*Dependency) XXX_Marshal ¶
func (m *Dependency) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*Dependency) XXX_Merge ¶
func (dst *Dependency) XXX_Merge(src proto.Message)
func (*Dependency) XXX_Size ¶
func (m *Dependency) XXX_Size() int
func (*Dependency) XXX_Unmarshal ¶
func (m *Dependency) XXX_Unmarshal(b []byte) error
type Event ¶
type Event struct { Key string `protobuf:"bytes,4,opt,name=key,proto3" json:"key,omitempty"` Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` Data []*Parameter `protobuf:"bytes,3,rep,name=data,proto3" json:"data,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Events are emitted by the service whenever the service wants.
func (*Event) Descriptor ¶
func (*Event) GetDescription ¶
func (*Event) ProtoMessage ¶
func (*Event) ProtoMessage()
func (*Event) XXX_DiscardUnknown ¶
func (m *Event) XXX_DiscardUnknown()
func (*Event) XXX_Marshal ¶
func (*Event) XXX_Unmarshal ¶
type Execution ¶ added in v0.10.0
type Execution struct { // Hash is a unique hash that represents given execution. Hash string `protobuf:"bytes,1,opt,name=hash,proto3" json:"hash,omitempty"` // parentHash is unique hash that represents that triggerd current execution. ParentHash string `protobuf:"bytes,2,opt,name=parentHash,proto3" json:"parentHash,omitempty"` // eventID is unique event id. EventID string `protobuf:"bytes,3,opt,name=eventID,proto3" json:"eventID,omitempty"` // Status is the current status of execution. Status Status `protobuf:"varint,4,opt,name=status,proto3,enum=definition.Status" json:"status,omitempty"` // serviceHash is hash of service that can proceed an execution ServiceHash string `protobuf:"bytes,5,opt,name=serviceHash,proto3" json:"serviceHash,omitempty"` // taskKey is a task key from a service definition. TaskKey string `protobuf:"bytes,6,opt,name=taskKey,proto3" json:"taskKey,omitempty"` // inputs is an inptut of execution. Inputs string `protobuf:"bytes,7,opt,name=inputs,proto3" json:"inputs,omitempty"` // outputs is an output of successful execution. Outputs string `protobuf:"bytes,8,opt,name=outputs,proto3" json:"outputs,omitempty"` // error is an output of a failed execution. Error string `protobuf:"bytes,9,opt,name=error,proto3" json:"error,omitempty"` // tags contains custom tags attached to execution. Tags []string `protobuf:"bytes,10,rep,name=tags,proto3" json:"tags,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Execution represents a single execution run in engine.
func (*Execution) Descriptor ¶ added in v0.10.0
func (*Execution) GetEventID ¶ added in v0.10.0
func (*Execution) GetOutputs ¶ added in v0.10.0
func (*Execution) GetParentHash ¶ added in v0.10.0
func (*Execution) GetServiceHash ¶ added in v0.10.0
func (*Execution) GetTaskKey ¶ added in v0.10.0
func (*Execution) ProtoMessage ¶ added in v0.10.0
func (*Execution) ProtoMessage()
func (*Execution) XXX_DiscardUnknown ¶ added in v0.10.0
func (m *Execution) XXX_DiscardUnknown()
func (*Execution) XXX_Marshal ¶ added in v0.10.0
func (*Execution) XXX_Unmarshal ¶ added in v0.10.0
type Parameter ¶
type Parameter struct { Key string `protobuf:"bytes,8,opt,name=key,proto3" json:"key,omitempty"` Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` Type string `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"` Optional bool `protobuf:"varint,4,opt,name=optional,proto3" json:"optional,omitempty"` Repeated bool `protobuf:"varint,9,opt,name=repeated,proto3" json:"repeated,omitempty"` Object []*Parameter `protobuf:"bytes,10,rep,name=object,proto3" json:"object,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Parameter describes the task's inputs, the task's outputs, and the event's data.
func (*Parameter) Descriptor ¶
func (*Parameter) GetDescription ¶
func (*Parameter) GetOptional ¶
func (*Parameter) GetRepeated ¶
func (*Parameter) ProtoMessage ¶
func (*Parameter) ProtoMessage()
func (*Parameter) XXX_DiscardUnknown ¶
func (m *Parameter) XXX_DiscardUnknown()
func (*Parameter) XXX_Marshal ¶
func (*Parameter) XXX_Unmarshal ¶
type Service ¶
type Service struct { Hash string `protobuf:"bytes,10,opt,name=hash,proto3" json:"hash,omitempty"` Sid string `protobuf:"bytes,12,opt,name=sid,proto3" json:"sid,omitempty"` Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` Configuration *Configuration `protobuf:"bytes,8,opt,name=configuration,proto3" json:"configuration,omitempty"` Tasks []*Task `protobuf:"bytes,5,rep,name=tasks,proto3" json:"tasks,omitempty"` Events []*Event `protobuf:"bytes,6,rep,name=events,proto3" json:"events,omitempty"` Dependencies []*Dependency `protobuf:"bytes,7,rep,name=dependencies,proto3" json:"dependencies,omitempty"` Repository string `protobuf:"bytes,9,opt,name=repository,proto3" json:"repository,omitempty"` Source string `protobuf:"bytes,13,opt,name=source,proto3" json:"source,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Service represents the service's definition.
func (*Service) Descriptor ¶
func (*Service) GetConfiguration ¶
func (m *Service) GetConfiguration() *Configuration
func (*Service) GetDependencies ¶
func (m *Service) GetDependencies() []*Dependency
func (*Service) GetDescription ¶
func (*Service) GetRepository ¶
func (*Service) ProtoMessage ¶
func (*Service) ProtoMessage()
func (*Service) XXX_DiscardUnknown ¶
func (m *Service) XXX_DiscardUnknown()
func (*Service) XXX_Marshal ¶
func (*Service) XXX_Unmarshal ¶
type Status ¶ added in v0.10.0
type Status int32
Status represents the status of a single execution. Note that a valid execution must have only one status flag at time.
const ( // Unknown status represents any status unknown to execution. Status_Unknown Status = 0 // Created is an initial status after execution creation. Status_Created Status = 1 // InProgress informs that processing of execution has been started. Status_InProgress Status = 2 // Completed is a success status after execution was processed. Status_Completed Status = 3 // Failed is an error status after execution was processed. Status_Failed Status = 4 )
func (Status) EnumDescriptor ¶ added in v0.10.0
type Task ¶
type Task struct { Key string `protobuf:"bytes,8,opt,name=key,proto3" json:"key,omitempty"` Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` Inputs []*Parameter `protobuf:"bytes,6,rep,name=inputs,proto3" json:"inputs,omitempty"` Outputs []*Parameter `protobuf:"bytes,7,rep,name=outputs,proto3" json:"outputs,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Task is a function that requires inputs and returns output.
func (*Task) Descriptor ¶
func (*Task) GetDescription ¶
func (*Task) GetOutputs ¶
func (*Task) ProtoMessage ¶
func (*Task) ProtoMessage()
func (*Task) XXX_DiscardUnknown ¶
func (m *Task) XXX_DiscardUnknown()
func (*Task) XXX_Unmarshal ¶
Click to show internal directories.
Click to hide internal directories.