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

#include <compute_engine.h>

Classes

class  Settings
 

Public Member Functions

virtual const std::vector< std::shared_ptr< Label > > ListSensitivityLabels (const std::vector< std::string > &contentFormats=std::vector< std::string >())=0
 
virtual std::shared_ptr< ContentLabelGetSensitivityLabel (ComputeEngineContext &context, const DocumentState &state)=0
 
virtual std::vector< std::shared_ptr< Action > > ComputeActions (ComputeEngineContext &context, const DocumentState &documentState, const ApplicationActionState &actionState)=0
 
virtual std::pair< std::vector< std::shared_ptr< Action > >, bool > ComputeActionsWithRemoteState (ComputeEngineContext &context, const DocumentState &localDocumentState, const DocumentState &remoteDocumentState, const ApplicationActionState &actionState)=0
 Computes actions while choosing between remote and local state.
 
virtual void NotifyCommittedActions (ComputeEngineContext &context, const DocumentState &documentState, const ApplicationActionState &actionState)=0
 
virtual const std::shared_ptr< LabelGetDefaultLabel (const std::string &contentFormat=std::string()) const =0
 
virtual const std::string & GetMoreInfoUrl () const =0
 
virtual const std::string & GetUpn () const =0
 
virtual bool IsLabelingRequired (const std::string &contentFormat=std::string()) const =0
 
virtual bool IsDowngradeJustificationRequired () const =0
 
virtual const std::string & GetFileId () const =0
 
virtual bool HasClassificationRules (const std::vector< std::string > &contentFormats=std::vector< std::string >()) const =0
 
virtual bool IsEnhancedClassificationEnabled () const =0
 
virtual std::shared_ptr< LabelGetLabelById (const std::string &id) const =0
 
virtual const std::string & GetTenantId () const =0
 
virtual void SetSensitivityTypesRulePackages (std::vector< std::shared_ptr< SensitivityTypesRulePackage > > &&custom)=0
 
virtual const std::vector< std::shared_ptr< SensitivityTypesRulePackage > > & GetSensitivityTypesRulePackages () const =0
 
virtual const std::vector< std::pair< std::string, std::string > > & GetCustomSettings () const =0
 
virtual uint32_t GetOpcMetadataVersion () const =0
 
virtual const std::string & GetUserObjectId () const =0
 
virtual bool HasWorkloadConsent (Workload workload) const =0
 
virtual ~ComputeEngine ()
 

Static Public Member Functions

static MIP_UPE_CORE_API std::shared_ptr< ComputeEngineCreate (const SyncFilePolicyData &policyData, const ComputeEngine::Settings &settings)
 
static MIP_UPE_CORE_API std::shared_ptr< ComputeEngineContextCreateContext (const std::map< FlightingFeature, bool > &flightingFeatures, bool isAuditDiscoveryEnabled)
 

Constructor & Destructor Documentation

◆ ~ComputeEngine()

virtual ComputeEngine::~ComputeEngine ( )
inlinevirtual

Member Function Documentation

◆ ComputeActions()

virtual std::vector< std::shared_ptr< Action > > ComputeEngine::ComputeActions ( ComputeEngineContext & context,
const DocumentState & documentState,
const ApplicationActionState & actionState )
pure virtual

◆ ComputeActionsWithRemoteState()

virtual std::pair< std::vector< std::shared_ptr< Action > >, bool > ComputeEngine::ComputeActionsWithRemoteState ( ComputeEngineContext & context,
const DocumentState & localDocumentState,
const DocumentState & remoteDocumentState,
const ApplicationActionState & actionState )
pure virtual

Computes actions while choosing between remote and local state.

State is selected using this priority. Unknown protection types, (template or ad-hoc not in the policy). Protection state is always preferable to unprotected state. Document state with label is preferred above one without. Label order, higher is preferred. Label timestamp, prefer newest labelled document. DocumentState LastModifiedTime optionally implemented, prefer newly modified file.

