MIP SDK — C++ 1.18
API Reference Documentation for C++
Loading...
Searching...
No Matches
NoPolicyError Class Reference

Tenant policy is not configured for classification/labels. More...

#include <mip/error.h>

Inheritance diagram for NoPolicyError:
Error

Public Types

enum class  Category { SyncFile , Labels , Rules }
 Describes what is the failure point while parsing. More...
 

Public Member Functions

 NoPolicyError (const std::string &message, const Category category, const std::string &name="NoPolicyError")
 
 NoPolicyError (const std::string &message, const Category category, const std::map< std::string, std::string > &debugInfo, const std::map< std::string, std::string > sensitiveDebugInfo, const std::string &name="NoPolicyError")
 
std::shared_ptr< ErrorClone () const override
 Clone the error.
 
Category GetCategory () const
 
- Public Member Functions inherited from Error
char const * what () const noexcept override
 Get the error message.
 
virtual ErrorType GetErrorType () const
 Get the error type.
 
const std::string & GetErrorName () const
 Get the error name.
 
const std::string & GetMessage (bool maskPII=false) const
 Get the error message.
 
void SetMessage (const std::string &msg)
 Set the error message.
 
void AddDebugInfo (const std::string &key, const std::string &value, bool sensitive=false)
 Add debug info entry.
 
const std::map< std::string, std::string > & GetDebugInfo () const
 Get debug info.
 
virtual ~Error ()
 

Private Member Functions

const std::string & GetCategoryString (Category category) const
 

Private Attributes

Category mCategory
 

Additional Inherited Members

- Protected Member Functions inherited from Error
 Error (const std::string &message, const std::string &name, ErrorType type)
 
 Error (const std::string &message, const std::map< std::string, std::string > debugInfo, const std::map< std::string, std::string > sensitiveDebugInfo, const std::string &name, ErrorType type)
 
- Protected Attributes inherited from Error
std::string mMessage
 
std::map< std::string, std::string > mDebugInfo
 
std::string mName
 
ErrorType mType
 

Detailed Description

Tenant policy is not configured for classification/labels.

Member Enumeration Documentation

◆ Category

enum class NoPolicyError::Category
strong

Describes what is the failure point while parsing.

Enumerator
SyncFile 

Policy is missing syncfile node, override label node

Labels 

Policy is missing labels node, override rules node

Rules 

Policy is missing rules node.

Constructor & Destructor Documentation

◆ NoPolicyError() [1/2]

NoPolicyError::NoPolicyError ( const std::string & message,
const Category category,
const std::string & name = "NoPolicyError" )
inlineexplicit

◆ NoPolicyError() [2/2]

NoPolicyError::NoPolicyError ( const std::string & message,
const Category category,
const std::map< std::string, std::string > & debugInfo,
const std::map< std::string, std::string > sensitiveDebugInfo,
const std::string & name = "NoPolicyError" )
inlineexplicit

Member Function Documentation

◆ Clone()

std::shared_ptr< Error > NoPolicyError::Clone ( ) const
inlineoverridevirtual

Clone the error.

Returns
a clone of the error.

Implements Error.

◆ GetCategory()

Category NoPolicyError::GetCategory ( ) const
inline

◆ GetCategoryString()

const std::string & NoPolicyError::GetCategoryString ( Category category) const
inlineprivate

Member Data Documentation

◆ mCategory

Category NoPolicyError::mCategory
private

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