api

Documentation

Overview

Package api contains wrapper functions for communicating with the yFuzz API endpoints.

Index

• func CreateJob(image string) error
• func DeleteJob(job string) error
• func GetJobLogs(job string, tail int) error
• func GetJobStatus(job string) error
• func GetServerVersion() (string, error)
• func ListJobs() error

Functions

func CreateJob

func CreateJob(image string) error

CreateJob creates a yFuzz job from a link to a docker image. See https://godoc.org/github.com/yahoo/yfuzz/services/yfuzz-server/api#CreateJob

func DeleteJob

func DeleteJob(job string) error

DeleteJob deletes the given yFuzz job. See https://godoc.org/github.com/yahoo/yfuzz/services/yfuzz-server/api#DeleteJob

func GetJobLogs

func GetJobLogs(job string, tail int) error

GetJobLogs retrieves the logs of a given yFuzz job, truncated to a given number of lines. See https://godoc.org/github.com/yahoo/yfuzz/services/yfuzz-server/api#GetJobLogs

func GetJobStatus

func GetJobStatus(job string) error

GetJobStatus retrieves the status of a yFuzz job. See https://godoc.org/github.com/yahoo/yfuzz/services/yfuzz-server/api#GetJobStatus

func GetServerVersion

func GetServerVersion() (string, error)

GetServerVersion retrieves the version of the yFuzz server. See https://godoc.org/github.com/yahoo/yfuzz/services/yfuzz-server/api#GetVersion

func ListJobs

func ListJobs() error

ListJobs lists all of the existing yFuzz jobs. See https://godoc.org/github.com/yahoo/yfuzz/services/yfuzz-server/api#ListJobs