api

Documentation

Index

• Constants
• type CreateTaskInput
• type CreateTaskOutput
• type DescribeTasksInput
• type DescribeTasksOutput
• type EvictTasksInput
• type EvictTasksOutput
• type TaskDescription
• type TaskProgress
• type TaskStore
• type UpdateTaskInput
• type UpdateTaskOutput

Constants

const StatusFailure = "failure"

const StatusPending = "pending"

const StatusRunning = "running"

const StatusSuccess = "success"

Types

type CreateTaskInput

type CreateTaskInput struct {
	ParentID *string `json:"parentId"`
	Name     string  `json:"name"`
}

type CreateTaskOutput

type CreateTaskOutput struct {
	ID    string `json:"id"`
	JobID string `json:"jobId"`
}

type DescribeTasksInput

type DescribeTasksInput struct {

	// If supplied, filters tasks by job.
	JobIDs []string `json:"jobIds"`
}

type DescribeTasksOutput

type DescribeTasksOutput struct {
	Tasks []TaskDescription `json:"tasks"`
}

type EvictTasksInput

type EvictTasksInput struct {
}

type EvictTasksOutput

type EvictTasksOutput struct {
}

type TaskDescription

type TaskDescription struct {
	ID string `json:"id"`
	// ID of root task in this tree.
	JobID    string        `json:"jobId"`
	ParentID *string       `json:"parentId"`
	Name     string        `json:"name"`
	Status   string        `json:"status"`
	Message  string        `json:"message"`
	Created  string        `json:"created"`
	Updated  string        `json:"updated"`
	Started  *string       `json:"started"`
	Finished *string       `json:"finished"`
	Progress *TaskProgress `json:"progress"`
}

type TaskProgress

type TaskProgress struct {
	Current int `json:"current"`
	Total   int `json:"total"`
}

type TaskStore

type TaskStore interface {
	DescribeTasks(context.Context, *DescribeTasksInput) (*DescribeTasksOutput, error)
	CreateTask(context.Context, *CreateTaskInput) (*CreateTaskOutput, error)
	UpdateTask(context.Context, *UpdateTaskInput) (*UpdateTaskOutput, error)
	EvictTasks(context.Context, *EvictTasksInput) (*EvictTasksOutput, error)
}

type UpdateTaskInput

type UpdateTaskInput struct {
	ID       string        `json:"id"`
	Status   *string       `json:"status"`
	Message  *string       `json:"message"`
	Started  *string       `json:"started"`
	Finished *string       `json:"finished"`
	Progress *TaskProgress `json:"progress"`
}

type UpdateTaskOutput

type UpdateTaskOutput struct {
}