Skip to content

Flow

Source code in docs_src/capo_network_firewall/types/flow.py
class Flow(TypedDict, closed=True):
    source_address: NotRequired["capo_network_firewall.types.address.Address"]
    destination_address: NotRequired["capo_network_firewall.types.address.Address"]
    source_port: NotRequired["capo_network_firewall.types.port.Port"]
    """<p>The source port to inspect for. You can specify an individual port, for example <code>1994</code> and you can specify a port range, for example <code>1990:1994</code>. To match with any port, specify <code>ANY</code>.</p>"""
    destination_port: NotRequired["capo_network_firewall.types.port.Port"]
    """<p>The destination port to inspect for. You can specify an individual port, for example <code>1994</code> and you can specify a port range, for example <code>1990:1994</code>. To match with any port, specify <code>ANY</code>.</p>"""
    protocol: NotRequired["capo_network_firewall.types.protocol_string.ProtocolString"]
    """<p>The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.</p>"""
    age: NotRequired["capo_network_firewall.types.age.Age"]
    """<p>Returned as info about age of the flows identified by the flow operation.</p>"""
    packet_count: NotRequired["capo_network_firewall.types.packet_count.PacketCount"]
    """<p>Returns the total number of data packets received or transmitted in a flow.</p>"""
    byte_count: "capo_network_firewall.types.byte_count.ByteCount"
    """<p>Returns the number of bytes received or transmitted in a specific flow.</p>"""

age instance-attribute

age: NotRequired[Age]

Returned as info about age of the flows identified by the flow operation.

byte_count instance-attribute

byte_count: ByteCount

Returns the number of bytes received or transmitted in a specific flow.

destination_address instance-attribute

destination_address: NotRequired[Address]

destination_port instance-attribute

destination_port: NotRequired[Port]

The destination port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.

packet_count instance-attribute

packet_count: NotRequired[PacketCount]

Returns the total number of data packets received or transmitted in a flow.

protocol instance-attribute

protocol: NotRequired[ProtocolString]

The protocols to inspect for, specified using the assigned internet protocol number (IANA) for each protocol. If not specified, this matches with any protocol.

source_address instance-attribute

source_address: NotRequired[Address]

source_port instance-attribute

source_port: NotRequired[Port]

The source port to inspect for. You can specify an individual port, for example 1994 and you can specify a port range, for example 1990:1994. To match with any port, specify ANY.