Class: Tasker::Types::StepTemplate

Inherits:

Dry::Struct

• Object
• Dry::Struct
• Tasker::Types::StepTemplate

Defined in:

lib/tasker/types/step_template.rb

Overview

StepTemplate defines the structure for workflow step templates

A step template provides the blueprint for creating specific workflow steps in a task’s sequence. It defines the behavior, dependencies, and configuration for steps of a particular type.

Instance Attribute Summary

• #custom_events ⇒ Array<Hash> readonly

  Custom events that this step handler can publish.

• #default_retry_limit ⇒ Integer readonly

  The default maximum number of retry attempts.

• #default_retryable ⇒ Boolean readonly

  Whether this step can be retried by default.

• #dependent_system ⇒ String readonly

  The system that this step depends on for execution.

• #depends_on_step ⇒ String^? readonly

  Optional name of a step that must be completed before this one.

• #depends_on_steps ⇒ Array<String> readonly

  Names of steps that must be completed before this one.

• #description ⇒ String readonly

  A human-readable description of what this step does.

• #handler_class ⇒ Class readonly

  The class that implements the step’s logic.

• #handler_config ⇒ Object^? readonly

  Optional configuration for the step handler.

• #name ⇒ String readonly

  The name identifier for this step template.

• #skippable ⇒ Boolean readonly

  Whether this step can be skipped in the workflow.

Instance Method Summary

• #all_dependencies ⇒ Array<String>

  Returns all dependency step names as a single array.

Instance Attribute Details

#custom_events ⇒ Array<Hash> (readonly)

# File 'lib/tasker/types/step_template.rb', line 53

attribute :custom_events, Types.Array(Types::Hash).optional.default([].freeze)

#default_retry_limit ⇒ Integer (readonly)

# File 'lib/tasker/types/step_template.rb', line 29

attribute :default_retry_limit, Types::Integer.default(3)

#default_retryable ⇒ Boolean (readonly)

# File 'lib/tasker/types/step_template.rb', line 25

attribute :default_retryable, Types::Bool.default(true)

#dependent_system ⇒ String (readonly)

# File 'lib/tasker/types/step_template.rb', line 13

attribute :dependent_system, Types::Strict::String

#depends_on_step ⇒ String^? (readonly)

# File 'lib/tasker/types/step_template.rb', line 45

attribute :depends_on_step, Types::String.optional.default(nil)

#depends_on_steps ⇒ Array<String> (readonly)

# File 'lib/tasker/types/step_template.rb', line 49

attribute :depends_on_steps, Types.Array(Types::String).default([].freeze)

#description ⇒ String (readonly)

# File 'lib/tasker/types/step_template.rb', line 21

attribute :description, Types::String

#handler_class ⇒ Class (readonly)

# File 'lib/tasker/types/step_template.rb', line 37

attribute :handler_class, Types::Class

#handler_config ⇒ Object^? (readonly)

# File 'lib/tasker/types/step_template.rb', line 41

attribute :handler_config, Types::Any.optional.default(nil)

#name ⇒ String (readonly)

# File 'lib/tasker/types/step_template.rb', line 17

attribute :name, Types::Strict::String

#skippable ⇒ Boolean (readonly)

# File 'lib/tasker/types/step_template.rb', line 33

attribute :skippable, Types::Bool.default(false)

Instance Method Details

#all_dependencies ⇒ Array<String>

Returns all dependency step names as a single array

# File 'lib/tasker/types/step_template.rb', line 58

def all_dependencies
  [depends_on_step, *depends_on_steps].compact.uniq
end