resto

Documentation

Index

• Variables
• type Client
  • func New(url, username, accessKey string, timeout time.Duration) Client
  • func (c *Client) GetJobAssetFileContent(ctx context.Context, jobID, fileName string) ([]byte, error)
  • func (c *Client) IsTunnelRunning(ctx context.Context, id string, wait time.Duration) error
  • func (c *Client) PollJob(ctx context.Context, id string, interval time.Duration) (job.Job, 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
}

Client http client.

func New

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

New creates a new client.

func (*Client) GetJobAssetFileContent

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

GetJobAssetFileContent returns the job asset file content.

func (*Client) IsTunnelRunning

func (c *Client) IsTunnelRunning(ctx context.Context, id 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 time.Duration) (job.Job, error)

PollJob polls job details at an interval, 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.