error

Documentation

Index

• type ErrorCode
• type ErrorResult
  • func CreateBadInputParameterError(parameter, value, explanation string) *ErrorResult
  • func CreateMissingInputParameterError(parameter string) *ErrorResult
  • func CreateSourceConnectionError(url, message string) *ErrorResult
  • func ToErrorResult(err error) *ErrorResult
  • func (e ErrorResult) Error() string

Types

type ErrorCode

type ErrorCode int

const (
	NoError ErrorCode = iota
	UnknownError
	BadInputParameterError
	MissingInputParameterError
	SourceConnectionError
)

type ErrorResult

type ErrorResult struct {
	ErrorMessage string
	ErrorCode    ErrorCode
}

ErrorResult represents an error returned by an API call.

func CreateBadInputParameterError

func CreateBadInputParameterError(parameter, value, explanation string) *ErrorResult

CreateBadInputParameterError is a helper method to create a consistent error result across plugins when an input parameter has an unexpected format.

func CreateMissingInputParameterError

func CreateMissingInputParameterError(parameter string) *ErrorResult

CreateMissingInputParameterError is a helper method to create a consistent error result across plugins when a mandatory parameter is missing.

func CreateSourceConnectionError

func CreateSourceConnectionError(url, message string) *ErrorResult

CreateSourceConnectionError is a helper method to create a consistent error result across plugins when there is a connection problem to the data source or identity store.

func ToErrorResult

func ToErrorResult(err error) *ErrorResult

ToErrorResult is a helper method to to create an ErrorResult from an error. If the error already is of type ErrorResult, the original is returned.

func (ErrorResult) Error

func (e ErrorResult) Error() string