クラス FileEngine::Settings

  • [アーティクル]

まとめ

メンバー 説明
public 設定(const std::string& engineId, const std::shared_ptr<AuthDelegate& authDelegate>, const std::string& clientData, const std::string& locale, bool loadSensitivityTypes) 既存のエンジンを読み込むための FileEngine::設定 コンストラクター。
public 設定(const Identity& identity, const std::shared_ptr<AuthDelegate& authDelegate>, const std::string& clientData, const std::string& locale, bool loadSensitivityTypes) 新しいエンジンを作成するための FileProfile::設定 コンストラクター。
public const std::string& GetEngineId() const エンジン ID を返します。
public void SetEngineId(const std::string& id) エンジン ID を設定します。
public const Identity& GetIdentity() const エンジン ID を返します。
public void SetIdentity(const Identity& identity) エンジン ID を設定します。
public const std::string& GetClientData() const エンジン クライアント データを返します。
public const std::string& GetLocale() const エンジンロケールを返します。
public void SetCustom設定(const std::vector<std::p air<std::string, std::string>>& value) テストと実験に使用される名前と値のペアの一覧を設定します。
public const std::vector<std::p air<std::string, std::string>>& GetCustom設定() const テストと実験に使用される名前と値のペアの一覧を取得します。
public void SetSessionId(const std::string& sessionId) エンジン セッション ID を設定します。
public const std::string& GetSessionId() const エンジン セッション ID を返します。
public void SetCloud(Cloud cloud) 必要に応じて、ターゲット クラウドを設定します。
public Cloud GetCloud() const すべてのサービス要求で使用されるターゲット クラウドを取得します。
public void SetDataBoundary(DataBoundary dataBoundary) 必要に応じて、ターゲット診断リージョンを設定します。
public DataBoundary GetDataBoundary() const データ境界領域を取得します。
public void SetProtectionCloudEndpointBaseUrl(const std::string& protectionCloudEndpointBaseUrl) カスタム クラウドの保護クラウド エンドポイント ベース URL を設定します。
public const std::string& GetProtectionCloudEndpointBaseUrl() const 保護クラウド エンドポイント ベース URL を取得します。
public void SetPolicyCloudEndpointBaseUrl(const std::string& policyCloudEndpointBaseUrl) カスタム クラウドのポリシー クラウド エンドポイント ベース URL を設定します。
public const std::string& GetPolicyCloudEndpointBaseUrl() const ポリシー クラウド エンドポイント ベース URL を取得します。
public void SetProtectionOnlyEngine(bool protectionOnly) 保護のみのエンジン インジケーターを設定します。ポリシー/ラベルは設定しません。
public const bool IsProtectionOnlyEngine() const 保護のみのエンジン インジケーターを返します。ポリシー/ラベルはありません。
public bool IsLoadSensitivityTypesEnabled() const 読み込み秘密度ラベルが有効かどうかを示すフラグを取得します。
public void EnablePFile(bool value) PFile を生成するかどうかを示すフラグを設定します。
public const bool IsPFileEnabled() PFile を生成するかどうかを示すフラグを取得します。
public void SetDelegatedUserEmail(const std::string& delegatedUserEmail) 委任されたユーザーを設定します。
public const std::string& GetDelegatedUserEmail() const 委任されたユーザーを取得します。
public void SetLabelFilter(const std::vector<LabelFilterType>& deprecatedLabelFilters) ラベル フィルターを設定します。
public const std::vector<LabelFilterType>& GetLabelFilter() const 非推奨の関数 SetLabelFilter によって設定されたラベル フィルターを取得します。
public void ConfigureFunctionality(FunctionalityFilterType functionalityFilterType, bool enabled) 機能を有効または無効にします。
public const std::map<FunctionalityFilterType, bool>& GetConfiguredFunctionality() const 構成されている機能を取得します。
public void SetAuthDelegate(const std::shared_ptr<AuthDelegate>& authDelegate) エンジン認証デリゲートを設定します。
public std::shared_ptr<AuthDelegate> GetAuthDelegate() const エンジン認証デリゲートを取得します。
public const std::shared_ptr<void>& GetLoggerContext() const 作成されたエンジンに関連付けられているログのロガー デリゲートに非透過的に渡されるロガー コンテキストを取得します。
public void SetLoggerContext(const std::shared_ptr<void>& loggerContext) 作成されたエンジンに関連付けられているログのロガー デリゲートに非透過的に渡されるロガー コンテキストを設定します。

