Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Assignment ¶
type Assignment struct {
plans.Mountpoint
KnitId string `json:"knitId"`
}
func (Assignment) Equal ¶
func (a Assignment) Equal(o Assignment) bool
type Detail ¶
type Detail struct {
Summary
// Inputs are pairs of input mountpoints and inputted Data of the Run.
Inputs []Assignment `json:"inputs"`
// Outputs are pairs of output mountpoints and outputted Data of the Run.
Outputs []Assignment `json:"outputs"`
// Log is the log point of the Run.
Log *LogSummary `json:"log"`
}
Detail is the format for response body from WebAPIs below:
- GET /api/runs/[?...] (as list)
- GET /api/runs/{runId}
- GET /api/runs/{runId}
- PUT /api/runs/{runId}/abort
- PUT /api/runs/{runId}/tearoff
- PUT /api/runs/{runId}/retry
Other Run related WebAPI do not use this for response.
- GET /api/runs/{runId}/log: text stream (Content-Type: text/plain)
- DELETE /api/runs/{runId}: empty response ("204 No Content" on success)
type LogSummary ¶
func (LogSummary) Equal ¶
func (l LogSummary) Equal(o LogSummary) bool
type Summary ¶
type Summary struct {
// RunId is the id of the Run.
RunId string `json:"runId"`
// Status is the status of the Run.
//
// This is one of:
//
// - "deactivated": This Run is deactivated. It is not going to be running.
//
// - "waiting": This Run is waiting to be running.
//
// - "ready": This Run is ready to be running. It is waiting for the worker starts.
//
// - "starting": This Run is pulling images, or preparing the environment.
// The Worker for the Run can be running because of the interval of the periodical health check.
//
// - "running": This Run's Worker is running.
//
// - "completing": It is observed that the run's worker has stopped successfully.
//
// - "aborting": It is observed, or should be done that the run's worker has stopped insuccessfully.
//
// - "done": This Run has been finished, successfuly.
// The Run's output can be used by other Runs.
//
// - "failed": This Run has been finished with error.
//
// - "invalidated": This run was discarded
Status string `json:"status"`
// UpdatedAt is the time of the last update of the Run.
UpdatedAt rfctime.RFC3339 `json:"updatedAt"`
// Exit is the exit status of the Run.
//
// This is nil if the Run is not finished.
Exit *Exit `json:"exit,omitempty"`
// Plan which the Run is created from.
Plan plans.Summary `json:"plan"`
}
Click to show internal directories.
Click to hide internal directories.