Struct TaskStatusUpdateEvent 

pub struct TaskStatusUpdateEvent {
    pub context_id: String,
    pub final_: bool,
    pub metadata: Option<Struct>,
    pub status: TaskStatus,
    pub task_id: String,
}

An event sent by the agent to notify the client of a change in a task’s status.

JSON schema

{
 "title": "Task Status Update Event",
 "description": "An event sent by the agent to notify the client of a change in a task's\n status.",
 "type": "object",
 "required": [
   "contextId",
   "final",
   "status",
   "taskId"
 ],
 "properties": {
   "contextId": {
     "description": "The id of the context that the task belongs to",
     "type": "string"
   },
   "final": {
     "description": "If true, this is the final event in the stream for this interaction.",
     "type": "boolean"
   },
   "metadata": {
     "description": "Optional metadata to associate with the task update.",
     "$ref": "#/definitions/Struct"
   },
   "status": {
     "description": "The new status of the task.",
     "$ref": "#/definitions/TaskStatus"
   },
   "taskId": {
     "description": "The id of the task that is changed",
     "type": "string"
   }
 },
 "additionalProperties": false,
 "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Fields

context_id: String

The id of the context that the task belongs to

final_: bool

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

metadata: Option<Struct>

Optional metadata to associate with the task update.

status: TaskStatus

The new status of the task.

task_id: String

The id of the task that is changed

Implementations

impl TaskStatusUpdateEvent

pub fn builder() -> TaskStatusUpdateEvent

Trait Implementations

impl Clone for TaskStatusUpdateEvent

fn clone(&self) -> TaskStatusUpdateEvent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TaskStatusUpdateEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TaskStatusUpdateEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<TaskStatusUpdateEvent> for TaskStatusUpdateEvent

fn from(value: TaskStatusUpdateEvent) -> Self

Converts to this type from the input type.

impl Serialize for TaskStatusUpdateEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<TaskStatusUpdateEvent> for TaskStatusUpdateEvent

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: TaskStatusUpdateEvent) -> Result<Self, ConversionError>

Performs the conversion.