Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.conversation.trace.ConversationTrace Class Reference

Public Member Functions

None __init__ (self)
 
None add_event (self, ConversationTraceEvent event)
 
dict[str, Any] as_dict (self)
 
None set_error (self, Exception ex)
 
None set_result (self, **Any kwargs)
 
str trace_id (self)
 

Static Public Attributes

 default
 
 size_limit = STORED_TRACES
 

Private Attributes

 _error
 
 _result
 
 _trace_id
 

Detailed Description

Stores debug data related to a conversation.

Definition at line 38 of file trace.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.conversation.trace.ConversationTrace.__init__ (   self)
Initialize ConversationTrace.

Definition at line 41 of file trace.py.

Member Function Documentation

◆ add_event()

None homeassistant.components.conversation.trace.ConversationTrace.add_event (   self,
ConversationTraceEvent  event 
)
Add an event to the trace.

Definition at line 53 of file trace.py.

◆ as_dict()

dict[str, Any] homeassistant.components.conversation.trace.ConversationTrace.as_dict (   self)
Return dictionary version of this ConversationTrace.

Definition at line 65 of file trace.py.

◆ set_error()

None homeassistant.components.conversation.trace.ConversationTrace.set_error (   self,
Exception  ex 
)
Set error.

Definition at line 57 of file trace.py.

◆ set_result()

None homeassistant.components.conversation.trace.ConversationTrace.set_result (   self,
**Any  kwargs 
)
Set result.

Definition at line 61 of file trace.py.

◆ trace_id()

str homeassistant.components.conversation.trace.ConversationTrace.trace_id (   self)
Identifier for this trace.

Definition at line 49 of file trace.py.

Member Data Documentation

◆ _error

homeassistant.components.conversation.trace.ConversationTrace._error
private

Definition at line 59 of file trace.py.

◆ _result

homeassistant.components.conversation.trace.ConversationTrace._result
private

Definition at line 63 of file trace.py.

◆ _trace_id

homeassistant.components.conversation.trace.ConversationTrace._trace_id
private

Definition at line 43 of file trace.py.

◆ default

homeassistant.components.conversation.trace.ConversationTrace.default
static

Definition at line 79 of file trace.py.

◆ size_limit

homeassistant.components.conversation.trace.ConversationTrace.size_limit = STORED_TRACES
static

Definition at line 82 of file trace.py.


The documentation for this class was generated from the following file: