Class: ClaudeAgentSDK::TaskProgressMessage

Inherits:
SystemMessage show all
Defined in:
lib/claude_agent_sdk/types.rb

Overview

Task progress system message (periodic update from a running task)

Instance Attribute Summary collapse

Attributes inherited from SystemMessage

#data, #subtype

Instance Method Summary collapse

Constructor Details

#initialize(subtype:, data:, task_id:, description:, usage:, uuid:, session_id:, tool_use_id: nil, last_tool_name: nil, summary: nil) ⇒ TaskProgressMessage

Returns a new instance of TaskProgressMessage.



411
412
413
414
415
416
417
418
419
420
421
422
# File 'lib/claude_agent_sdk/types.rb', line 411

def initialize(subtype:, data:, task_id:, description:, usage:, uuid:, session_id:,
               tool_use_id: nil, last_tool_name: nil, summary: nil)
  super(subtype: subtype, data: data)
  @task_id = task_id
  @description = description
  @usage = usage
  @uuid = uuid
  @session_id = session_id
  @tool_use_id = tool_use_id
  @last_tool_name = last_tool_name
  @summary = summary
end

Instance Attribute Details

#descriptionObject

Returns the value of attribute description.



409
410
411
# File 'lib/claude_agent_sdk/types.rb', line 409

def description
  @description
end

#last_tool_nameObject

Returns the value of attribute last_tool_name.



409
410
411
# File 'lib/claude_agent_sdk/types.rb', line 409

def last_tool_name
  @last_tool_name
end

#session_idObject

Returns the value of attribute session_id.



409
410
411
# File 'lib/claude_agent_sdk/types.rb', line 409

def session_id
  @session_id
end

#summaryObject

Returns the value of attribute summary.



409
410
411
# File 'lib/claude_agent_sdk/types.rb', line 409

def summary
  @summary
end

#task_idObject

Returns the value of attribute task_id.



409
410
411
# File 'lib/claude_agent_sdk/types.rb', line 409

def task_id
  @task_id
end

#tool_use_idObject

Returns the value of attribute tool_use_id.



409
410
411
# File 'lib/claude_agent_sdk/types.rb', line 409

def tool_use_id
  @tool_use_id
end

#usageObject

Returns the value of attribute usage.



409
410
411
# File 'lib/claude_agent_sdk/types.rb', line 409

def usage
  @usage
end

#uuidObject

Returns the value of attribute uuid.



409
410
411
# File 'lib/claude_agent_sdk/types.rb', line 409

def uuid
  @uuid
end