resto

Documentation

Index

• Variables
• type Client
  • func New(url, username, accessKey string, timeout time.Duration) Client
  • func (c *Client) DownloadArtifact(jobID string)
  • func (c *Client) GetJobAssetFileContent(ctx context.Context, jobID, fileName string) ([]byte, error)
  • func (c *Client) GetJobAssetFileNames(ctx context.Context, jobID string) ([]string, error)
  • func (c *Client) GetVirtualDevices(ctx context.Context, kind string) ([]vmd.VirtualDevice, error)
  • func (c *Client) IsTunnelRunning(ctx context.Context, id, owner string, wait time.Duration) error
  • func (c *Client) PollJob(ctx context.Context, id string, interval, timeout time.Duration) (j job.Job, err error)
  • func (c *Client) ReadAllowedCCY(ctx context.Context) (int, error)
  • func (c *Client) ReadJob(ctx context.Context, id string) (job.Job, error)
  • func (c *Client) StopJob(ctx context.Context, id string) (job.Job, error)

Variables

var (
	// ErrServerError is returned when the server was not able to correctly handle our request (status code >= 500).
	ErrServerError = errors.New("internal server error")
	// ErrJobNotFound is returned when the requested job was not found.
	ErrJobNotFound = errors.New("job was not found")
	// ErrTunnelNotFound is returned when the requested tunnel was not found.
	ErrTunnelNotFound = errors.New("tunnel not found")
)

Types

type Client

type Client struct {
	HTTPClient     *http.Client
	URL            string
	Username       string
	AccessKey      string
	ArtifactConfig config.ArtifactDownload
}

Client http client.

func New

func New(url, username, accessKey string, timeout time.Duration) Client

New creates a new client.

func (*Client) DownloadArtifact

func (c *Client) DownloadArtifact(jobID string)

DownloadArtifact does downloading artifacts

func (*Client) GetJobAssetFileContent

func (c *Client) GetJobAssetFileContent(ctx context.Context, jobID, fileName string) ([]byte, error)

GetJobAssetFileContent returns the job asset file content.

func (*Client) GetJobAssetFileNames

func (c *Client) GetJobAssetFileNames(ctx context.Context, jobID string) ([]string, error)

GetJobAssetFileNames return the job assets list.

func (*Client) GetVirtualDevices

func (c *Client) GetVirtualDevices(ctx context.Context, kind string) ([]vmd.VirtualDevice, error)

GetVirtualDevices returns the list of available virtual devices.

func (*Client) IsTunnelRunning

func (c *Client) IsTunnelRunning(ctx context.Context, id, owner string, wait time.Duration) error

IsTunnelRunning checks whether tunnelID is running. If not, it will wait for the tunnel to become available or timeout. Whichever comes first.

func (*Client) PollJob

func (c *Client) PollJob(ctx context.Context, id string, interval, timeout time.Duration) (j job.Job, err error)

PollJob polls job details at an interval, until timeout has been reached or until the job has ended, whether successfully or due to an error.

func (*Client) ReadAllowedCCY

func (c *Client) ReadAllowedCCY(ctx context.Context) (int, error)

ReadAllowedCCY returns the allowed (max) concurrency for the current account.

func (*Client) ReadJob

func (c *Client) ReadJob(ctx context.Context, id string) (job.Job, error)

ReadJob returns the job details.

func (*Client) StopJob

func (c *Client) StopJob(ctx context.Context, id string) (job.Job, error)

StopJob stops the job on the Sauce Cloud.