commonnetbackup

Documentation

Index

• func ToError(err *APIError) error
• type APIError
• type JobAPIResponse
  • func (j *JobAPIResponse) IsDone() bool
  • func (j *JobAPIResponse) Refresh() error
  • func (j *JobAPIResponse) Wait(refreshInterval, timeout int) error
• type JobStatus

Functions

func ToError

func ToError(err *APIError) error

Convert to Error.

Types

type APIError

type APIError []struct {
	PropertyName string `json:"PropertyName"`
	Message      string `json:"Message"`
}

type JobAPIResponse

type JobAPIResponse struct {
	Data struct {
		ID     int    `json:"Id,omitempty"`
		Status string `json:"Status,omitempty"`
	} `json:"data,omitempty"`
}

JobAPIResponse is the response structure for the Job API.

func (*JobAPIResponse) IsDone

func (j *JobAPIResponse) IsDone() bool

IsDone - Returns true if the job is done with a success.

func (*JobAPIResponse) Refresh

func (j *JobAPIResponse) Refresh() error

Refresh - Refreshes the job status.

func (*JobAPIResponse) Wait

func (j *JobAPIResponse) Wait(refreshInterval, timeout int) error

Wait - Waits for the job to be done refreshInterval - The interval in seconds between each refresh timeout - The timeout in seconds.

type JobStatus

type JobStatus string

const (
	JobStatusCompleted JobStatus = "Completed"
	JobStatusFailed    JobStatus = "Failed"
	JobStatusRunning   JobStatus = "Running"
	JobStatusPending   JobStatus = "Pending"
)