tasks

Documentation

Index

• Constants
• type Client
  • func New(c HTTPClient) *Client
  • func (c *Client) Delete(ctx context.Context, req DeleteRequest) error
  • func (c *Client) Find(ctx context.Context, req FindRequest) ([]map[string]interface{}, error)
  • func (c *Client) Index(ctx context.Context, req IndexRequest) ([]IndexResponse, error)
  • func (c *Client) ReadTaskLog(ctx context.Context, req ReadTaskLogRequest) ([]ReadTaskLogResponse, error)
  • func (c *Client) ReadTaskStatus(ctx context.Context, req ReadTaskStatusRequest) (ReadTaskStatusResponse, error)
• type DeleteRequest
• type FindRequest
• type HTTPClient
• type IndexRequest
• type IndexResponse
• type ReadTaskLogRequest
• type ReadTaskLogResponse
• type ReadTaskStatusRequest
• type ReadTaskStatusResponse
• type Source
  • func PtrSource(i Source) *Source
• type Status
  • func PtrStatus(i Status) *Status

Constants

const (
	Source_ARCHIVE Source = "archive"
	Source_ACTIVE  Source = "active"
	Source_ALL     Source = "all"

	Status_RUNNING Status = "running"
	Status_STOPPED Status = "stopped"
)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func New

func New(c HTTPClient) *Client

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, req DeleteRequest) error

Delete Stop a task.

func (*Client) Find

func (c *Client) Find(ctx context.Context, req FindRequest) ([]map[string]interface{}, error)

Find

func (*Client) Index

func (c *Client) Index(ctx context.Context, req IndexRequest) ([]IndexResponse, error)

Index Read task list for one node (finished tasks).

func (*Client) ReadTaskLog

func (c *Client) ReadTaskLog(ctx context.Context, req ReadTaskLogRequest) ([]ReadTaskLogResponse, error)

ReadTaskLog Read task log.

func (*Client) ReadTaskStatus

func (c *Client) ReadTaskStatus(ctx context.Context, req ReadTaskStatusRequest) (ReadTaskStatusResponse, error)

ReadTaskStatus Read task status.

type DeleteRequest

type DeleteRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.
	Upid string `url:"upid" json:"upid"`
}

type FindRequest

type FindRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.
	Upid string `url:"upid" json:"upid"`
}

type HTTPClient

type HTTPClient interface {
	Do(context.Context, string, string, interface{}, interface{}) error
}

type IndexRequest

type IndexRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.

	// The following parameters are optional
	Errors       *util.PVEBool `url:"errors,omitempty" json:"errors,omitempty"`             // Only list tasks with a status of ERROR.
	Limit        *int          `url:"limit,omitempty" json:"limit,omitempty"`               // Only list this amount of tasks.
	Since        *int          `url:"since,omitempty" json:"since,omitempty"`               // Only list tasks since this UNIX epoch.
	Source       *Source       `url:"source,omitempty" json:"source,omitempty"`             // List archived, active or all tasks.
	Start        *int          `url:"start,omitempty" json:"start,omitempty"`               // List tasks beginning from this offset.
	Statusfilter *string       `url:"statusfilter,omitempty" json:"statusfilter,omitempty"` // List of Task States that should be returned.
	Typefilter   *string       `url:"typefilter,omitempty" json:"typefilter,omitempty"`     // Only list tasks of this type (e.g., vzstart, vzdump).
	Until        *int          `url:"until,omitempty" json:"until,omitempty"`               // Only list tasks until this UNIX epoch.
	Userfilter   *string       `url:"userfilter,omitempty" json:"userfilter,omitempty"`     // Only list tasks from this user.
	Vmid         *int          `url:"vmid,omitempty" json:"vmid,omitempty"`                 // Only list tasks for this VM.
}

type IndexResponse

type IndexResponse struct {
	Id        string `url:"id" json:"id"`
	Node      string `url:"node" json:"node"`
	Pid       int    `url:"pid" json:"pid"`
	Pstart    int    `url:"pstart" json:"pstart"`
	Starttime int    `url:"starttime" json:"starttime"`
	Type      string `url:"type" json:"type"`
	Upid      string `url:"upid" json:"upid"`
	User      string `url:"user" json:"user"`

	// The following parameters are optional
	Endtime *int    `url:"endtime,omitempty" json:"endtime,omitempty"`
	Status  *string `url:"status,omitempty" json:"status,omitempty"`
}

type ReadTaskLogRequest

type ReadTaskLogRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.
	Upid string `url:"upid" json:"upid"` // The task's unique ID.

	// The following parameters are optional
	Download *util.PVEBool `url:"download,omitempty" json:"download,omitempty"` // Whether the tasklog file should be downloaded. This parameter can't be used in conjunction with other parameters
	Limit    *int          `url:"limit,omitempty" json:"limit,omitempty"`       // The amount of lines to read from the tasklog.
	Start    *int          `url:"start,omitempty" json:"start,omitempty"`       // Start at this line when reading the tasklog
}

type ReadTaskLogResponse

type ReadTaskLogResponse struct {
	N int    `url:"n" json:"n"` // Line number
	T string `url:"t" json:"t"` // Line text

}

type ReadTaskStatusRequest

type ReadTaskStatusRequest struct {
	Node string `url:"node" json:"node"` // The cluster node name.
	Upid string `url:"upid" json:"upid"` // The task's unique ID.

}

type ReadTaskStatusResponse

type ReadTaskStatusResponse struct {
	Id        string  `url:"id" json:"id"`
	Node      string  `url:"node" json:"node"`
	Pid       int     `url:"pid" json:"pid"`
	Starttime float64 `url:"starttime" json:"starttime"`
	Status    Status  `url:"status" json:"status"`
	Type      string  `url:"type" json:"type"`
	Upid      string  `url:"upid" json:"upid"`
	User      string  `url:"user" json:"user"`

	// The following parameters are optional
	Exitstatus *string `url:"exitstatus,omitempty" json:"exitstatus,omitempty"`
}

type Source

type Source string

func PtrSource

func PtrSource(i Source) *Source

type Status

type Status string

func PtrStatus

func PtrStatus(i Status) *Status