helpers

Documentation

Overview

Package helpers provide useful wrappers for clients using the lakeFS OpenAPI.

Index

• Variables
• func ClientUpload(ctx context.Context, client apigen.ClientWithResponsesInterface, ...) (*apigen.ObjectStats, error)
• func ClientUploadPreSign(ctx context.Context, client apigen.ClientWithResponsesInterface, ...) (*apigen.ObjectStats, error)
• func HTTPResponseAsError(httpResponse *http.Response) error
• func ResponseAsError(response interface{}) error
• type APIFields
• type CallFailedError
  • func (e CallFailedError) Error() string
  • func (e CallFailedError) Unwrap() error
• type UserVisibleAPIError
  • func (e UserVisibleAPIError) Error() string
  • func (e UserVisibleAPIError) Unwrap() error

Variables

var (
	// ErrUnsupportedProtocol is the error returned when lakeFS server requests the client
	// use a protocol it does not know about.  Until recompiled to use a newer client,
	// upload the object using through the lakeFS server.
	ErrUnsupportedProtocol = errors.New("unsupported protocol")

	// ErrRequestFailed is an error returned for failing lakeFS server replies.
	ErrRequestFailed = errors.New("request failed")
	ErrConflict      = errors.New("conflict")
)

Functions

func ClientUpload

func ClientUpload(ctx context.Context, client apigen.ClientWithResponsesInterface, repoID, branchID, objPath string, metadata map[string]string, contentType string, contents io.ReadSeeker) (*apigen.ObjectStats, error)

ClientUpload uploads contents as a file via lakeFS

func ClientUploadPreSign

func ClientUploadPreSign(ctx context.Context, client apigen.ClientWithResponsesInterface, repoID, branchID, objPath string, metadata map[string]string, contentType string, contents io.ReadSeeker) (*apigen.ObjectStats, error)

func HTTPResponseAsError

func HTTPResponseAsError(httpResponse *http.Response) error

func ResponseAsError

func ResponseAsError(response interface{}) error

ResponseAsError returns a UserVisibleAPIError wrapping an ErrRequestFailed wrapping a response from the server. It searches for a non-nil unsuccessful HTTPResponse field and uses its message, along with a Body that it assumes is an api.Error.

Types

type APIFields

type APIFields struct {
	StatusCode int
	Status     string
	Message    string
}

APIFields are fields to use to format an HTTP error response that can be shown to the user.

type CallFailedError

type CallFailedError struct {
	Err     error
	Message string
}

CallFailedError is an error performing the HTTP request itself formatted to be shown to a user. It does _not_ update its message when wrapped so usually should not be wrapped.

func (CallFailedError) Error

func (e CallFailedError) Error() string

func (CallFailedError) Unwrap

func (e CallFailedError) Unwrap() error

type UserVisibleAPIError

type UserVisibleAPIError struct {
	APIFields
	Err error
}

UserVisibleAPIError is an HTTP error response formatted to be shown to a user. It does _not_ update its message when wrapped so usually should not be wrapped.

func (UserVisibleAPIError) Error

func (e UserVisibleAPIError) Error() string

func (UserVisibleAPIError) Unwrap

func (e UserVisibleAPIError) Unwrap() error