kv

Documentation

Index

• Variables
• func ParseURLGRPC(s string) (string, bool, error)
• type Client
  • func NewClient(p NewClientParams) (*Client, error)
  • func (c *Client) ChangeSession(invocationID string, appSlug string, buildSlug string, stepSlug string)
  • func (c *Client) Delete(ctx context.Context, name string) error
  • func (c *Client) DownloadFile(ctx context.Context, filePath, key string, fileMode os.FileMode, ...) (bool, error)
  • func (c *Client) DownloadFileFromBuildCache(ctx context.Context, fileName, key string) error
  • func (c *Client) DownloadFileGroupFromBuildCache(ctx context.Context, dd filegroup.Info, ...) (DownloadFilesStats, error)
  • func (c *Client) DownloadStream(ctx context.Context, destination io.Writer, key string) error
  • func (c *Client) DownloadStreamFromBuildCache(ctx context.Context, destination io.Writer, key string) error
  • func (c *Client) FindMissing(ctx context.Context, digests []*FileDigest) ([]*FileDigest, error)
  • func (c *Client) GetCapabilities(ctx context.Context) error
  • func (c *Client) GetCapabilitiesWithRetry(ctx context.Context) error
  • func (c *Client) SetLogger(logger log.Logger)
  • func (c *Client) UploadFileGroupToBuildCache(ctx context.Context, dd filegroup.Info) (UploadFilesStats, error)
  • func (c *Client) UploadFileToBuildCache(ctx context.Context, filePath, key string) error
  • func (c *Client) UploadStreamToBuildCache(ctx context.Context, source io.Reader, key string, size int64) error
• type DownloadFilesStats
• type FileDigest
• type NewClientParams
• type PutParams
• type UploadFilesStats

Variables

var (
	// ErrCacheNotFound ...
	ErrCacheNotFound        = errors.New("no cache archive found for the provided keys")
	ErrCacheUnauthenticated = errors.New("unauthenticated")
)

var ErrFileExistsAndNotWritable = errors.New("file already exists and is not writable")

ErrFileExistsAndNotWritable ...

Functions

func ParseURLGRPC

func ParseURLGRPC(s string) (string, bool, error)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(p NewClientParams) (*Client, error)

func (*Client) ChangeSession

func (c *Client) ChangeSession(invocationID string, appSlug string, buildSlug string, stepSlug string)

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, name string) error

func (*Client) DownloadFile

func (c *Client) DownloadFile(ctx context.Context, filePath, key string, fileMode os.FileMode, isDebugLogMode, skipExisting, forceOverwrite bool) (bool, error)

nolint: nestif

func (*Client) DownloadFileFromBuildCache

func (c *Client) DownloadFileFromBuildCache(ctx context.Context, fileName, key string) error

func (*Client) DownloadFileGroupFromBuildCache

func (c *Client) DownloadFileGroupFromBuildCache(ctx context.Context, dd filegroup.Info,
	isDebugLogMode, skipExisting, forceOverwrite bool, maxLoggedDownloadErrors int,
) (DownloadFilesStats, error)

nolint: gocognit

func (*Client) DownloadStream

func (c *Client) DownloadStream(ctx context.Context, destination io.Writer, key string) error

func (*Client) DownloadStreamFromBuildCache

func (c *Client) DownloadStreamFromBuildCache(ctx context.Context, destination io.Writer, key string) error

func (*Client) FindMissing

func (c *Client) FindMissing(ctx context.Context, digests []*FileDigest) ([]*FileDigest, error)

func (*Client) GetCapabilities

func (c *Client) GetCapabilities(ctx context.Context) error

func (*Client) GetCapabilitiesWithRetry

func (c *Client) GetCapabilitiesWithRetry(ctx context.Context) error

func (*Client) SetLogger

func (c *Client) SetLogger(logger log.Logger)

func (*Client) UploadFileGroupToBuildCache

func (c *Client) UploadFileGroupToBuildCache(ctx context.Context, dd filegroup.Info) (UploadFilesStats, error)

func (*Client) UploadFileToBuildCache

func (c *Client) UploadFileToBuildCache(ctx context.Context, filePath, key string) error

func (*Client) UploadStreamToBuildCache

func (c *Client) UploadStreamToBuildCache(ctx context.Context, source io.Reader, key string, size int64) error

type DownloadFilesStats

type DownloadFilesStats struct {
	FilesToBeDownloaded   int
	FilesDownloaded       int
	FilesMissing          int
	FilesFailedToDownload int
	DownloadSize          int64
	LargestFileSize       int64
}

type FileDigest

type FileDigest struct {
	Sha256Sum   string
	SizeInBytes int64
}

type NewClientParams

type NewClientParams struct {
	UseInsecure         bool
	Host                string
	DialTimeout         time.Duration
	ClientName          string
	AuthConfig          common.CacheAuthConfig
	CacheConfigMetadata common.CacheConfigMetadata
	Logger              log.Logger
	CacheOperationID    string
	BitriseKVClient     kv_storage.KVStorageClient
	CapabilitiesClient  remoteexecution.CapabilitiesClient
	InvocationID        string
	DownloadRetry       uint
	DownloadRetryWait   time.Duration
	UploadRetry         uint
	UploadRetryWait     time.Duration
}

type PutParams

type PutParams struct {
	Name      string
	Sha256Sum string
	FileSize  int64
}

type UploadFilesStats

type UploadFilesStats struct {
	FilesToUpload       int
	FilesUploaded       int
	FilesFailedToUpload int
	TotalFiles          int
	UploadSize          int64
	LargestFileSize     int64
}