Documentation
¶
Index ¶
Constants ¶
View Source
const CTJSON string = "application/json"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type JobPage ¶ added in v0.4.0
type JobPage struct {
Offset uint64 `json:"offset"`
Limit uint64 `json:"limit"`
Total uint64 `json:"total"`
Jobs []JobSummary `json:"jobs"`
}
type JobRequest ¶ added in v0.4.0
type JobResponse ¶ added in v0.4.0
type JobSummary ¶ added in v0.4.0
type PageMetadata ¶
type SDK ¶
type SDK interface {
// CreateTask creates a new task.
//
// example:
// task := sdk.Task{
// Name: "John Doe"
// }
// task, _ := sdk.CreateTask(task)
// fmt.Println(task)
CreateTask(task Task) (Task, error)
// GetTask gets a task by id.
//
// example:
// task, _ := sdk.GetTask("b1d10738-c5d7-4ff1-8f4d-b9328ce6f040")
// fmt.Println(task)
GetTask(id string) (Task, error)
// ListTasks lists tasks.
//
// example:
// taskPage, _ := sdk.ListTasks(0, 10)
// fmt.Println(taskPage)
ListTasks(offset uint64, limit uint64) (TaskPage, error)
// UpdateTask updates a task.
//
// example:
// task := sdk.Task{
// Name: "John Doe"
// }
// task, _ := sdk.UpdateTask(task)
// fmt.Println(task)
UpdateTask(task Task) (Task, error)
// DeleteTask deletes a task.
//
// example:
// task, _ := sdk.DeleteTask("b1d10738-c5d7-4ff1-8f4d-b9328ce6f040")
// fmt.Println(task)
DeleteTask(id string) error
// StartTask starts a task.
//
// example:
// task, _ := sdk.StartTask("b1d10738-c5d7-4ff1-8f4d-b9328ce6f040")
// fmt.Println(task)
StartTask(id string) error
// StopTask stops a task.
//
// example:
// task, _ := sdk.StopTask("b1d10738-c5d7-4ff1-8f4d-b9328ce6f040")
// fmt.Println(task)
StopTask(id string) error
// CreateJob creates a new job with multiple tasks.
//
// example:
// req := sdk.JobRequest{
// Name: "my-job",
// Tasks: []sdk.Task{...},
// ExecutionMode: "parallel",
// }
// job, _ := sdk.CreateJob(req)
CreateJob(req JobRequest) (JobResponse, error)
// GetJob gets a job by id.
//
// example:
// job, _ := sdk.GetJob("b1d10738-c5d7-4ff1-8f4d-b9328ce6f040")
GetJob(jobID string) (JobResponse, error)
// ListJobs lists jobs.
//
// example:
// jobPage, _ := sdk.ListJobs(0, 10)
ListJobs(offset uint64, limit uint64) (JobPage, error)
// StartJob starts a job.
//
// example:
// _ := sdk.StartJob("b1d10738-c5d7-4ff1-8f4d-b9328ce6f040")
StartJob(jobID string) error
// StopJob stops a job.
//
// example:
// _ := sdk.StopJob("b1d10738-c5d7-4ff1-8f4d-b9328ce6f040")
StopJob(jobID string) error
// DeleteProplet deletes a proplet by id.
//
// example:
// err := sdk.DeleteProplet("b1d10738-c5d7-4ff1-8f4d-b9328ce6f040")
// fmt.Println(err)
DeleteProplet(id string) error
}
type Task ¶
type Task struct {
ID string `json:"id,omitempty"`
Name string `json:"name"`
Kind string `json:"kind,omitempty"`
State uint8 `json:"state,omitempty"`
Mode string `json:"mode,omitempty"`
ImageURL string `json:"image_url,omitempty"`
JobID string `json:"job_id,omitempty"`
CLIArgs []string `json:"cli_args,omitempty"`
Env map[string]string `json:"env,omitempty"`
StartTime time.Time `json:"start_time"`
FinishTime time.Time `json:"finish_time"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
Results any `json:"results,omitempty"`
}
Click to show internal directories.
Click to hide internal directories.