Class: A2A::TaskStatusUpdateEvent

Inherits:
ProtocolStruct
  • Object
show all
Defined in:
lib/a2a/types/task_status_update_event.rb

Overview

An event sent by the agent to notify the client of a change in a task’s status. This is typically used in streaming or subscription models.

Instance Method Summary collapse

Methods included from Extensions::CaseTransformation

#camelize, included, #to_json

Instance Method Details

#context_id ⇒ String

Returns The context ID associated with the task.

Returns:

  • (String) —

    The context ID associated with the task.



11
 
# File 'lib/a2a/types/task_status_update_event.rb', line 11

attribute :context_id, Types::String

#final ⇒ Boolean

Returns If true, this is the final event in the stream for this interaction.

Returns:

  • (Boolean) —

    If true, this is the final event in the stream for this interaction.



20
 
# File 'lib/a2a/types/task_status_update_event.rb', line 20

attribute :final, Types::Bool

#kind ⇒ String

Returns The type of this event, used as a discriminator. Always ‘status-update’.

Returns:

  • (String) —

    The type of this event, used as a discriminator. Always ‘status-update’.



14
 
# File 'lib/a2a/types/task_status_update_event.rb', line 14

attribute :kind, Types::String.constant('status-update')

#metadata ⇒ Hash?

Returns Optional metadata for extensions.

Returns:

  • (Hash, nil) —

    Optional metadata for extensions.



23
 
# File 'lib/a2a/types/task_status_update_event.rb', line 23

attribute? :metadata, Types::Hash.optional

#status ⇒ TaskStatus

Returns The new status of the task.

Returns:



17
 
# File 'lib/a2a/types/task_status_update_event.rb', line 17

attribute :status, Types::Constructor(TaskStatus)

#task_id ⇒ String

Returns The ID of the task that was updated.

Returns:

  • (String) —

    The ID of the task that was updated.



8
 
# File 'lib/a2a/types/task_status_update_event.rb', line 8

attribute :task_id, Types::String