EventProperty Class Reference

A single audit/telemetry property. More...

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

Public Member Functions
virtual double	GetDouble () const =0
	Get property value (double)
virtual int64_t	GetInt64 () const =0
	Get property value (int64)
virtual const std::string &	GetName () const =0
	Get name of property.
virtual Pii	GetPii () const =0
	Get personally-identifiable information (PII) classification, if any.
virtual EventPropertyType	GetPropertyType () const =0
	Get the underlying data type for this property.
virtual const std::string &	GetString () const =0
	Get property value (string)
virtual bool	IsAuditOnly () const =0
	Get whether or not this property is restricted to the audit pipeline.

Detailed Description

A single audit/telemetry property.

Definition at line 47 of file event_property.h.

Member Function Documentation

GetDouble()

virtual double EventProperty::GetDouble ( ) const

pure virtual

Get property value (double)

Returns

Property value

GetInt64()

virtual int64_t EventProperty::GetInt64 ( ) const

pure virtual

Get property value (int64)

Returns

Property value

GetName()

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

pure virtual

Get name of property.

Returns

Name of property

GetPii()

virtual Pii EventProperty::GetPii ( ) const

pure virtual

Get personally-identifiable information (PII) classification, if any.

Returns

PII classification

GetPropertyType()

virtual EventPropertyType EventProperty::GetPropertyType ( ) const

pure virtual

Get the underlying data type for this property.

Returns

Underlying data type

GetString()

virtual const std::string & EventProperty::GetString ( ) const

pure virtual

Get property value (string)

Returns

Property value

IsAuditOnly()

virtual bool EventProperty::IsAuditOnly ( ) const

pure virtual

Get whether or not this property is restricted to the audit pipeline.

Returns

Whether or not this properties is restricted to the audit pipeline

Note

If this is true, the property contains sensitive information and must not be written to file logs or to any pipeline except for audit until it is manually scrubbed.

---

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

• src/api/mip/event_property.h