Skip to content

FlowOperationMetadata

Source code in docs_src/capo_network_firewall/types/flow_operation_metadata.py
class FlowOperationMetadata(TypedDict, closed=True):
    flow_operation_id: NotRequired[
        "capo_network_firewall.types.flow_operation_id.FlowOperationId"
    ]
    """<p>A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.</p>"""
    flow_operation_type: NotRequired[
        "capo_network_firewall.types.flow_operation_type.FlowOperationType"
    ]
    """<p>Defines the type of <code>FlowOperation</code>.</p>"""
    flow_request_timestamp: NotRequired[
        "capo_network_firewall.types.flow_request_timestamp.FlowRequestTimestamp"
    ]
    """<p>A timestamp indicating when the Suricata engine identified flows impacted by an operation. </p>"""
    flow_operation_status: NotRequired[
        "capo_network_firewall.types.flow_operation_status.FlowOperationStatus"
    ]
    """<p>Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.</p> <p>If the status is <code>COMPLETED_WITH_ERRORS</code>, results may be returned with any number of <code>Flows</code> missing from the response. If the status is <code>FAILED</code>, <code>Flows</code> returned will be empty.</p>"""

flow_operation_id instance-attribute

flow_operation_id: NotRequired[FlowOperationId]

A unique identifier for the flow operation. This ID is returned in the responses to start and list commands. You provide to describe commands.

flow_operation_status instance-attribute

flow_operation_status: NotRequired[FlowOperationStatus]

Returns the status of the flow operation. This string is returned in the responses to start, list, and describe commands.

If the status is COMPLETED_WITH_ERRORS, results may be returned with any number of Flows missing from the response. If the status is FAILED, Flows returned will be empty.

flow_operation_type instance-attribute

flow_operation_type: NotRequired[FlowOperationType]

Defines the type of FlowOperation.

flow_request_timestamp instance-attribute

flow_request_timestamp: NotRequired[FlowRequestTimestamp]

A timestamp indicating when the Suricata engine identified flows impacted by an operation.