Class: Tasker::Types::TaskRequest

Inherits:

Dry::Struct

• Object
• Dry::Struct
• Tasker::Types::TaskRequest

Defined in:

lib/tasker/types/task_request.rb

Overview

TaskRequest represents a request to perform a task within the system

It contains all the necessary information to identify, track, and execute a task including context data, metadata, and configuration for the task execution.

Instance Attribute Summary

• #bypass_steps ⇒ Array<String> readonly

  List of step names that should be bypassed during task execution.

• #complete ⇒ Boolean readonly

  Indicates whether the task has been completed.

• #context ⇒ Hash readonly

  Context data required for task execution, containing task-specific information.

• #initiator ⇒ String readonly

  The entity or system that initiated this task request.

• #name ⇒ String readonly

  The name of the task to be performed.

• #namespace ⇒ String readonly

  The namespace of the task to be performed.

• #reason ⇒ String readonly

  The reason why this task was requested.

• #requested_at ⇒ Time readonly

  Timestamp when the task was initially requested.

• #source_system ⇒ String readonly

  The system from which this task originated.

• #status ⇒ String readonly

  Current status of the task (e.g., PENDING, IN_PROGRESS, COMPLETED, FAILED).

• #tags ⇒ Array<String> readonly

  Tags associated with this task for categorization or filtering.

• #version ⇒ String readonly

  The version of the task to be performed.

Instance Attribute Details

#bypass_steps ⇒ Array<String> (readonly)

Returns List of step names that should be bypassed during task execution.

Returns:

• (Array<String>) —

  List of step names that should be bypassed during task execution

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

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

#complete ⇒ Boolean (readonly)

Returns Indicates whether the task has been completed.

Returns:

• (Boolean) —

  Indicates whether the task has been completed

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

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

#context ⇒ Hash (readonly)

Returns Context data required for task execution, containing task-specific information.

Returns:

• (Hash) —

  Context data required for task execution, containing task-specific information

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

attribute :context, Types::Hash

#initiator ⇒ String (readonly)

Returns The entity or system that initiated this task request.

Returns:

• (String) —

  The entity or system that initiated this task request

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

attribute :initiator, Types::String.default(Constants::UNKNOWN)

#name ⇒ String (readonly)

Returns The name of the task to be performed.

Returns:

• (String) —

  The name of the task to be performed

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

attribute :name, Types::Strict::String

#namespace ⇒ String (readonly)

Returns The namespace of the task to be performed.

Returns:

• (String) —

  The namespace of the task to be performed

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

attribute :namespace, Types::Strict::String.default('default')

#reason ⇒ String (readonly)

Returns The reason why this task was requested.

Returns:

• (String) —

  The reason why this task was requested

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

attribute :reason, Types::String.default(Constants::UNKNOWN)

#requested_at ⇒ Time (readonly)

Returns Timestamp when the task was initially requested.

Returns:

• (Time) —

  Timestamp when the task was initially requested

# File 'lib/tasker/types/task_request.rb', line 57

attribute(:requested_at, Types::JSON::Time.default { Time.zone.now })

#source_system ⇒ String (readonly)

Returns The system from which this task originated.

Returns:

• (String) —

  The system from which this task originated

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

attribute :source_system, Types::String.default(Constants::UNKNOWN)

#status ⇒ String (readonly)

Returns Current status of the task (e.g., PENDING, IN_PROGRESS, COMPLETED, FAILED).

Returns:

• (String) —

  Current status of the task (e.g., PENDING, IN_PROGRESS, COMPLETED, FAILED)

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

attribute :status, Types::String.default(Constants::TaskStatuses::PENDING)

#tags ⇒ Array<String> (readonly)

Returns Tags associated with this task for categorization or filtering.

Returns:

• (Array<String>) —

  Tags associated with this task for categorization or filtering

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

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

#version ⇒ String (readonly)

Returns The version of the task to be performed.

Returns:

• (String) —

  The version of the task to be performed

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

attribute :version, Types::Strict::String.default('0.1.0')