api

May 9, 2017

Changes in this version

+ type JobHealth struct

+ LastRun int64

+ Name string

+ NextRun int64

+ Paused bool

+ Status string

+ type JobsStatus map[string]JobHealth

+ func GetJobsStatus() (JobsStatus, error)

Mar 3, 2017

Changes in this version

type YesNo

+ func Opposite(yn YesNo) YesNo

Jul 25, 2016

Changes in this version

type JobFilter

+ ExactMatch YesNo

type RetentionPolicyFilter

+ ExactMatch YesNo

type ScheduleFilter

+ ExactMatch YesNo

type TargetFilter

+ ExactMatch YesNo

Jun 24, 2016

Changes in this version

+ func BasicAuthToken(user, password string) string

+ func LoadConfig(p string) error

+ type Config struct

+ Aliases map[string]string

+ Backend string

+ Backends map[string]string

+ Path string

+ var Cfg *Config

+ func (cfg *Config) AddBackend(be string, alias string) error

+ func (cfg *Config) BackendToken() string

+ func (cfg *Config) BackendURI() string

+ func (cfg *Config) ResolveAlias(be string) string

+ func (cfg *Config) Save() error

+ func (cfg *Config) SecureBackendURI() (string, error)

+ func (cfg *Config) UpdateBackend(be string, token string) error

+ func (cfg *Config) UpdateCurrentBackend(token string) error

+ func (cfg *Config) UseBackend(be string) error

type StoreFilter

+ ExactMatch YesNo

Feb 23, 2016

Changes in this version

type ArchiveFilter

+ Limit string

type Job

+ ScheduleWhen string

+ StoreName string

+ TargetName string

type JobFilter

+ Name string

+ type RetentionPolicyFilter struct

+ Name string

+ Unused YesNo

type ScheduleFilter

+ Name string

+ type Status struct

+ Name string

+ Version string

+ func GetStatus() (Status, error)

type StoreFilter

+ Name string

type TargetFilter

+ Name string

type TaskFilter

+ Limit string

Jan 8, 2016

Changes in this version

+ func CancelTask(id uuid.UUID) error

+ func DeleteArchive(id uuid.UUID) error

+ func DeleteJob(id uuid.UUID) error

+ func DeleteRetentionPolicy(id uuid.UUID) error

+ func DeleteSchedule(id uuid.UUID) error

+ func DeleteStore(id uuid.UUID) error

+ func DeleteTarget(id uuid.UUID) error

+ func IsPausedJob(id uuid.UUID) (bool, error)

+ func PauseJob(id uuid.UUID) error

+ func RestoreArchive(id uuid.UUID, targetJSON string) error

+ func RunJob(id uuid.UUID, ownerJSON string) error

+ func UnpauseJob(id uuid.UUID) error

+ type Archive struct

+ ExpiresAt Timestamp

+ Notes string

+ Status string

+ StoreEndpoint string

+ StoreKey string

+ StorePlugin string

+ StoreUUID string

+ TakenAt Timestamp

+ TargetEndpoint string

+ TargetPlugin string

+ TargetUUID string

+ UUID string

+ func GetArchive(id uuid.UUID) (Archive, error)

+ func GetArchives(filter ArchiveFilter) ([]Archive, error)

+ func UpdateArchive(id uuid.UUID, contentJSON string) (Archive, error)

+ type ArchiveFilter struct

+ After string

+ Before string

+ Status string

+ Store string

+ Target string

+ type Job struct

+ Agent string

+ Expiry int

+ Name string

+ Paused bool

+ RetentionName string

+ RetentionUUID string

+ Schedule string

+ ScheduleName string

+ ScheduleUUID string

+ StoreEndpoint string

+ StorePlugin string

+ StoreUUID string

+ Summary string

+ TargetEndpoint string

+ TargetPlugin string

+ TargetUUID string

+ UUID string

+ func CreateJob(contentJSON string) (Job, error)

+ func GetJob(id uuid.UUID) (Job, error)

+ func GetJobs(filter JobFilter) ([]Job, error)

+ func UpdateJob(id uuid.UUID, contentJSON string) (Job, error)

+ type JobFilter struct

+ Paused YesNo

+ Retention string

+ Schedule string

+ Store string

+ Target string

+ type RetentionPoliciesFilter struct

+ Unused YesNo

+ type RetentionPolicy struct

+ Expires uint

+ Name string

+ Summary string

+ UUID string

+ func CreateRetentionPolicy(contentJSON string) (RetentionPolicy, error)

+ func GetRetentionPolicies(filter RetentionPoliciesFilter) ([]RetentionPolicy, error)

+ func GetRetentionPolicy(id uuid.UUID) (RetentionPolicy, error)

+ func UpdateRetentionPolicy(id uuid.UUID, contentJSON string) (RetentionPolicy, error)

+ type Schedule struct

+ Name string

+ Summary string

+ UUID string

+ When string

+ func CreateSchedule(contentJSON string) (Schedule, error)

+ func GetSchedule(id uuid.UUID) (Schedule, error)

+ func GetSchedules(filter ScheduleFilter) ([]Schedule, error)

+ func UpdateSchedule(id uuid.UUID, contentJSON string) (Schedule, error)

+ type ScheduleFilter struct

+ Unused YesNo

+ type Store struct

+ Endpoint string

+ Name string

+ Plugin string

+ Summary string

+ UUID string

+ func CreateStore(contentJSON string) (Store, error)

+ func GetStore(id uuid.UUID) (Store, error)

+ func GetStores(filter StoreFilter) ([]Store, error)

+ func UpdateStore(id uuid.UUID, contentJSON string) (Store, error)

+ type StoreFilter struct

+ Plugin string

+ Unused YesNo

+ type Target struct

+ Agent string

+ Endpoint string

+ Name string

+ Plugin string

+ Summary string

+ UUID string

+ func CreateTarget(contentJSON string) (Target, error)

+ func GetTarget(id uuid.UUID) (Target, error)

+ func GetTargets(filter TargetFilter) ([]Target, error)

+ func UpdateTarget(id uuid.UUID, contentJSON string) (Target, error)

+ type TargetFilter struct

+ Plugin string

+ Unused YesNo

+ type Task struct

+ ArchiveUUID string

+ JobUUID string

+ Log string

+ Op string

+ Owner string

+ StartedAt Timestamp

+ Status string

+ StoppedAt Timestamp

+ TimeoutAt Timestamp

+ UUID string

+ func GetTask(id uuid.UUID) (Task, error)

+ func GetTasks(filter TaskFilter) ([]Task, error)

+ type TaskFilter struct

+ Debug YesNo

+ Status string

+ type URL struct

+ func ParseURL(s string) (*URL, error)

+ func ShieldURI(p string, args ...interface{}) *URL

+ func (u *URL) AddParameter(key string, value interface{}) error

+ func (u *URL) Delete(out interface{}) error

+ func (u *URL) Get(out interface{}) error

+ func (u *URL) MaybeAddParameter(key string, value interface{}) error

+ func (u *URL) Post(out interface{}, data string) error

+ func (u *URL) Put(out interface{}, data string) error

+ func (u *URL) Request(out interface{}, req *http.Request) error

+ func (u *URL) String() string

+ type YesNo struct

+ On bool

+ Yes bool

+ func Maybe(tf bool) YesNo

+ func MaybeBools(yes bool, no bool) YesNo

+ func MaybeString(tf string) YesNo

+ func No() YesNo

+ func Yes() YesNo

+ func (yn *YesNo) Given() bool