otupy.profiles.nfm.data.export_options.ExportOptions

class ExportOptions(sampling: int = None, aggregate: int = None, buffer: int = None, timeout: int = None, format: FlowFormat = None)

Bases: Record

ExportOptions Class

Represents optional export configuration settings. - sampling: Optional sampling rate (e.g., 1 means every packet, 10 means every 10th). - aggregate: Optional aggregation mode (may indicate level or method of aggregation). - buffer: Optional size of the UDP buffer for collectors. - timeout: Optional UDP timeout duration (in seconds or milliseconds).

Methods

`fromdict`	Builds instance from dictionary
`get`	Mimics dictionary get method
`todict`	Converts to dictionary
`validate_fields`

Attributes

`aggregate`	Aggregation mode
`buffer`	Collector UDP buffer
`format`	Flow export format (e.g., NetFlow v5, v9, IPFIX)
`sampling`	Sampling rate
`timeout`	Collector UDP timeout

__init__(sampling: int = None, aggregate: int = None, buffer: int = None, timeout: int = None, format: FlowFormat = None)

aggregate: int = None: Aggregation mode

buffer: int = None: Collector UDP buffer

format: FlowFormat = None: Flow export format (e.g., NetFlow v5, v9, IPFIX)

classmethod fromdict(dic, e)

Builds instance from dictionary

It is used during deserialization to create an otupy instance from the text message. It takes an Encoder instance that is used to recursively build instances of the inner objects (the Encoder provides standard methods to create instances of base objects like strings, integers, boolean).

Parameters:

dic – The intermediary dictionary representation from which the object is built.
e – The Encoder that is being used.

Returns:

An instance of this class initialized from the dictionary values.

get(key, default=None): Mimics dictionary get method

sampling: int = None: Sampling rate

timeout: int = None: Collector UDP timeout

todict(e)

Converts to dictionary

It is used to convert this object to an intermediary representation during serialization. It takes an Encoder argument that is used to recursively serialize inner data and structures (the Encoder provides standard methods for converting base types to dictionaries)..

Parameters:: e – The Encoder that is being used.
Returns:: A dictionary compliants to the Language Specification’s serialization rules.