Exception: Pipeline::RecoverableError

Inherits:
StandardError
  • Object
show all
Defined in:
lib/pipeline/errors.rb

Overview

Exception to represent a recoverable error that can be raised by subclasses of Pipeline::Stage::Base that override the method run. Please refer to Pipeline::Base for more details about error handling.

Instance Method Summary collapse

Constructor Details

#initialize(msg = nil, input_required = false) ⇒ RecoverableError

Instantiates a new instance of RecoverableError.

msg

Is a description of the error message

input_required

Is a boolean that determines if the error requires user action (true, meaning it can not be automatically retried) or not (false, meaning it can be automatically retried). Default is false



30
31
32
33
 
# File 'lib/pipeline/errors.rb', line 30

def initialize(msg = nil, input_required = false)
  super(msg)
  @input_required = input_required
end

Instance Method Details

#input_required? ⇒ Boolean

Returns true if this error requires user action or false otherwise.

Returns:

  • (Boolean) 


36
37
38
 
# File 'lib/pipeline/errors.rb', line 36

def input_required?
  @input_required
end