Skip to content

Edge

Source code in docs_src/capo_xray/types/edge.py
class Edge(TypedDict, closed=True):
    reference_id: NotRequired["capo_xray.types.nullable_integer.NullableInteger"]
    """<p>Identifier of the edge. Unique within a service map.</p>"""
    start_time: NotRequired["capo_xray.types.timestamp.Timestamp"]
    """<p>The start time of the first segment on the edge.</p>"""
    end_time: NotRequired["capo_xray.types.timestamp.Timestamp"]
    """<p>The end time of the last segment on the edge.</p>"""
    summary_statistics: NotRequired["capo_xray.types.edge_statistics.EdgeStatistics"]
    """<p>Response statistics for segments on the edge.</p>"""
    response_time_histogram: NotRequired["capo_xray.types.histogram.Histogram"]
    """<p>A histogram that maps the spread of client response times on an edge. Only populated for synchronous edges.</p>"""
    aliases: NotRequired["capo_xray.types.alias_list.AliasList"]
    """<p>Aliases for the edge.</p>"""
    edge_type: NotRequired["capo_xray.types.string.String"]
    """<p>Describes an asynchronous connection, with a value of <code>link</code>.</p>"""
    received_event_age_histogram: NotRequired["capo_xray.types.histogram.Histogram"]
    """<p>A histogram that maps the spread of event age when received by consumers. Age is calculated each time an event is received. Only populated when <i>EdgeType</i> is <code>link</code>.</p>"""

aliases instance-attribute

aliases: NotRequired[AliasList]

Aliases for the edge.

edge_type instance-attribute

edge_type: NotRequired[String]

Describes an asynchronous connection, with a value of link.

end_time instance-attribute

end_time: NotRequired[Timestamp]

The end time of the last segment on the edge.

received_event_age_histogram instance-attribute

received_event_age_histogram: NotRequired[Histogram]

A histogram that maps the spread of event age when received by consumers. Age is calculated each time an event is received. Only populated when EdgeType is link.

reference_id instance-attribute

reference_id: NotRequired[NullableInteger]

Identifier of the edge. Unique within a service map.

response_time_histogram instance-attribute

response_time_histogram: NotRequired[Histogram]

A histogram that maps the spread of client response times on an edge. Only populated for synchronous edges.

start_time instance-attribute

start_time: NotRequired[Timestamp]

The start time of the first segment on the edge.

summary_statistics instance-attribute

summary_statistics: NotRequired[EdgeStatistics]

Response statistics for segments on the edge.