ai.nightfall.scan.model

Class ScanTextConfig

java.lang.Object

ai.nightfall.scan.model.ScanTextConfig

public class ScanTextConfig
extends Object

The configuration object to use when scanning inline plaintext with the Nightfall API.

Constructor Summary

Constructors

Constructor and Description
ScanTextConfig(List<UUID> detectionRuleUUIDs, List<DetectionRule> detectionRules, int contextBytes) Create a scan configuration with the provided inline detection rules and detection rule UUIDs.
ScanTextConfig(List<UUID> detectionRuleUUIDs, List<DetectionRule> detectionRules, int contextBytes, RedactionConfig defaultRedactionConfig) Create a scan configuration with the provided inline detection rules and detection rule UUIDs.

Method Summary

Modifier and Type	Method and Description
static ScanTextConfig	fromDetectionRules(List<DetectionRule> detectionRules, int contextBytes) Create a scan configuration with the provided detection rules.
static ScanTextConfig	fromDetectionRuleUUIDs(List<UUID> detectionRuleUUIDs, int contextBytes) Create a scan configuration with the provided detection rules.
AlertConfig	getAlertConfig() Get the alert configuration that specifies where alerts should be delivered when findings are detected.
int	getContextBytes() Get the number of context bytes.
RedactionConfig	getDefaultRedactionConfig() Get the default redaction configuration to-be-applied to all detection rules, unless a more specific redaction configuration is supplied at the detector level.
List<DetectionRule>	getDetectionRules() Get the detection rule UUIDs.
List<UUID>	getDetectionRuleUUIDs() Get the detection rule UUIDs.
void	setAlertConfig(AlertConfig alertConfig) Sets the alert configuration that specifies where alerts should be delivered when findings are detected.
void	setContextBytes(int contextBytes) Set the number of context bytes.
void	setDefaultRedactionConfig(RedactionConfig defaultRedactionConfig) Set the default redaction configuration to-be-applied to all detection rules, unless a more specific redaction configuration is supplied at the detector level.
void	setDetectionRules(List<DetectionRule> detectionRules) Set the detection rules.
void	setDetectionRuleUUIDs(List<UUID> detectionRuleUUIDs) Set the detection rule UUIDs.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ScanTextConfig

public ScanTextConfig(List<UUID> detectionRuleUUIDs,
                      List<DetectionRule> detectionRules,
                      int contextBytes)

Create a scan configuration with the provided inline detection rules and detection rule UUIDs.

Parameters:

detectionRuleUUIDs - a list of detection rules to use to scan content (maximum length 10)

detectionRules - a list of detection rules to use to scan content (maximum length 10)

contextBytes - the number of bytes of context (leading and trailing) to return with any matched findings

ScanTextConfig

public ScanTextConfig(List<UUID> detectionRuleUUIDs,
                      List<DetectionRule> detectionRules,
                      int contextBytes,
                      RedactionConfig defaultRedactionConfig)

Create a scan configuration with the provided inline detection rules and detection rule UUIDs.

Parameters:

detectionRuleUUIDs - a list of detection rules to use to scan content (maximum length 10)

detectionRules - a list of detection rules to use to scan content (maximum length 10)

contextBytes - the number of bytes of context (leading and trailing) to return with any matched findings

defaultRedactionConfig - the default redaction configuration to apply to all detection rules

Method Detail

fromDetectionRuleUUIDs

public static ScanTextConfig fromDetectionRuleUUIDs(List<UUID> detectionRuleUUIDs,
                                                    int contextBytes)

Create a scan configuration with the provided detection rules.

Parameters:

detectionRuleUUIDs - a list of detection rules to use to scan content (maximum length 10)

contextBytes - the number of bytes of context (leading and trailing) to return with any matched findings

Returns:

the scan configuration

fromDetectionRules

public static ScanTextConfig fromDetectionRules(List<DetectionRule> detectionRules,
                                                int contextBytes)

Create a scan configuration with the provided detection rules.

Parameters:

detectionRules - a list of detection rules to use to scan content (maximum length 10)

contextBytes - the number of bytes of context (leading and trailing) to return with any matched findings

Returns:

the scan configuration

getDetectionRuleUUIDs

public List<UUID> getDetectionRuleUUIDs()

Get the detection rule UUIDs.

Returns:

the detection rule UUIDs to use to scan the file

setDetectionRuleUUIDs

public void setDetectionRuleUUIDs(List<UUID> detectionRuleUUIDs)

Set the detection rule UUIDs.

Parameters:

detectionRuleUUIDs - the detection rule UUIDs to use to scan the file

getDetectionRules

public List<DetectionRule> getDetectionRules()

Get the detection rule UUIDs.

Returns:

the detection rules to use to scan the file

setDetectionRules

public void setDetectionRules(List<DetectionRule> detectionRules)

Set the detection rules.

Parameters:

detectionRules - the detection rules to use to scan the file

getContextBytes

public int getContextBytes()

Get the number of context bytes.

Returns:

the number of bytes of context (leading and trailing) to return with any matched findings

setContextBytes

public void setContextBytes(int contextBytes)

Set the number of context bytes.

Parameters:

contextBytes - the number of bytes of context (leading and trailing) to return with any matched findings

getDefaultRedactionConfig

public RedactionConfig getDefaultRedactionConfig()

Get the default redaction configuration to-be-applied to all detection rules, unless a more specific redaction configuration is supplied at the detector level.

Returns:

the default redaction configuration

setDefaultRedactionConfig

public void setDefaultRedactionConfig(RedactionConfig defaultRedactionConfig)

Set the default redaction configuration to-be-applied to all detection rules, unless a more specific redaction configuration is supplied at the detector level.

Parameters:

defaultRedactionConfig - the default redaction configuration

getAlertConfig

public AlertConfig getAlertConfig()

Get the alert configuration that specifies where alerts should be delivered when findings are detected.

Returns:

the alert configuration

setAlertConfig

public void setAlertConfig(AlertConfig alertConfig)

Sets the alert configuration that specifies where alerts should be delivered when findings are detected.

Parameters:

alertConfig - the alert configuration

toString

public String toString()

Overrides:

toString in class Object