Event Class Reference

A single audit/telemetry event. More...

#include <src/api/mip/event.h>

Inheritance diagram for Event:

Public Member Functions
virtual void	AddAuditOnlyProperty (const std::string &name, const std::string &value)=0
	Add an audit-only string property to the event.
virtual void	AddProperty (const std::shared_ptr< EventProperty > &prop)=0
	Add a property to the event.
virtual void	AddProperty (const std::string &name, bool value)=0
	Add a bool property to the event.
virtual void	AddProperty (const std::string &name, const std::string &value, Pii pii)=0
	Add a string property to the event.
virtual void	AddProperty (const std::string &name, double value, Pii pii)=0
	Add a double property to the event.
virtual void	AddProperty (const std::string &name, int64_t value, Pii pii)=0
	Add an int64 property to the event.
virtual EventLevel	GetLevel () const =0
	Get level of event, indicating whether it is considered necessary service data (NSD) or not.
virtual const std::string &	GetName () const =0
	Get event name.
virtual std::vector< std::shared_ptr< EventProperty > >	GetProperties () const =0
	Get all event properties.
virtual std::shared_ptr< EventProperty >	GetProperty (const std::string &name) const =0
	Get property with the given name, if any.
virtual const std::chrono::steady_clock::time_point &	GetStartTime () const =0
	Get event start time.

Detailed Description

A single audit/telemetry event.

Definition at line 50 of file event.h.

Member Function Documentation

AddAuditOnlyProperty()

virtual void Event::AddAuditOnlyProperty ( const std::string & name, const std::string & value )

pure virtual

Add an audit-only string property to the event.

Parameters

name	Property name
value	Property value

Note

An audit-only property contains sensitive information and must not be written to file logs or to any pipeline except for audit until it is manually scrubbed.

AddProperty() [1/5]

virtual void Event::AddProperty ( const std::shared_ptr< EventProperty > & prop )

pure virtual

Add a property to the event.

Parameters

prop	Property to add

AddProperty() [2/5]

virtual void Event::AddProperty ( const std::string & name, bool value )

pure virtual

Add a bool property to the event.

Parameters

name	Property name
value	Property value

AddProperty() [3/5]

virtual void Event::AddProperty ( const std::string & name, const std::string & value, Pii pii )

pure virtual

Add a string property to the event.

Parameters

name	Property name
value	Property value
pii	PII classification

AddProperty() [4/5]

virtual void Event::AddProperty ( const std::string & name, double value, Pii pii )

pure virtual

Add a double property to the event.

Parameters

name	Property name
value	Property value
pii	PII classification

AddProperty() [5/5]

virtual void Event::AddProperty ( const std::string & name, int64_t value, Pii pii )

pure virtual

Add an int64 property to the event.

Parameters

name	Property name
value	Property value
pii	PII classification

GetLevel()

virtual EventLevel Event::GetLevel ( ) const

pure virtual

Get level of event, indicating whether it is considered necessary service data (NSD) or not.

Returns

Level of event

GetName()

virtual const std::string & Event::GetName ( ) const

pure virtual

Get event name.

Returns

Event name

GetProperties()

virtual std::vector< std::shared_ptr< EventProperty > > Event::GetProperties ( ) const

pure virtual

Get all event properties.

Returns

Event properties

GetProperty()

virtual std::shared_ptr< EventProperty > Event::GetProperty ( const std::string & name ) const

pure virtual

Get property with the given name, if any.

Parameters

name	Name of the property to get

Returns

Property with the given name, or nullptr if none

GetStartTime()

virtual const std::chrono::steady_clock::time_point & Event::GetStartTime ( ) const

pure virtual

Get event start time.

Returns

Event start time

---

The documentation for this class was generated from the following file:

• src/api/mip/event.h