otupy.profiles.fclm.data.collector.Collector

class Collector(address: IPv4Addr = None, port: Port = None, format: FileFormat = None)

Bases: Record

Collector Class

Represents a flow collector configuration. - address: Optional IPv4 address of the collector. - port: Optional port number used by the collector. - format: Optional flow export format used by the collector.

Methods

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

Attributes

`address`	IP address of the collector
`format`	Flow export file format (e.g., JSON, YAML, etc.)
`port`	Port of the collector

__init__(address: IPv4Addr = None, port: Port = None, format: FileFormat = None)

address: IPv4Addr = None: IP address of the collector

format: FileFormat = None: Flow export file format (e.g., JSON, YAML, etc.)

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

port: Port = None: Port of the collector

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.