Microsoft Information Protection (MIP) SDK for C++: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C++
Loading...
Searching...
No Matches
diagnostic_types.h File Reference

File containing diagnostic-related types. More...

#include <stdint.h>
#include "mip/mip_namespace.h"
+ Include dependency graph for diagnostic_types.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations

enum class  CombinationPii : uint32_t {
  None = 0 ,
  SmtpAddress = 1 << 0 ,
  Identity = 1 << 1 ,
  Uri = 1 << 2 ,
  Fqdn = 1 << 3 ,
  EUPI = 1 << 4 ,
  OII = 1 << 5 ,
  EUII = 1 << 6 ,
  CustomerContent = 1 << 7 ,
  All = 0xFFFFFFFF
}
 Complete description of PII data types, if any. More...
 
enum class  EventLevel {
  Basic = 0 ,
  ImportantServiceData = 1 ,
  NecessaryServiceData = 2
}
 Description of event importance. More...
 
enum class  EventPropertyType {
  Double ,
  Int64 ,
  String
}
 Underlying event property data type. More...
 
enum class  Pii {
  None = 0 ,
  SmtpAddress = 1 ,
  Identity = 2 ,
  Uri = 3 ,
  Fqdn = 4 ,
  EUPI = 5 ,
  OII = 6 ,
  EUII = 7 ,
  CustomerContent = 8
}
 Description of PII data, if any. More...
 

Functions

constexpr enum CombinationPii operator& (const enum CombinationPii selfValue, const enum CombinationPii inValue)
 
constexpr enum CombinationPii operator| (const enum CombinationPii selfValue, const enum CombinationPii inValue)
 

Detailed Description

File containing diagnostic-related types.

Definition in file diagnostic_types.h.

Enumeration Type Documentation

◆ CombinationPii

enum class CombinationPii : uint32_t
strong

Complete description of PII data types, if any.

Enumerator
None 

Data is not PII.

SmtpAddress 

Data contains an SMTP address.

Identity 

Data contains an identity.

Uri 

Data contains a URI.

Fqdn 

Data contains a FQDN.

EUPI 

Data contains a End User Pseudonymous Information.

OII 

Data contains a Organization Identifiable Information.

EUII 

Data contains End User Identifiable Information.

CustomerContent 

Data contains Customer Content.

All 

Any and all Pii is represented.

Definition at line 62 of file diagnostic_types.h.

62 : uint32_t {
63 None = 0, /**< Data is not PII */
64 SmtpAddress = 1 << 0, /**< Data contains an SMTP address */
65 Identity = 1 << 1, /**< Data contains an identity */
66 Uri = 1 << 2, /**< Data contains a URI */
67 Fqdn = 1 << 3, /**< Data contains a FQDN */
68 EUPI = 1 << 4, /**< Data contains a End User Pseudonymous Information */
69 OII = 1 << 5, /**< Data contains a Organization Identifiable Information */
70 EUII = 1 << 6, /**< Data contains End User Identifiable Information */
71 CustomerContent = 1 << 7, /**< Data contains Customer Content */
72 All = 0xFFFFFFFF, /**< Any and all Pii is represented */
73};
Abstraction for identity.
@ CustomerContent
Data contains Customer Content.
@ Fqdn
Data contains a FQDN.
@ OII
Data contains a Organization Identifiable Information.
@ EUII
Data contains End User Identifiable Information.
@ EUPI
Data contains a End User Pseudonymous Information.
@ Uri
Data contains a URI.
@ SmtpAddress
Data contains an SMTP address.
@ None
Data is not PII.
@ All
Any and all Pii is represented.

◆ EventLevel

enum class EventLevel
strong

Description of event importance.

Enumerator
Basic 

Data is used only for telemetry/logging purposes.

ImportantServiceData 

Data is necessary to track the usage of critical features.

NecessaryServiceData 

Data is necessary as a critical feature (e.g.

audit)

Definition at line 86 of file diagnostic_types.h.

86 {
87 Basic = 0, /**< Data is used only for telemetry/logging purposes */
88 ImportantServiceData = 1, /**< Data is necessary to track the usage of critical features */
89 NecessaryServiceData = 2, /**< Data is necessary as a critical feature (e.g. audit) */
90};
@ ImportantServiceData
Data is necessary to track the usage of critical features.
@ NecessaryServiceData
Data is necessary as a critical feature (e.g.
@ Basic
Data is used only for telemetry/logging purposes.

◆ EventPropertyType

enum class EventPropertyType
strong

Underlying event property data type.

Enumerator
Double 

double

Int64 

int64_t

String 

string

Definition at line 95 of file diagnostic_types.h.

95 {
96 Double, /**< double */
97 Int64, /**< int64_t */
98 String, /**< string */
99};

◆ Pii

enum class Pii
strong

Description of PII data, if any.

Note
If an event is sent through audit pipeline, this value should be forced to 'None'.
Enumerator
None 

Data is not PII.

SmtpAddress 

Data contains an SMTP address.

Identity 

Data contains an identity.

Uri 

Data contains a URI.

Fqdn 

Data contains a FQDN.

EUPI 

Data contains a End User Pseudonymous Information.

OII 

Data contains a Organization Identifiable Information.

EUII 

Data contains End User Identifiable Information.

CustomerContent 

Data contains Customer Content.

Definition at line 47 of file diagnostic_types.h.

47 {
48 None = 0, /**< Data is not PII */
49 SmtpAddress = 1, /**< Data contains an SMTP address */
50 Identity = 2, /**< Data contains an identity */
51 Uri = 3, /**< Data contains a URI */
52 Fqdn = 4, /**< Data contains a FQDN */
53 EUPI = 5, /**< Data contains a End User Pseudonymous Information */
54 OII = 6, /**< Data contains a Organization Identifiable Information */
55 EUII = 7, /**< Data contains End User Identifiable Information */
56 CustomerContent = 8, /**< Data contains Customer Content */
57};

Function Documentation

◆ operator&()

enum CombinationPii operator& ( const enum CombinationPii selfValue,
const enum CombinationPii inValue )
inlineconstexpr

Definition at line 79 of file diagnostic_types.h.

79 {
80 return static_cast<enum CombinationPii>(uint32_t(selfValue) & uint32_t(inValue));
81}
CombinationPii
Complete description of PII data types, if any.

◆ operator|()

enum CombinationPii operator| ( const enum CombinationPii selfValue,
const enum CombinationPii inValue )
inlineconstexpr

Definition at line 75 of file diagnostic_types.h.

75 {
76 return static_cast<enum CombinationPii>(uint32_t(selfValue) | uint32_t(inValue));
77}