Index (ai.nightfall:scan-api 1.0.3 API)

A B C D E F G H I L M N P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

ai.nightfall.scan - package ai.nightfall.scan
ai.nightfall.scan.model - package ai.nightfall.scan.model
ai.nightfall.scan.model.redaction - package ai.nightfall.scan.model.redaction
ALL - Enum constant in enum ai.nightfall.scan.model.LogicalOp
ANY - Enum constant in enum ai.nightfall.scan.model.LogicalOp

B

BaseNightfallException - Exception in ai.nightfall.scan.model: The super class for all exceptions thrown by Nightfall.
BaseNightfallException(String) - Constructor for exception ai.nightfall.scan.model.BaseNightfallException: Create a new exception.
build() - Method in class ai.nightfall.scan.NightfallClient.Builder: Builds the client using the configured values, falling back on defaults if any values were not explicitly set.
Builder() - Constructor for class ai.nightfall.scan.NightfallClient.Builder

C

close() - Method in class ai.nightfall.scan.NightfallClient: Closes this client and releases underlying system resources.
CompleteFileUploadRequest - Class in ai.nightfall.scan.model: The container object containing all parameters required to complete a file upload.
CompleteFileUploadRequest(UUID) - Constructor for class ai.nightfall.scan.model.CompleteFileUploadRequest: Constructs a new request to complete a file upload.
Confidence - Enum in ai.nightfall.scan.model: Confidence describes the certainty that a piece of content matches a detector.
ConfidenceAdjustment - Class in ai.nightfall.scan.model: Describes how to adjust confidence on a given finding.
ConfidenceAdjustment(Confidence) - Constructor for class ai.nightfall.scan.model.ConfidenceAdjustment: Create a ConfidenceAdjustment object.
ContextRule - Class in ai.nightfall.scan.model: An object that describes how a regular expression may be used to adjust the confidence of a candidate finding.
ContextRule(Regex, Proximity, ConfidenceAdjustment) - Constructor for class ai.nightfall.scan.model.ContextRule: Create a new Context Rule.
CryptoConfig - Class in ai.nightfall.scan.model.redaction: An object that specifies how findings should be encrypted when returned by the API.
CryptoConfig(String) - Constructor for class ai.nightfall.scan.model.redaction.CryptoConfig: Builds a configuration object with the provided PEM-formatted RSA public key.

D

defaultClient() - Static method in class ai.nightfall.scan.NightfallClient.Builder: Builds and returns the client with all default values.
DetectionRule - Class in ai.nightfall.scan.model: An object that contains a set of detectors to be used when scanning content.
DetectionRule(List<Detector>, LogicalOp) - Constructor for class ai.nightfall.scan.model.DetectionRule: Create a detection rule with the provided detectors and logicalOp.
DetectionRule(List<Detector>, LogicalOp, String) - Constructor for class ai.nightfall.scan.model.DetectionRule: Create a detection rule with the provided detectors and logicalOp.
Detector - Class in ai.nightfall.scan.model: An object that represents a data type or category of information.
Detector(Regex) - Constructor for class ai.nightfall.scan.model.Detector: Create an instance of a detector based on a regular expression.
Detector(WordList) - Constructor for class ai.nightfall.scan.model.Detector: Create an instance of a detector based on a word list.
Detector(String) - Constructor for class ai.nightfall.scan.model.Detector: Create an instance of a detector based on a pre-built Nightfall detector.
Detector(UUID) - Constructor for class ai.nightfall.scan.model.Detector: Create an instance of a detector by using an existing detector's UUID.
DetectorMetadata - Class in ai.nightfall.scan.model: A container for minimal information representing a detector.
DetectorMetadata() - Constructor for class ai.nightfall.scan.model.DetectorMetadata

E