メンバー

Settings 関数

既存のエンジンを読み込むための FileEngine::設定 コンストラクター。

パラメーター:

  • engineId: AddEngineAsync によって生成された一意のエンジン ID に設定します。

  • authDelegate: 認証トークンを取得するために SDK によって使用される認証デリゲートは、PolicyProfile::Settings::authDelegate をオーバーライドします (両方指定されている場合)

  • clientData: アンロード時にエンジンと共に格納できるカスタマイズ可能なクライアント データは、読み込まれたエンジンから取得できます。

  • locale: エンジンのローカライズ可能な出力は、このロケールで提供されます。

  • loadSensitivityTypes: エンジンが読み込まれるときにカスタムの秘密度タイプも読み込む必要があることを示すオプション フラグ。true の場合、更新時にプロファイルの OnPolicyChange オブザーバーが呼び出され、秘密度タイプとポリシー変更をカスタマイズします。 false の場合、ListSensitivityTypes 呼び出しによって常に空のリストが返されます。

Settings 関数

新しいエンジンを作成するための FileProfile::設定 コンストラクター。

パラメーター:

  • ID: 新しいエンジンに関連付けられているユーザーの ID 情報。

  • authDelegate: 認証トークンを取得するために SDK によって使用される認証デリゲートは、PolicyProfile::Settings::authDelegate をオーバーライドします (両方指定されている場合)

  • clientData: アンロード時にエンジンと共に格納できるカスタマイズ可能なクライアント データは、読み込まれたエンジンから取得できます。

  • locale: エンジンのローカライズ可能な出力は、このロケールで提供されます。

  • loadSensitivityTypes: エンジンが読み込まれるときにカスタムの秘密度タイプも読み込む必要があることを示すオプション フラグ。true の場合、更新時にプロファイルの OnPolicyChange オブザーバーが呼び出され、秘密度タイプとポリシー変更をカスタマイズします。 false の場合、ListSensitivityTypes 呼び出しによって常に空のリストが返されます。

GetEngineId 関数

エンジン ID を返します。

SetEngineId 関数

エンジン ID を設定します。

パラメーター:

  • id: エンジン ID。

GetIdentity 関数

エンジン ID を返します。

SetIdentity 関数

エンジン ID を設定します。

GetClientData 関数

エンジン クライアント データを返します。

GetLocale 関数

エンジンロケールを返します。

SetCustomSettings 関数

テストと実験に使用される名前と値のペアの一覧を設定します。

GetCustomSettings 関数

テストと実験に使用される名前と値のペアの一覧を取得します。

SetSessionId 関数

エンジン セッション ID を設定します。

GetSessionId 関数

エンジン セッション ID を返します。

SetCloud 関数

必要に応じて、ターゲット クラウドを設定します。

パラメーター:

  • cloud: クラウド

cloud を指定しないと、既定ではグローバル クラウドになります。

GetCloud 関数

すべてのサービス要求で使用されるターゲット クラウドを取得します。

戻り値: クラウド

SetDataBoundary 関数

必要に応じて、ターゲット診断リージョンを設定します。

パラメーター:

  • dataBoundary: データ境界領域

dataBoundary が指定されていない場合、既定ではグローバル診断リージョンになります。

GetDataBoundary 関数

データ境界領域を取得します。

戻り値: DataBoundary

SetProtectionCloudEndpointBaseUrl 関数

