Package ai.nightfall.scan.model

Class Finding

java.lang.Object
ai.nightfall.scan.model.Finding
public class Finding extends Object
An object representing an occurrence of a configured detector (i.e. finding) in the provided data.

  • Constructor Details

    • Finding

      public Finding()

  • Method Details

    • getFinding

      public String getFinding()
      Get the finding.
      Returns:
      the data that triggered a detector match

    • getRedactedFinding

      public String getRedactedFinding()
      Returns the redacted finding. This will only be non-empty if redaction configuration was provided as part of the request payload.
      Returns:
      the redacted finding

    • getBeforeContext

      public String getBeforeContext()
      Get the preceding context.
      Returns:
      the data that immediately preceded the finding

    • getAfterContext

      public String getAfterContext()
      Get the trailing context.
      Returns:
      the data that immediately succeeded the finding

    • getDetector

      public DetectorMetadata getDetector()
      Get the detector.
      Returns:
      the detector that triggered the match

    • getConfidence

      public String getConfidence()
      Get the finding confidence.
      Returns:
      the confidence that the data contained in finding is an instance of the matched detector

    • getLocation

      public Location getLocation()
      Get the location of the finding.
      Returns:
      the location where the data was in the original content

    • getRedactedLocation

      public Location getRedactedLocation()
      Get the location that the redacted finding would occupy in the original content if it were to replace the finding.
      Returns:
      the location that the data occupies in its redacted form with regard to the original content

    • getMatchedDetectionRuleUUIDs

      public List<UUID> getMatchedDetectionRuleUUIDs()
      Get the list of matched detection rule UUIDs.
      Returns:
      the list of detection rule UUIDs that contained a detector that triggered a match

    • getMatchedDetectionRules

      public List<String> getMatchedDetectionRules()
      Get the list of matched detection rules.
      Returns:
      the list of inline detection rules that contained a detector that triggered a match

    • toString

      public String toString()
      Overrides:
      toString in class Object