Skip to content

EventLogEntry

Source code in docs_src/capo_codecatalyst/types/event_log_entry.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
class EventLogEntry(TypedDict, closed=True):
    id: "str"
    """<p>The system-generated unique ID of the event.</p>"""
    event_name: "str"
    """<p>The name of the event.</p>"""
    event_type: "str"
    """<p>The type of the event.</p>"""
    event_category: "str"
    """<p>The category for the event.</p>"""
    event_source: "str"
    """<p>The source of the event.</p>"""
    event_time: "capo_codecatalyst.types.timestamp.Timestamp"
    """<p>The time the event took place, in coordinated universal time (UTC) timestamp format as specified in <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339</a>.</p>"""
    operation_type: "capo_codecatalyst.types.operation_type.OperationType"
    """<p>The type of the event.</p>"""
    user_identity: "capo_codecatalyst.types.user_identity.UserIdentity"
    """<p>The system-generated unique ID of the user whose actions are recorded in the event.</p>"""
    project_information: NotRequired[
        "capo_codecatalyst.types.project_information.ProjectInformation"
    ]
    """<p>Information about the project where the event occurred.</p>"""
    request_id: NotRequired["str"]
    """<p>The system-generated unique ID of the request.</p>"""
    request_payload: NotRequired["capo_codecatalyst.types.event_payload.EventPayload"]
    """<p>Information about the payload of the request.</p>"""
    response_payload: NotRequired["capo_codecatalyst.types.event_payload.EventPayload"]
    """<p>Information about the payload of the response, if any.</p>"""
    error_code: NotRequired["str"]
    """<p>The code of the error, if any.</p>"""
    source_ip_address: NotRequired["str"]
    """<p>The IP address of the user whose actions are recorded in the event.</p>"""
    user_agent: NotRequired["str"]
    """<p>The user agent whose actions are recorded in the event.</p>"""

error_code instance-attribute 

error_code: NotRequired[str]

The code of the error, if any.

event_category instance-attribute 

event_category: str

The category for the event.

event_name instance-attribute 

event_name: str

The name of the event.

event_source instance-attribute 

event_source: str

The source of the event.

event_time instance-attribute 

event_time: Timestamp

The time the event took place, in coordinated universal time (UTC) timestamp format as specified in RFC 3339.

event_type instance-attribute 

event_type: str

The type of the event.

id instance-attribute 

id: str

The system-generated unique ID of the event.

operation_type instance-attribute 

operation_type: OperationType

The type of the event.

project_information instance-attribute 

project_information: NotRequired[ProjectInformation]

Information about the project where the event occurred.

request_id instance-attribute 

request_id: NotRequired[str]

The system-generated unique ID of the request.

request_payload instance-attribute 

request_payload: NotRequired[EventPayload]

Information about the payload of the request.

response_payload instance-attribute 

response_payload: NotRequired[EventPayload]

Information about the payload of the response, if any.

source_ip_address instance-attribute 

source_ip_address: NotRequired[str]

The IP address of the user whose actions are recorded in the event.

user_agent instance-attribute 

user_agent: NotRequired[str]

The user agent whose actions are recorded in the event.

user_identity instance-attribute 

user_identity: UserIdentity

The system-generated unique ID of the user whose actions are recorded in the event.