ai.nightfall.scan.model

Class ScanFileResponse

java.lang.Object

ai.nightfall.scan.model.ScanFileResponse

public class ScanFileResponse
extends Object

The object returned by the Nightfall API when an (asynchronous) file scan request was successfully triggered.

Constructor Summary

Constructors

Constructor and Description
ScanFileResponse()
ScanFileResponse(UUID id, String message) Construct a new ScanFileResponse object.

Method Summary

Modifier and Type	Method and Description
UUID	getId() Get the file ID.
String	getMessage() Get the status message.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanFileResponse

public ScanFileResponse()

ScanFileResponse

public ScanFileResponse(UUID id,
                        String message)

Construct a new ScanFileResponse object.

Parameters:

id - the ID of the file to-be-scanned

message - the status message

Method Detail

getId

public UUID getId()

Get the file ID.

Returns:

the ID of the file whose scan was triggered

getMessage

public String getMessage()

Get the status message.

Returns:

a status message describing the file scan

toString

public String toString()

Overrides:

toString in class Object