tasks

Documentation

Index

• type Client
  • func (c *Client) ExpandPath(path string) string
  • func (c *Client) GetTaskStatus(ctx context.Context, upid string) (*GetTaskStatusResponseData, error)
  • func (c *Client) WaitForTask(ctx context.Context, upid string, timeoutSec, delaySec int) error
• type GetTaskStatusResponseBody
• type GetTaskStatusResponseData

Types

type Client

type Client struct {
	api.Client
}

Client is an interface for performing requests against the Proxmox 'tasks' API.

func (*Client) ExpandPath

func (c *Client) ExpandPath(path string) string

ExpandPath expands a path relative to the client's base path.

func (*Client) GetTaskStatus

func (c *Client) GetTaskStatus(ctx context.Context, upid string) (*GetTaskStatusResponseData, error)

GetTaskStatus retrieves the status of a task.

func (*Client) WaitForTask

func (c *Client) WaitForTask(ctx context.Context, upid string, timeoutSec, delaySec int) error

WaitForTask waits for a specific task to complete.

type GetTaskStatusResponseBody

type GetTaskStatusResponseBody struct {
	Data *GetTaskStatusResponseData `json:"data,omitempty"`
}

GetTaskStatusResponseBody contains the body from a node get task status response.

type GetTaskStatusResponseData

type GetTaskStatusResponseData struct {
	PID      int    `json:"pid,omitempty"`
	Status   string `json:"status,omitempty"`
	ExitCode string `json:"exitstatus,omitempty"`
}

GetTaskStatusResponseData contains the data from a node get task status response.