カスタム クラウドの保護クラウド エンドポイント ベース URL を設定します。

パラメーター:

  • protectionCloudEndpointBaseUrl: 保護エンドポイントに関連付けられているベース URL

この値は読み取り専用で、Cloud = Custom の場合に設定する必要があります

GetProtectionCloudEndpointBaseUrl 関数

保護クラウド エンドポイント ベース URL を取得します。

戻り値: 保護エンドポイントに関連付けられたベース URL。この値は読み取り専用で、Cloud = Custom の場合に設定する必要があります

SetPolicyCloudEndpointBaseUrl 関数

カスタム クラウドのポリシー クラウド エンドポイント ベース URL を設定します。

パラメーター:

  • policyCloudEndpointBaseUrl: ポリシー エンドポイントに関連付けられたベース URL

GetPolicyCloudEndpointBaseUrl 関数

ポリシー クラウド エンドポイント ベース URL を取得します。

戻り値: ポリシー エンドポイントに関連付けられたベース URL

SetProtectionOnlyEngine 関数

保護のみのエンジン インジケーターを設定します。ポリシー/ラベルは設定しません。

IsProtectionOnlyEngine 関数

保護のみのエンジン インジケーターを返します。ポリシー/ラベルはありません。

IsLoadSensitivityTypesEnabled 関数

読み込み秘密度ラベルが有効かどうかを示すフラグを取得します。

戻り値: 有効な場合は true、それ以外の場合は false。

EnablePFile 関数

PFile を生成するかどうかを示すフラグを設定します。

IsPFileEnabled 関数

PFile を生成するかどうかを示すフラグを取得します。

戻り値: 有効な場合は true、それ以外の場合は false。

SetDelegatedUserEmail 関数

委任されたユーザーを設定します。

パラメーター:

  • delegatedUserEmail: 委任メール。

認証ユーザー/アプリケーションが別のユーザーに代わって機能している場合、委任されたユーザーを指定します

GetDelegatedUserEmail 関数

委任されたユーザーを取得します。

戻り値: 委任されたユーザー。認証ユーザー/アプリケーションが別のユーザーに代わって機能している場合、委任されたユーザーを指定します

SetLabelFilter 関数

ラベル フィルターを設定します。

パラメーター:

  • labelFilter: ラベル フィルター。

既定では、ラベルはスコープにフィルターを適用します。この API は、可能なアクションによるフィルター処理を許可します。 設定しないと、HyokProtection と DoubleKeyProtection がフィルター処理されます。

GetLabelFilter 関数

非推奨の関数 SetLabelFilter によって設定されたラベル フィルターを取得します。

戻り値: ラベル フィルター。 既定では、ラベルはスコープにフィルターを適用します。この API は、可能なアクションによるフィルター処理を許可します。

ConfigureFunctionality 関数

機能を有効または無効にします。

パラメーター:

  • functionalityFilterType: 機能の種類。

  • enabled: 有効にする場合は true、無効にする場合は false にします

既定では、HyokProtection、DoubleKeyProtection、DoubleKeyUserDefinedProtection は無効になっているので、有効にする必要があります

GetConfiguredFunctionality 関数

構成されている機能を取得します。

戻り値: 有効かどうかを示すブール値に対する型のマップ

SetAuthDelegate 関数

エンジン認証デリゲートを設定します。

パラメーター:

  • authDelegate: 認証デリゲート

GetAuthDelegate 関数

エンジン認証デリゲートを取得します。

戻り値: エンジン認証デリゲート。

GetLoggerContext 関数

作成されたエンジンに関連付けられているログのロガー デリゲートに非透過的に渡されるロガー コンテキストを取得します。

戻り値: ロガー コンテキスト

SetLoggerContext 関数

作成されたエンジンに関連付けられているログのロガー デリゲートに非透過的に渡されるロガー コンテキストを設定します。

パラメーター:

  • loggerContext: ロガー コンテキスト