ai.nightfall.scan.model

Class NightfallErrorResponse

java.lang.Object

ai.nightfall.scan.model.NightfallErrorResponse

public class NightfallErrorResponse
extends Object

The error model returned by Nightfall API requests that are unsuccessful. This object is generally returned when the HTTP status code is outside the range 200-299.

Constructor Summary

Constructors

Constructor and Description
NightfallErrorResponse()
NightfallErrorResponse(int code, String message, String description, Map<String,String> additionalData) Builds a new NightfallErrorResponse object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Map<String,String>	getAdditionalData() Get supplemental error data.
int	getCode() Get the error code.
String	getDescription() Get the error description.
String	getMessage() Get the error message.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NightfallErrorResponse

public NightfallErrorResponse()

NightfallErrorResponse

public NightfallErrorResponse(int code,
                              String message,
                              String description,
                              Map<String,String> additionalData)

Builds a new NightfallErrorResponse object.

Parameters:

code - the error code

message - the error message

description - further description

additionalData - a map of key-value pairs that contain even further debugging information

Method Detail

getCode

public int getCode()

Get the error code.

Returns:

the error code returned by the API

getMessage

public String getMessage()

Get the error message.

Returns:

the error message returned by the API

getDescription

public String getDescription()

Get the error description.

Returns:

additional details describing the circumstance surrounding the error

getAdditionalData

public Map<String,String> getAdditionalData()

Get supplemental error data.

Returns:

supplemental data that may be useful in debugging the error message

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object