109 lines
3.3 KiB
Go
109 lines
3.3 KiB
Go
package platform
|
|
|
|
import (
|
|
"context"
|
|
)
|
|
|
|
const (
|
|
TaskDefaultPageSize = 100
|
|
TaskMaxPageSize = 500
|
|
)
|
|
|
|
// Task is a task. 🎊
|
|
type Task struct {
|
|
ID ID `json:"id,omitempty"`
|
|
Organization ID `json:"organizationID"`
|
|
Name string `json:"name"`
|
|
Status string `json:"status"`
|
|
Owner User `json:"owner"`
|
|
Flux string `json:"flux"`
|
|
Every string `json:"every,omitempty"`
|
|
Cron string `json:"cron,omitempty"`
|
|
Offset string `json:"offset,omitempty"`
|
|
LatestCompleted string `json:"latest_completed,omitempty"`
|
|
}
|
|
|
|
// Run is a record created when a run of a task is scheduled.
|
|
type Run struct {
|
|
ID ID `json:"id,omitempty"`
|
|
TaskID ID `json:"taskID"`
|
|
Status string `json:"status"`
|
|
ScheduledFor string `json:"scheduledFor"`
|
|
StartedAt string `json:"startedAt,omitempty"`
|
|
FinishedAt string `json:"finishedAt,omitempty"`
|
|
RequestedAt string `json:"requestedAt,omitempty"`
|
|
Log Log `json:"log"`
|
|
}
|
|
|
|
// Log represents a link to a log resource
|
|
type Log string
|
|
|
|
// TaskService represents a service for managing one-off and recurring tasks.
|
|
type TaskService interface {
|
|
// FindTaskByID returns a single task
|
|
FindTaskByID(ctx context.Context, id ID) (*Task, error)
|
|
|
|
// FindTasks returns a list of tasks that match a filter (limit 100) and the total count
|
|
// of matching tasks.
|
|
FindTasks(ctx context.Context, filter TaskFilter) ([]*Task, int, error)
|
|
|
|
// CreateTask creates a new task.
|
|
CreateTask(ctx context.Context, t *Task) error
|
|
|
|
// UpdateTask updates a single task with changeset.
|
|
UpdateTask(ctx context.Context, id ID, upd TaskUpdate) (*Task, error)
|
|
|
|
// DeleteTask removes a task by ID and purges all associated data and scheduled runs.
|
|
DeleteTask(ctx context.Context, id ID) error
|
|
|
|
// FindLogs returns logs for a run.
|
|
FindLogs(ctx context.Context, filter LogFilter) ([]*Log, int, error)
|
|
|
|
// FindRuns returns a list of runs that match a filter and the total count of returned runs.
|
|
FindRuns(ctx context.Context, filter RunFilter) ([]*Run, int, error)
|
|
|
|
// FindRunByID returns a single run.
|
|
FindRunByID(ctx context.Context, taskID, runID ID) (*Run, error)
|
|
|
|
// CancelRun cancels a currently running run.
|
|
CancelRun(ctx context.Context, taskID, runID ID) error
|
|
|
|
// RetryRun creates and returns a new run (which is a retry of another run).
|
|
RetryRun(ctx context.Context, taskID, runID ID) (*Run, error)
|
|
|
|
// ForceRun forces a run to occur with unix timestamp scheduledFor, to be executed as soon as possible.
|
|
// The value of scheduledFor may or may not align with the task's schedule.
|
|
ForceRun(ctx context.Context, taskID ID, scheduledFor int64) (*Run, error)
|
|
}
|
|
|
|
// TaskUpdate represents updates to a task
|
|
type TaskUpdate struct {
|
|
Flux *string `json:"flux,omitempty"`
|
|
Status *string `json:"status,omitempty"`
|
|
}
|
|
|
|
// TaskFilter represents a set of filters that restrict the returned results
|
|
type TaskFilter struct {
|
|
After *ID
|
|
Organization *ID
|
|
User *ID
|
|
Limit int
|
|
}
|
|
|
|
// RunFilter represents a set of filters that restrict the returned results
|
|
type RunFilter struct {
|
|
Org *ID
|
|
Task *ID
|
|
After *ID
|
|
Limit int
|
|
AfterTime string
|
|
BeforeTime string
|
|
}
|
|
|
|
// LogFilter represents a set of filters that restrict the returned results
|
|
type LogFilter struct {
|
|
Org *ID
|
|
Task *ID
|
|
Run *ID
|
|
}
|