equals(Object) - Method in class ai.nightfall.scan.model.NightfallErrorResponse
ExclusionRule - Class in ai.nightfall.scan.model: An object that describes a regular expression or list of keywords that may be used to disqualify a candidate finding from triggering a detector match.
ExclusionRule(Regex, String) - Constructor for class ai.nightfall.scan.model.ExclusionRule: Create an exclusion rule that uses a regular expression to make a disqualification decision.
ExclusionRule(WordList, String) - Constructor for class ai.nightfall.scan.model.ExclusionRule: Create an exclusion rule that uses a word list to make a disqualification decision.

F

FileScanWebhookNotification - Class in ai.nightfall.scan.model: The request payload that is sent by Nightfall to a client-configured webhook URL to report the findings from an asynchronous file scan.
FileScanWebhookNotification() - Constructor for class ai.nightfall.scan.model.FileScanWebhookNotification
FileUpload - Class in ai.nightfall.scan.model: An object representing a file upload.
FileUpload() - Constructor for class ai.nightfall.scan.model.FileUpload
Finding - Class in ai.nightfall.scan.model: An object representing an occurrence of a configured detector (i.e.
Finding() - Constructor for class ai.nightfall.scan.model.Finding
fromDetectionRules(List<DetectionRule>, int) - Static method in class ai.nightfall.scan.model.ScanTextConfig: Create a scan configuration with the provided detection rules.
fromDetectionRules(List<DetectionRule>, String) - Static method in class ai.nightfall.scan.model.ScanPolicy: Create a scan policy with the provided detection rules.
fromDetectionRuleUUIDs(List<UUID>, int) - Static method in class ai.nightfall.scan.model.ScanTextConfig: Create a scan configuration with the provided detection rules.
fromDetectionRuleUUIDs(List<UUID>, String) - Static method in class ai.nightfall.scan.model.ScanPolicy: Create a scan policy with the provided detection rules.

G

getAdditionalData() - Method in class ai.nightfall.scan.model.NightfallErrorResponse: Get supplemental error data.
getAfterContext() - Method in class ai.nightfall.scan.model.Finding: Get the trailing context.
getBeforeContext() - Method in class ai.nightfall.scan.model.Finding: Get the preceding context.
getByteRange() - Method in class ai.nightfall.scan.model.Location: Get the finding's byte range.
getCharsToIgnore() - Method in class ai.nightfall.scan.model.redaction.MaskConfig: Returns the characters to ignore during masking.
getChunkSize() - Method in class ai.nightfall.scan.model.FileUpload: Get the chunk size.
getCode() - Method in class ai.nightfall.scan.model.NightfallErrorResponse: Get the error code.
getCodepointRange() - Method in class ai.nightfall.scan.model.Location: Get the finding's codepoint range.
getConfidence() - Method in class ai.nightfall.scan.model.Finding: Get the finding confidence.
getConfidenceAdjustment() - Method in class ai.nightfall.scan.model.ContextRule: Return the confidence adjustment.
getConfig() - Method in class ai.nightfall.scan.model.ScanTextRequest: Get the request scan configuration.
getContent() - Method in class ai.nightfall.scan.model.UploadFileChunkRequest: Get the request payload.
getContextBytes() - Method in class ai.nightfall.scan.model.ScanTextConfig: Get the number of context bytes.
getContextRules() - Method in class ai.nightfall.scan.model.Detector: Get the context rules.
getCryptoConfig() - Method in class ai.nightfall.scan.model.redaction.RedactionConfig: Get the encryption configuration.
getDescription() - Method in class ai.nightfall.scan.model.NightfallErrorResponse: Get the error description.
getDetectionRules() - Method in class ai.nightfall.scan.model.ScanPolicy: Get the list of detection rules.
getDetectionRules() - Method in class ai.nightfall.scan.model.ScanTextConfig: Get the detection rule UUIDs.
getDetectionRuleUUIDs() - Method in class ai.nightfall.scan.model.ScanPolicy: Get the detection rule UUIDs.
getDetectionRuleUUIDs() - Method in class ai.nightfall.scan.model.ScanTextConfig: Get the detection rule UUIDs.
getDetector() - Method in class ai.nightfall.scan.model.Finding: Get the detector.
getDetectors() - Method in class ai.nightfall.scan.model.DetectionRule: Get the list of detectors.
getDetectorType() - Method in class ai.nightfall.scan.model.Detector: Get the detector type.
getDetectorUUID() - Method in class ai.nightfall.scan.model.Detector: Get the detector UUID.
getDisplayName() - Method in class ai.nightfall.scan.model.Detector: Get the display name.
getEnd() - Method in class ai.nightfall.scan.model.Location.Range: Get the end of the range.
getError() - Method in exception ai.nightfall.scan.model.NightfallAPIException: Get the error object returned by Nightfall.
getErrors() - Method in class ai.nightfall.scan.model.FileScanWebhookNotification: Get the list of errors that occurred while processing the request.
getExclusionRules() - Method in class ai.nightfall.scan.model.Detector: Get the exclusion rules.
getExclusionType() - Method in class ai.nightfall.scan.model.ExclusionRule: Get the exclusion type.
getFileID() - Method in class ai.nightfall.scan.model.FileUpload: Get the file ID.
getFileOffset() - Method in class ai.nightfall.scan.model.UploadFileChunkRequest: Get the file offset.
getFileSizeBytes() - Method in class ai.nightfall.scan.model.FileUpload: Get the file size.
getFileSizeBytes() - Method in class ai.nightfall.scan.model.InitializeFileUploadRequest: Get the file size.
getFileUploadID() - Method in class ai.nightfall.scan.model.CompleteFileUploadRequest: Returns the file ID.
getFileUploadID() - Method in class ai.nightfall.scan.model.UploadFileChunkRequest: Get the file ID.
getFinding() - Method in class ai.nightfall.scan.model.Finding: Get the finding.
getFindings() - Method in class ai.nightfall.scan.model.ScanTextResponse: Get the findings.
getFindingsURL() - Method in class ai.nightfall.scan.model.FileScanWebhookNotification: Get the findings URL.
getFixedConfidence() - Method in class ai.nightfall.scan.model.ConfidenceAdjustment: Return the confidence to adjust to.
getId() - Method in class ai.nightfall.scan.model.ScanFileResponse: Get the file ID.
getInfoTypeSubstitutionConfig() - Method in class ai.nightfall.scan.model.redaction.RedactionConfig: Get the info type substitution configuration.
getLocation() - Method in class ai.nightfall.scan.model.Finding: Get the location of the finding.
getLogicalOp() - Method in class ai.nightfall.scan.model.DetectionRule: Get the logical op.
getMaskConfig() - Method in class ai.nightfall.scan.model.redaction.RedactionConfig: Get the masking configuration.
getMaskingChar() - Method in class ai.nightfall.scan.model.redaction.MaskConfig: Returns the masking character.
getMatchedDetectionRules() - Method in class ai.nightfall.scan.model.Finding: Get the list of matched detection rules.
getMatchedDetectionRuleUUIDs() - Method in class ai.nightfall.scan.model.Finding: Get the list of matched detection rule UUIDs.
getMatchType() - Method in class ai.nightfall.scan.model.ExclusionRule: Get the match type.
getMessage() - Method in exception ai.nightfall.scan.model.NightfallAPIException
getMessage() - Method in class ai.nightfall.scan.model.NightfallErrorResponse: Get the error message.
getMessage() - Method in class ai.nightfall.scan.model.ScanFileResponse: Get the status message.
getMimeType() - Method in class ai.nightfall.scan.model.FileUpload: Get the mime type.
getMinConfidence() - Method in class ai.nightfall.scan.model.Detector: Return the minimum confidence.
getMinNumFindings() - Method in class ai.nightfall.scan.model.Detector: Get the minimum number of findings.
getName() - Method in class ai.nightfall.scan.model.DetectionRule: Get the name of the detection rule.
getName() - Method in class ai.nightfall.scan.model.DetectorMetadata: Get the detector name.
getNightfallDetector() - Method in class ai.nightfall.scan.model.Detector: Get the nightfall detector.
getNumCharsToLeaveUnmasked() - Method in class ai.nightfall.scan.model.redaction.MaskConfig: Returns the number of characters to leave unmasked, defaults to 0.
getPattern() - Method in class ai.nightfall.scan.model.Regex: Get the regex pattern.
getPayload() - Method in class ai.nightfall.scan.model.ScanTextRequest: Get the request payload.
getPolicy() - Method in class ai.nightfall.scan.model.ScanFileRequest: Get the policy.
getPolicyUUID() - Method in class ai.nightfall.scan.model.ScanFileRequest: Get the policy UUID.
getProximity() - Method in class ai.nightfall.scan.model.ContextRule: Return the proximity.
getPublicKey() - Method in class ai.nightfall.scan.model.redaction.CryptoConfig: Get the public key.
getRedactedFinding() - Method in class ai.nightfall.scan.model.Finding: Returns the redacted finding.
getRedactedLocation() - Method in class ai.nightfall.scan.model.Finding: Get the location that the redacted finding would occupy in the original content if it were to replace the finding.
getRedactedPayload() - Method in class ai.nightfall.scan.model.ScanTextResponse: Return the original request content with the configured redactions applied.
getRedactionConfig() - Method in class ai.nightfall.scan.model.Detector: Returns the redaction configuration to-be-applied to this detector.
getRegex() - Method in class ai.nightfall.scan.model.ContextRule: Return the regular expression.
getRegex() - Method in class ai.nightfall.scan.model.Detector: Get the regex.
getRegex() - Method in class ai.nightfall.scan.model.ExclusionRule: Get the regex.
getRequestMetadata() - Method in class ai.nightfall.scan.model.FileScanWebhookNotification: Get the request metadata.
getRequestMetadata() - Method in class ai.nightfall.scan.model.ScanFileRequest: Get the request metadata.
getStart() - Method in class ai.nightfall.scan.model.Location.Range: Get the beginning of the range.
getSubstitutionConfig() - Method in class ai.nightfall.scan.model.redaction.RedactionConfig: Get the substitution configuration.
getSubstitutionPhrase() - Method in class ai.nightfall.scan.model.redaction.SubstitutionConfig: Returns the substitution phrase.
getUploadID() - Method in class ai.nightfall.scan.model.FileScanWebhookNotification: Get the file ID.
getUuid() - Method in class ai.nightfall.scan.model.DetectorMetadata: Get the detector UUID.
getValidUntil() - Method in class ai.nightfall.scan.model.FileScanWebhookNotification: Get the findings URL expiry time.
getValues() - Method in class ai.nightfall.scan.model.WordList: Get the list of words.
getWebhookURL() - Method in class ai.nightfall.scan.model.ScanPolicy: Get the webhook URL.
getWindowAfter() - Method in class ai.nightfall.scan.model.Proximity: Get the number of trailing bytes.
getWindowBefore() - Method in class ai.nightfall.scan.model.Proximity: Get the number of leading bytes.
getWordList() - Method in class ai.nightfall.scan.model.Detector: Get the word list.
getWordList() - Method in class ai.nightfall.scan.model.ExclusionRule: Get the word list.

H

hashCode() - Method in class ai.nightfall.scan.model.NightfallErrorResponse

I

InfoTypeSubstitutionConfig - Class in ai.nightfall.scan.model.redaction: An object that specifies that findings should be substituted with the name of the info type that matched the request data.
InfoTypeSubstitutionConfig() - Constructor for class ai.nightfall.scan.model.redaction.InfoTypeSubstitutionConfig
InitializeFileUploadRequest - Class in ai.nightfall.scan.model: An object representing a request to upload a new file to Nightfall.
InitializeFileUploadRequest(long) - Constructor for class ai.nightfall.scan.model.InitializeFileUploadRequest: Create a new request to upload a file to Nightfall.
isCaseSensitive() - Method in class ai.nightfall.scan.model.Regex: Get whether the regex is case-sensitive.
isCaseSensitive() - Method in class ai.nightfall.scan.model.WordList: Get whether the words in the list are case-sensitive.
isFindingsPresent() - Method in class ai.nightfall.scan.model.FileScanWebhookNotification: Get whether findings are present.
isMaskLeftToRight() - Method in class ai.nightfall.scan.model.redaction.MaskConfig: Returns true if masking should be applied left-to-right, false otherwise.
isRemoveFinding() - Method in class ai.nightfall.scan.model.redaction.RedactionConfig: Returns whether the original finding should be omitted in responses from the API.

L

LIKELY - Enum constant in enum ai.nightfall.scan.model.Confidence
Location - Class in ai.nightfall.scan.model: An object representing where a finding was discovered in content.
Location() - Constructor for class ai.nightfall.scan.model.Location
Location.Range - Class in ai.nightfall.scan.model: An object that contains references to the start and end of the eponymous range.
LogicalOp - Enum in ai.nightfall.scan.model: A modifier that is used to decide when a finding should be surfaced in the context of a detection rule.

M

MaskConfig - Class in ai.nightfall.scan.model.redaction: An object that specifies how findings should be masked when returned by the API.
MaskConfig() - Constructor for class ai.nightfall.scan.model.redaction.MaskConfig: Default constructor; when no masking char is provided, defaults to '*'.
MaskConfig(String) - Constructor for class ai.nightfall.scan.model.redaction.MaskConfig: Builds a masking configuration with the provided masking character.
MaskConfig(String, String[]) - Constructor for class ai.nightfall.scan.model.redaction.MaskConfig: Builds a masking configuration with the provided masking character and characters to ignore.

N

NightfallAPIException - Exception in ai.nightfall.scan.model: The exception thrown when the Nightfall API returns an HTTP status code in the range [400, 599].
NightfallAPIException(String) - Constructor for exception ai.nightfall.scan.model.NightfallAPIException: Create a new instance of the exception.
NightfallAPIException(String, NightfallErrorResponse, int) - Constructor for exception ai.nightfall.scan.model.NightfallAPIException: Create a new instance of the exception.
NightfallClient - Class in ai.nightfall.scan: Provides a client for accessing the Nightfall Developer Platform.
NightfallClient.Builder - Class in ai.nightfall.scan: A builder class that configures, validates, then creates instances of a Nightfall Client.
NightfallClientException - Exception in ai.nightfall.scan.model: The exception thrown when the Nightfall client is unable to process a request due to an unexpected error.
NightfallClientException(String) - Constructor for exception ai.nightfall.scan.model.NightfallClientException: Create a new instance of this exception.
NightfallErrorResponse - Class in ai.nightfall.scan.model: The error model returned by Nightfall API requests that are unsuccessful.
NightfallErrorResponse() - Constructor for class ai.nightfall.scan.model.NightfallErrorResponse
NightfallErrorResponse(int, String, String, Map<String, String>) - Constructor for class ai.nightfall.scan.model.NightfallErrorResponse: Builds a new NightfallErrorResponse object.
NightfallRequestTimeoutException - Exception in ai.nightfall.scan.model: An exception that indicates that a timeout was exceeded while processing a request.
NightfallRequestTimeoutException(String) - Constructor for exception ai.nightfall.scan.model.NightfallRequestTimeoutException: Create a new instance of this exception.

P

POSSIBLE - Enum constant in enum ai.nightfall.scan.model.Confidence
Proximity - Class in ai.nightfall.scan.model: An object representing a range of bytes to consider around a candidate finding.
Proximity(int, int) - Constructor for class ai.nightfall.scan.model.Proximity: Construct a new Proximity.

R

Range() - Constructor for class ai.nightfall.scan.model.Location.Range
RedactionConfig - Class in ai.nightfall.scan.model.redaction: An object that configures how any detected findings should be redacted when returned to the client.
RedactionConfig(CryptoConfig) - Constructor for class ai.nightfall.scan.model.redaction.RedactionConfig: Build a redaction config with RSA encryption.
RedactionConfig(InfoTypeSubstitutionConfig) - Constructor for class ai.nightfall.scan.model.redaction.RedactionConfig: Build a redaction config with info type substitution.
RedactionConfig(MaskConfig) - Constructor for class ai.nightfall.scan.model.redaction.RedactionConfig: Build a redaction config with masking.
RedactionConfig(SubstitutionConfig) - Constructor for class ai.nightfall.scan.model.redaction.RedactionConfig: Build a redaction config with substitution.
Regex - Class in ai.nightfall.scan.model: An object representing a regular expression to customize the behavior of a detector while Nightfall performs a scan.
Regex(String, boolean) - Constructor for class ai.nightfall.scan.model.Regex: Creates a new Regex object.

S

scanFile(ScanFileRequest, InputStream, long) - Method in class ai.nightfall.scan.NightfallClient: A convenience method that abstracts the details of the multi-step file upload and scan process.
scanFile(ScanFileRequest, InputStream, long, Duration) - Method in class ai.nightfall.scan.NightfallClient: A convenience method that abstracts the details of the multi-step file upload and scan process.
ScanFileRequest - Class in ai.nightfall.scan.model: A container for a request to scan a file that was uploaded via the Nightfall API.
ScanFileRequest(ScanPolicy, String) - Constructor for class ai.nightfall.scan.model.ScanFileRequest: Create a new request to scan a file.
ScanFileRequest(UUID, String) - Constructor for class ai.nightfall.scan.model.ScanFileRequest: Create a new request to scan a file.
ScanFileResponse - Class in ai.nightfall.scan.model: The object returned by the Nightfall API when an (asynchronous) file scan request was successfully triggered.
ScanFileResponse() - Constructor for class ai.nightfall.scan.model.ScanFileResponse
ScanFileResponse(UUID, String) - Constructor for class ai.nightfall.scan.model.ScanFileResponse: Construct a new ScanFileResponse object.
ScanPolicy - Class in ai.nightfall.scan.model: An object containing configuration that describes how to scan a file.
ScanPolicy(String, List<DetectionRule>, List<UUID>) - Constructor for class ai.nightfall.scan.model.ScanPolicy: Create a scan policy with the provided detection rules and detection rule UUIDs.
scanText(ScanTextRequest) - Method in class ai.nightfall.scan.NightfallClient: Scans the provided plaintext against the provided detectors, and returns all findings.
ScanTextConfig - Class in ai.nightfall.scan.model: The configuration object to use when scanning inline plaintext with the Nightfall API.
ScanTextConfig(List<UUID>, List<DetectionRule>, int) - Constructor for class ai.nightfall.scan.model.ScanTextConfig: Create a scan configuration with the provided inline detection rules and detection rule UUIDs.
ScanTextRequest - Class in ai.nightfall.scan.model: An object representing a request to scan inline plaintext with the Nightfall API.
ScanTextRequest(List<String>, ScanTextConfig) - Constructor for class ai.nightfall.scan.model.ScanTextRequest: Create a request to scan the provided payload against the provided scanning configuration config.
ScanTextResponse - Class in ai.nightfall.scan.model: The response object returned by a text scan request.
ScanTextResponse() - Constructor for class ai.nightfall.scan.model.ScanTextResponse
setCharsToIgnore(String[]) - Method in class ai.nightfall.scan.model.redaction.MaskConfig: Sets the characters to ignore during masking.
setConfig(ScanTextConfig) - Method in class ai.nightfall.scan.model.ScanTextRequest: Set the request scan configuration.
setContent(byte[]) - Method in class ai.nightfall.scan.model.UploadFileChunkRequest: Set the request payload.
setContextBytes(int) - Method in class ai.nightfall.scan.model.ScanTextConfig: Set the number of context bytes.
setContextRules(List<ContextRule>) - Method in class ai.nightfall.scan.model.Detector: Set the context rules.
setDetectionRules(List<DetectionRule>) - Method in class ai.nightfall.scan.model.ScanPolicy: Set the detection rules.
setDetectionRules(List<DetectionRule>) - Method in class ai.nightfall.scan.model.ScanTextConfig: Set the detection rules.
setDetectionRuleUUIDs(List<UUID>) - Method in class ai.nightfall.scan.model.ScanPolicy: Set the detection rule UUIDs.
setDetectionRuleUUIDs(List<UUID>) - Method in class ai.nightfall.scan.model.ScanTextConfig: Set the detection rule UUIDs.
setDetectors(List<Detector>) - Method in class ai.nightfall.scan.model.DetectionRule: Set the detectors.
setDisplayName(String) - Method in class ai.nightfall.scan.model.Detector: Set the display name.
setExclusionRules(List<ExclusionRule>) - Method in class ai.nightfall.scan.model.Detector: Set the exclusion rules.
setFileUploadID(UUID) - Method in class ai.nightfall.scan.model.CompleteFileUploadRequest: Sets the file ID.
setLogicalOp(LogicalOp) - Method in class ai.nightfall.scan.model.DetectionRule: Set the logical op.
setMaskingChar(String) - Method in class ai.nightfall.scan.model.redaction.MaskConfig: Sets the masking character.
setMaskLeftToRight(boolean) - Method in class ai.nightfall.scan.model.redaction.MaskConfig: Sets whether masking should be applied left-to-right.
setMinConfidence(Confidence) - Method in class ai.nightfall.scan.model.Detector: Set the minimum confidence.
setMinNumFindings(int) - Method in class ai.nightfall.scan.model.Detector: Set the minimum number of findings.
setName(String) - Method in class ai.nightfall.scan.model.DetectionRule: Set the detection rule name.
setNumCharsToLeaveUnmasked(int) - Method in class ai.nightfall.scan.model.redaction.MaskConfig: Sets the number of characters to leave unmasked.
setPayload(List<String>) - Method in class ai.nightfall.scan.model.ScanTextRequest: Set the request payload.
setPublicKey(String) - Method in class ai.nightfall.scan.model.redaction.CryptoConfig: Set the public key.
setRedactionConfig(RedactionConfig) - Method in class ai.nightfall.scan.model.Detector: Sets the redaction configuration to-be-applied to this detector.
setRemoveFinding(boolean) - Method in class ai.nightfall.scan.model.redaction.RedactionConfig: Sets whether the original finding should be omitted in responses from the API.
setRequestMetadata(String) - Method in class ai.nightfall.scan.model.ScanFileRequest: Set the request metadata.
setSubstitutionPhrase(String) - Method in class ai.nightfall.scan.model.redaction.SubstitutionConfig: Sets the substitution phrase.
setWebhookURL(String) - Method in class ai.nightfall.scan.model.ScanPolicy: Set the webhook URL.
SubstitutionConfig - Class in ai.nightfall.scan.model.redaction: An object that specifies how findings should be substituted when returned by the API.
SubstitutionConfig(String) - Constructor for class ai.nightfall.scan.model.redaction.SubstitutionConfig: Builds a substitution configuration with the provided phrase.

T

toString() - Method in class ai.nightfall.scan.model.DetectionRule
toString() - Method in class ai.nightfall.scan.model.Detector
toString() - Method in class ai.nightfall.scan.model.DetectorMetadata
toString() - Method in class ai.nightfall.scan.model.Finding
toString() - Method in class ai.nightfall.scan.model.Location.Range
toString() - Method in class ai.nightfall.scan.model.Location
toString() - Method in exception ai.nightfall.scan.model.NightfallAPIException
toString() - Method in class ai.nightfall.scan.model.NightfallErrorResponse
toString() - Method in class ai.nightfall.scan.model.redaction.CryptoConfig
toString() - Method in class ai.nightfall.scan.model.redaction.InfoTypeSubstitutionConfig
toString() - Method in class ai.nightfall.scan.model.redaction.MaskConfig
toString() - Method in class ai.nightfall.scan.model.redaction.RedactionConfig
toString() - Method in class ai.nightfall.scan.model.redaction.SubstitutionConfig
toString() - Method in class ai.nightfall.scan.model.ScanFileResponse
toString() - Method in class ai.nightfall.scan.model.ScanTextConfig
toString() - Method in class ai.nightfall.scan.model.ScanTextResponse

U

UNLIKELY - Enum constant in enum ai.nightfall.scan.model.Confidence
UploadFileChunkRequest - Class in ai.nightfall.scan.model: An object representing a request to upload a chunk of file data to the Nightfall API.
UploadFileChunkRequest(UUID, long) - Constructor for class ai.nightfall.scan.model.UploadFileChunkRequest: Create a new instance of a file chunk upload request.
UploadFileChunkRequest(UUID, long, byte[]) - Constructor for class ai.nightfall.scan.model.UploadFileChunkRequest: Create a new instance of a file chunk upload request.

V

validate(String, byte[], String, String) - Method in class ai.nightfall.scan.WebhookSignatureValidator: Validates that the provided request payload is an authentic request that originated from Nightfall.
valueOf(String) - Static method in enum ai.nightfall.scan.model.Confidence: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum ai.nightfall.scan.model.LogicalOp: Returns the enum constant of this type with the specified name.
values() - Static method in enum ai.nightfall.scan.model.Confidence: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum ai.nightfall.scan.model.LogicalOp: Returns an array containing the constants of this enum type, in the order they are declared.
VERY_LIKELY - Enum constant in enum ai.nightfall.scan.model.Confidence
VERY_UNLIKELY - Enum constant in enum ai.nightfall.scan.model.Confidence

W

WebhookSignatureValidator - Class in ai.nightfall.scan: A class that implements Nightfall webhook signature validation.
WebhookSignatureValidator() - Constructor for class ai.nightfall.scan.WebhookSignatureValidator: Instantiates the validator with the default threshold.
WebhookSignatureValidator(TemporalAmount) - Constructor for class ai.nightfall.scan.WebhookSignatureValidator: Instantiates the validator with the provided threshold.
withAPIKey(String) - Method in class ai.nightfall.scan.NightfallClient.Builder: Sets the API key for the Nightfall Client.
withConnectionTimeout(Duration) - Method in class ai.nightfall.scan.NightfallClient.Builder: Sets the connection timeout for the underlying HTTP client.
withFileUploadConcurrency(int) - Method in class ai.nightfall.scan.NightfallClient.Builder: Sets the concurrency for file upload operations.
withKeepAliveDuration(Duration) - Method in class ai.nightfall.scan.NightfallClient.Builder: Sets the keep-alive duration for a connection in the underlying HTTP connection pool.
withMaxIdleConnections(int) - Method in class ai.nightfall.scan.NightfallClient.Builder: Sets the maximum number of idle connections in the underlying HTTP client.
withReadTimeout(Duration) - Method in class ai.nightfall.scan.NightfallClient.Builder: Sets the read timeout for the underlying HTTP client.
withWriteTimeout(Duration) - Method in class ai.nightfall.scan.NightfallClient.Builder: Sets the write timeout for the underlying HTTP client.
WordList - Class in ai.nightfall.scan.model: A list of words that can be used to customize the behavior of a detector while Nightfall performs a scan.
WordList(List<String>, boolean) - Constructor for class ai.nightfall.scan.model.WordList: Creates a new WordList object.

A B C D E F G H I L M N P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form