storage

Documentation

Index

• Variables
• type AppService
• type Item
• type List
• type ListOptions
• type ServerError
  • func (s *ServerError) Error() string

Variables

var ErrAccessDenied = errors.New("access denied")

ErrAccessDenied is returned when the service denies access. Either due to insufficient rights or wrong credentials.

var ErrFileNotFound = errors.New("file not found")

ErrFileNotFound is returned when the requested file does not exist.

var ErrTooManyRequest = errors.New("too many requests, please try again later")

ErrTooManyRequest is returned when the request number is exceeding rate limit.

Types

type AppService

type AppService interface {
	// Deprecated: Use UploadStream.
	Upload(name, description string) (Item, error)
	// UploadStream uploads the contents of reader and stores them under the given filename.
	UploadStream(filename, description string, reader io.Reader) (Item, error)
	Download(id string) (io.ReadCloser, int64, error)
	// Deprecated: Use List instead.
	Find(name string) (Item, error)
	List(opts ListOptions) (List, error)
}

AppService is the interface for interacting with the Sauce application storage.

type Item

type Item struct {
	ID       string    `json:"id"`
	Name     string    `json:"name"`
	Size     int       `json:"size"`
	Uploaded time.Time `json:"uploaded"`
}

Item represents the file in storage.

type List

type List struct {
	Items     []Item `json:"items"`
	Truncated bool   `json:"truncated"`
}

type ListOptions

type ListOptions struct {
	// Q is any search term (such as app name, file name, description, build number or version) by which you want to filter.
	Q string

	// Name is the filename (case-insensitive) by which you want to filter.
	Name string

	// SHA256 is the checksum of the file by which you want to filter.
	SHA256 string

	// Limits the number of results returned.
	MaxResults int
}

ListOptions represents parameters that modify the file list behavior.

type ServerError

type ServerError struct {
	Code  int
	Title string
	Msg   string
}

ServerError represents any server side error that isn't already covered by other types of errors in this package.

func (*ServerError) Error

func (s *ServerError) Error() string