ai.nightfall.scan.model

Class FileScanWebhookNotification

java.lang.Object

ai.nightfall.scan.model.FileScanWebhookNotification

public class FileScanWebhookNotification
extends Object

The request payload that is sent by Nightfall to a client-configured webhook URL to report the findings from an asynchronous file scan. The findings themselves live in an external location referred to by findingsURL, and will remain accessible until the time described by the field validUntil.

The findingsURL must be considered sensitive; although the data stored at the URL is secure, the URL itself grants a temporary lease so that anyone with the link may download the data.

Constructor Summary

Constructors

Constructor and Description
FileScanWebhookNotification()

Method Summary

Modifier and Type	Method and Description
List<NightfallErrorResponse>	getErrors() Get the list of errors that occurred while processing the request.
String	getFindingsURL() Get the findings URL.
String	getRequestMetadata() Get the request metadata.
UUID	getUploadID() Get the file ID.
Date	getValidUntil() Get the findings URL expiry time.
boolean	isFindingsPresent() Get whether findings are present.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileScanWebhookNotification

public FileScanWebhookNotification()

Method Detail

getFindingsURL

public String getFindingsURL()

Get the findings URL.

Returns:

a URL referring to the location where findings may be downloaded from

getValidUntil

public Date getValidUntil()

Get the findings URL expiry time.

Returns:

the point in time when the provided findings URL expires. After this date elapses, the findings will no longer be accessible via this URL.

getUploadID

public UUID getUploadID()

Get the file ID.

Returns:

the file ID associated with these scan results

isFindingsPresent

public boolean isFindingsPresent()

Get whether findings are present.

Returns:

true if and only if any findings were detected in the file represented by uploadID, otherwise false.

getRequestMetadata

public String getRequestMetadata()

Get the request metadata.

Returns:

the metadata that the client provided with the initial request, often used for correlating the file that this scan result represents.

getErrors

public List<NightfallErrorResponse> getErrors()

Get the list of errors that occurred while processing the request.

Returns:

a list of errors that was encountered by the API while scanning the file.