Parameters
contextComput engine context.
localDocumentStateLocal document state.
remoteDocumentStateRemote document state.
actionStateThe application's action state.
Returns
Methods return a pair. first contains a list of the action the second is whether it should be applied on the local, if false actions should be applied on the remote document and that document state should be used.

◆ Create()

static MIP_UPE_CORE_API std::shared_ptr< ComputeEngine > ComputeEngine::Create ( const SyncFilePolicyData & policyData,
const ComputeEngine::Settings & settings )
static

◆ CreateContext()

static MIP_UPE_CORE_API std::shared_ptr< ComputeEngineContext > ComputeEngine::CreateContext ( const std::map< FlightingFeature, bool > & flightingFeatures,
bool isAuditDiscoveryEnabled )
static

◆ GetCustomSettings()

virtual const std::vector< std::pair< std::string, std::string > > & ComputeEngine::GetCustomSettings ( ) const
pure virtual

◆ GetDefaultLabel()

virtual const std::shared_ptr< Label > ComputeEngine::GetDefaultLabel ( const std::string & contentFormat = std::string()) const
pure virtual

◆ GetFileId()

virtual const std::string & ComputeEngine::GetFileId ( ) const
pure virtual

◆ GetLabelById()

virtual std::shared_ptr< Label > ComputeEngine::GetLabelById ( const std::string & id) const
pure virtual

◆ GetMoreInfoUrl()

virtual const std::string & ComputeEngine::GetMoreInfoUrl ( ) const
pure virtual

◆ GetOpcMetadataVersion()

virtual uint32_t ComputeEngine::GetOpcMetadataVersion ( ) const
pure virtual

◆ GetSensitivityLabel()

virtual std::shared_ptr< ContentLabel > ComputeEngine::GetSensitivityLabel ( ComputeEngineContext & context,
const DocumentState & state )
pure virtual

◆ GetSensitivityTypesRulePackages()

virtual const std::vector< std::shared_ptr< SensitivityTypesRulePackage > > & ComputeEngine::GetSensitivityTypesRulePackages ( ) const
pure virtual

◆ GetTenantId()

virtual const std::string & ComputeEngine::GetTenantId ( ) const
pure virtual

◆ GetUpn()

virtual const std::string & ComputeEngine::GetUpn ( ) const
pure virtual

◆ GetUserObjectId()

virtual const std::string & ComputeEngine::GetUserObjectId ( ) const
pure virtual

◆ HasClassificationRules()

virtual bool ComputeEngine::HasClassificationRules ( const std::vector< std::string > & contentFormats = std::vector< std::string >()) const
pure virtual

◆ HasWorkloadConsent()

virtual bool ComputeEngine::HasWorkloadConsent ( Workload workload) const
pure virtual

◆ IsDowngradeJustificationRequired()

virtual bool ComputeEngine::IsDowngradeJustificationRequired ( ) const
pure virtual

◆ IsEnhancedClassificationEnabled()

virtual bool ComputeEngine::IsEnhancedClassificationEnabled ( ) const
pure virtual

◆ IsLabelingRequired()

virtual bool ComputeEngine::IsLabelingRequired ( const std::string & contentFormat = std::string()) const
pure virtual

◆ ListSensitivityLabels()

virtual const std::vector< std::shared_ptr< Label > > ComputeEngine::ListSensitivityLabels ( const std::vector< std::string > & contentFormats = std::vector< std::string >())
pure virtual

◆ NotifyCommittedActions()

virtual void ComputeEngine::NotifyCommittedActions ( ComputeEngineContext & context,
const DocumentState & documentState,
const ApplicationActionState & actionState )
pure virtual

◆ SetSensitivityTypesRulePackages()

virtual void ComputeEngine::SetSensitivityTypesRulePackages ( std::vector< std::shared_ptr< SensitivityTypesRulePackage > > && custom)
pure virtual

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