ai.nightfall.scan.model

Class ScanTextRequest

java.lang.Object

ai.nightfall.scan.model.ScanTextRequest

public class ScanTextRequest
extends Object

An object representing a request to scan inline plaintext with the Nightfall API.

Constructor Summary

Constructors

Constructor and Description
ScanTextRequest(List<String> payload, List<UUID> policyUUIDs) Create a request to scan the provided payload against the provided policyUUIDs.
ScanTextRequest(List<String> payload, ScanTextConfig policy) Create a request to scan the provided payload against the provided scanning policy.

Method Summary

Modifier and Type	Method and Description
ScanTextConfig	getConfig() Deprecated. alias for getPolicy, just provided for backwards compatibility.
List<String>	getPayload() Get the request payload.
ScanTextConfig	getPolicy() Get the request scan policy.
List<UUID>	getPolicyUUIDs() Get the policy UUIDs to use when performing a scan.
void	setConfig(ScanTextConfig config) Deprecated. alias for setPolicy, just provided for backwards compatibility.
void	setPayload(List<String> payload) Set the request payload.
void	setPolicy(ScanTextConfig policy) Set the request scan policy.
void	setPolicyUUIDs(List<UUID> policyUUIDs) Set the policy UUIDs to use when performing a scan.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanTextRequest

public ScanTextRequest(List<String> payload,
                       ScanTextConfig policy)

Create a request to scan the provided payload against the provided scanning policy.

Parameters:

payload - the content to scan

policy - the configuration to use to scan the content

ScanTextRequest

public ScanTextRequest(List<String> payload,
                       List<UUID> policyUUIDs)

Create a request to scan the provided payload against the provided policyUUIDs.

Parameters:

payload - the content to scan

policyUUIDs - a list of UUIDs referring to pre-created policies to-be-used when scanning. Maximum 1.

Method Detail

getPayload

public List<String> getPayload()

Get the request payload.

Returns:

the request data to scan

setPayload

public void setPayload(List<String> payload)

Set the request payload.

Parameters:

payload - the request data to scan

getConfig

@Deprecated
public ScanTextConfig getConfig()

Deprecated. alias for getPolicy, just provided for backwards compatibility.

Get the request scan policy.

Returns:

the configuration to use to scan the payload data

getPolicy

public ScanTextConfig getPolicy()

Get the request scan policy.

Returns:

the configuration to use to scan the payload data

setConfig

@Deprecated
public void setConfig(ScanTextConfig config)

Deprecated. alias for setPolicy, just provided for backwards compatibility.

Set the request scan policy.

Parameters:

config - the configuration to use to scan the payload data

setPolicy

public void setPolicy(ScanTextConfig policy)

Set the request scan policy.

Parameters:

policy - the configuration to use to scan the payload data

getPolicyUUIDs

public List<UUID> getPolicyUUIDs()

Get the policy UUIDs to use when performing a scan.

Returns:

the policy UUIDs.

setPolicyUUIDs

public void setPolicyUUIDs(List<UUID> policyUUIDs)

Set the policy UUIDs to use when performing a scan.

Parameters:

policyUUIDs - the policy UUIDs.