Microsoft Information Protection SDK - C++ 1.17
API Reference Documentation for C++
Loading...
Searching...
No Matches
ComputeEngine::Settings Class Reference

#include <compute_engine.h>

Public Member Functions

 Settings (const Identity &identity, const ApplicationInfo &applicationInfo, const std::shared_ptr< TelemetryDelegate > &telemetryDelegate, const std::shared_ptr< AuditDelegate > &auditDelegate, const std::shared_ptr< DiagnosticEventFactory > &eventFactory, LogLevel thresholdLogLevel, const std::shared_ptr< LoggerDelegate > &loggerDelegate, const std::string &hostName, const std::vector< std::pair< std::string, std::string > > &customProperties, const std::vector< LabelFilterType > &deprecatedFilters, const std::map< FunctionalityFilterType, bool > &configuredFunctionality)
 
const IdentityGetIdentity () const
 
void SetIdentity (const Identity &identity)
 
const ApplicationInfoGetApplicationInfo () const
 
std::shared_ptr< TelemetryDelegateGetTelemetryDelegate () const
 
std::shared_ptr< AuditDelegateGetAuditDelegate () const
 
std::shared_ptr< DiagnosticEventFactory > GetEventFactory () const
 
std::shared_ptr< LoggerDelegateGetLoggerDelegate () const
 
const std::string & GetHostName () const
 
const std::vector< std::pair< std::string, std::string > > & GetCustomProperties () const
 
void SetParentCorrelationId (const std::string correlationId, const std::string description)
 
const std::string & GetParentCorrelationId () const
 
const std::string & GetParentCorrelationIdDescription () const
 
const std::vector< LabelFilterType > & GetDeprecatedLabelFilter () const
 
const std::map< FunctionalityFilterType, bool > & GetConfiguredFunctionality () const
 
void SetVariableTextMarkingType (VariableTextMarkingType variableTextMarkingType)
 
VariableTextMarkingType GetVariableTextMarkingType () const
 
LogLevel GetThresholdLogLevel () const
 
const std::shared_ptr< void > & GetLoggerContext () const
 Get logger context that will be opaquely passed to the logger delegate for logs associated with the created engine.
 
void SetLoggerContext (const std::shared_ptr< void > &loggerContext)
 Sets the logger context that will be opaquely passed to the logger delegate for logs associated with the created engine.
 

Private Attributes

Identity mIdentity
 
ApplicationInfo mApplicationInfo
 
std::shared_ptr< TelemetryDelegatemTelemetryDelegate
 
std::shared_ptr< AuditDelegatemAuditDelegate
 
std::shared_ptr< DiagnosticEventFactory > mEventFactory
 
LogLevel mThresholdLogLevel
 
std::shared_ptr< LoggerDelegatemLoggerDelegate
 
std::string mHostName
 
std::vector< std::pair< std::string, std::string > > mCustomProperties
 
std::vector< LabelFilterTypemDeprecatedLabelFilters
 
std::map< FunctionalityFilterType, bool > mConfiguredFunctionality
 
std::string mParentCorrelationId
 
std::string mParentCorrelationIdDescription
 
VariableTextMarkingType mVariableTextMarkingType = VariableTextMarkingType::Default
 
std::shared_ptr< void > mLoggerContext
 

Constructor & Destructor Documentation

◆ Settings()

ComputeEngine::Settings::Settings ( const Identity & identity,
const ApplicationInfo & applicationInfo,
const std::shared_ptr< TelemetryDelegate > & telemetryDelegate,
const std::shared_ptr< AuditDelegate > & auditDelegate,
const std::shared_ptr< DiagnosticEventFactory > & eventFactory,
LogLevel thresholdLogLevel,
const std::shared_ptr< LoggerDelegate > & loggerDelegate,
const std::string & hostName,
const std::vector< std::pair< std::string, std::string > > & customProperties,
const std::vector< LabelFilterType > & deprecatedFilters,
const std::map< FunctionalityFilterType, bool > & configuredFunctionality )
inline

Member Function Documentation

◆ GetApplicationInfo()

const ApplicationInfo & ComputeEngine::Settings::GetApplicationInfo ( ) const
inline

◆ GetAuditDelegate()

std::shared_ptr< AuditDelegate > ComputeEngine::Settings::GetAuditDelegate ( ) const
inline

◆ GetConfiguredFunctionality()

const std::map< FunctionalityFilterType, bool > & ComputeEngine::Settings::GetConfiguredFunctionality ( ) const
inline

