errors

Documentation

Index

• func GetRetryAtTime(err error) *time.Time
• func IsNoRetryError(err error) bool
• func IsStepError(err error) bool
• func NoRetryError(err error) error
• func RetryAtError(err error, at time.Time) error
• type StepError
  • func (e StepError) Error() string
  • func (e StepError) Is(err error) bool

Functions

func GetRetryAtTime

func GetRetryAtTime(err error) *time.Time

GetRetryAtTime returns the time from a retryAtError, or nil.

func IsNoRetryError

func IsNoRetryError(err error) bool

IsNoRetryError returns whether an error is a NoRetryError

func IsStepError

func IsStepError(err error) bool

func NoRetryError

func NoRetryError(err error) error

NoRetryError wraps an error, preventing retries in the SDK. This permanently fails a step and function.

func RetryAtError

func RetryAtError(err error, at time.Time) error

RetryAtError allows you to specify the time at which the next retry should occur. This wraps your error, leaving the original cause and error message available.

Types

type StepError

type StepError struct {
	Name    string `json:"name"`
	Message string `json:"message"`
	// Data is the data from state.UserError, used to store
	// the resulting value when step errors occur with an additional
	// response type.
	Data json.RawMessage `json:"data,omitempty"`
}

StepError is an error returned when a step permanently fails

func (StepError) Error

func (e StepError) Error() string

func (StepError) Is

func (e StepError) Is(err error) bool