otupy.profiles.nfm.data.collector.Collector

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

Bases: Record

Collector Class

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

Methods

fromdict

Builds instance from dictionary

get

Mimics dictionary get method

todict

Converts to dictionary

validate_fields

Attributes

port

Port of the exporter

address

IP address of the exporter

__init__(address: IPv4Addr, port: Port = None)
address: IPv4Addr

IP address of the exporter

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 exporter

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.