◆ GetCustomProperties()

const std::vector< std::pair< std::string, std::string > > & ComputeEngine::Settings::GetCustomProperties ( ) const
inline

◆ GetDeprecatedLabelFilter()

const std::vector< LabelFilterType > & ComputeEngine::Settings::GetDeprecatedLabelFilter ( ) const
inline

◆ GetEventFactory()

std::shared_ptr< DiagnosticEventFactory > ComputeEngine::Settings::GetEventFactory ( ) const
inline

◆ GetHostName()

const std::string & ComputeEngine::Settings::GetHostName ( ) const
inline

◆ GetIdentity()

const Identity & ComputeEngine::Settings::GetIdentity ( ) const
inline

◆ GetLoggerContext()

const std::shared_ptr< void > & ComputeEngine::Settings::GetLoggerContext ( ) const
inline

Get logger context that will be opaquely passed to the logger delegate for logs associated with the created engine.

Returns
The logger context

◆ GetLoggerDelegate()

std::shared_ptr< LoggerDelegate > ComputeEngine::Settings::GetLoggerDelegate ( ) const
inline

◆ GetParentCorrelationId()

const std::string & ComputeEngine::Settings::GetParentCorrelationId ( ) const
inline

◆ GetParentCorrelationIdDescription()

const std::string & ComputeEngine::Settings::GetParentCorrelationIdDescription ( ) const
inline

◆ GetTelemetryDelegate()

std::shared_ptr< TelemetryDelegate > ComputeEngine::Settings::GetTelemetryDelegate ( ) const
inline

◆ GetThresholdLogLevel()

LogLevel ComputeEngine::Settings::GetThresholdLogLevel ( ) const
inline

◆ GetVariableTextMarkingType()

VariableTextMarkingType ComputeEngine::Settings::GetVariableTextMarkingType ( ) const
inline

◆ SetIdentity()

void ComputeEngine::Settings::SetIdentity ( const Identity & identity)
inline

◆ SetLoggerContext()

void ComputeEngine::Settings::SetLoggerContext ( const std::shared_ptr< void > & loggerContext)
inline

Sets the logger context that will be opaquely passed to the logger delegate for logs associated with the created engine.

Parameters
loggerContextThe logger context

◆ SetParentCorrelationId()

void ComputeEngine::Settings::SetParentCorrelationId ( const std::string correlationId,
const std::string description )
inline

◆ SetVariableTextMarkingType()

void ComputeEngine::Settings::SetVariableTextMarkingType ( VariableTextMarkingType variableTextMarkingType)
inline

Member Data Documentation

◆ mApplicationInfo

ApplicationInfo ComputeEngine::Settings::mApplicationInfo
private

◆ mAuditDelegate

std::shared_ptr<AuditDelegate> ComputeEngine::Settings::mAuditDelegate
private

◆ mConfiguredFunctionality

std::map<FunctionalityFilterType, bool> ComputeEngine::Settings::mConfiguredFunctionality
private

◆ mCustomProperties

std::vector<std::pair<std::string, std::string> > ComputeEngine::Settings::mCustomProperties
private

◆ mDeprecatedLabelFilters

std::vector<LabelFilterType> ComputeEngine::Settings::mDeprecatedLabelFilters
private

◆ mEventFactory

std::shared_ptr<DiagnosticEventFactory> ComputeEngine::Settings::mEventFactory
private

◆ mHostName

std::string ComputeEngine::Settings::mHostName
private

◆ mIdentity

Identity ComputeEngine::Settings::mIdentity
private

◆ mLoggerContext

std::shared_ptr<void> ComputeEngine::Settings::mLoggerContext
private

◆ mLoggerDelegate

std::shared_ptr<LoggerDelegate> ComputeEngine::Settings::mLoggerDelegate
private

◆ mParentCorrelationId

std::string ComputeEngine::Settings::mParentCorrelationId
private

◆ mParentCorrelationIdDescription

std::string ComputeEngine::Settings::mParentCorrelationIdDescription
private

◆ mTelemetryDelegate

std::shared_ptr<TelemetryDelegate> ComputeEngine::Settings::mTelemetryDelegate
private

◆ mThresholdLogLevel

LogLevel ComputeEngine::Settings::mThresholdLogLevel
private

◆ mVariableTextMarkingType

VariableTextMarkingType ComputeEngine::Settings::mVariableTextMarkingType = VariableTextMarkingType::Default
private

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