com.plaid.client.model

Class EntityScreeningHitAnalysis

java.lang.Object

com.plaid.client.model.EntityScreeningHitAnalysis

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class EntityScreeningHitAnalysis
extends Object

Analysis information describing why a screening hit matched the provided entity information

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_DOCUMENTS
static String	SERIALIZED_NAME_EMAIL_ADDRESSES
static String	SERIALIZED_NAME_LOCATIONS
static String	SERIALIZED_NAME_NAMES
static String	SERIALIZED_NAME_PHONE_NUMBERS
static String	SERIALIZED_NAME_SEARCH_TERMS_VERSION
static String	SERIALIZED_NAME_URLS

Constructor Summary

Constructors

Constructor and Description
EntityScreeningHitAnalysis()

Method Summary

Modifier and Type	Method and Description
EntityScreeningHitAnalysis	documents(MatchSummaryCode documents)
EntityScreeningHitAnalysis	emailAddresses(MatchSummaryCode emailAddresses)
boolean	equals(Object o)
MatchSummaryCode	getDocuments() Get documents
MatchSummaryCode	getEmailAddresses() Get emailAddresses
MatchSummaryCode	getLocations() Get locations
MatchSummaryCode	getNames() Get names
MatchSummaryCode	getPhoneNumbers() Get phoneNumbers
Integer	getSearchTermsVersion() The version of the entity screening's `search_terms` that were compared when the entity screening hit was added.
MatchSummaryCode	getUrls() Get urls
int	hashCode()
EntityScreeningHitAnalysis	locations(MatchSummaryCode locations)
EntityScreeningHitAnalysis	names(MatchSummaryCode names)
EntityScreeningHitAnalysis	phoneNumbers(MatchSummaryCode phoneNumbers)
EntityScreeningHitAnalysis	searchTermsVersion(Integer searchTermsVersion)
void	setDocuments(MatchSummaryCode documents)
void	setEmailAddresses(MatchSummaryCode emailAddresses)
void	setLocations(MatchSummaryCode locations)
void	setNames(MatchSummaryCode names)
void	setPhoneNumbers(MatchSummaryCode phoneNumbers)
void	setSearchTermsVersion(Integer searchTermsVersion)
void	setUrls(MatchSummaryCode urls)
String	toString()
EntityScreeningHitAnalysis	urls(MatchSummaryCode urls)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_DOCUMENTS

public static final String SERIALIZED_NAME_DOCUMENTS

See Also:

Constant Field Values

SERIALIZED_NAME_EMAIL_ADDRESSES

public static final String SERIALIZED_NAME_EMAIL_ADDRESSES

See Also:

Constant Field Values

SERIALIZED_NAME_LOCATIONS

public static final String SERIALIZED_NAME_LOCATIONS

See Also:

Constant Field Values

SERIALIZED_NAME_NAMES

public static final String SERIALIZED_NAME_NAMES

See Also:

Constant Field Values

SERIALIZED_NAME_PHONE_NUMBERS

public static final String SERIALIZED_NAME_PHONE_NUMBERS

See Also:

Constant Field Values

SERIALIZED_NAME_URLS

public static final String SERIALIZED_NAME_URLS

See Also:

Constant Field Values

SERIALIZED_NAME_SEARCH_TERMS_VERSION

public static final String SERIALIZED_NAME_SEARCH_TERMS_VERSION

See Also:

Constant Field Values

Constructor Detail

EntityScreeningHitAnalysis

public EntityScreeningHitAnalysis()

Method Detail

documents

public EntityScreeningHitAnalysis documents(MatchSummaryCode documents)

getDocuments

@Nullable
public MatchSummaryCode getDocuments()

Get documents

Returns:

documents

setDocuments

public void setDocuments(MatchSummaryCode documents)

emailAddresses

public EntityScreeningHitAnalysis emailAddresses(MatchSummaryCode emailAddresses)

getEmailAddresses

@Nullable
public MatchSummaryCode getEmailAddresses()

Get emailAddresses

Returns:

emailAddresses

setEmailAddresses

public void setEmailAddresses(MatchSummaryCode emailAddresses)

locations

public EntityScreeningHitAnalysis locations(MatchSummaryCode locations)

getLocations

@Nullable
public MatchSummaryCode getLocations()

Get locations

Returns:

locations

setLocations

public void setLocations(MatchSummaryCode locations)

names

public EntityScreeningHitAnalysis names(MatchSummaryCode names)

getNames

@Nullable
public MatchSummaryCode getNames()

Get names

Returns:

names

setNames

public void setNames(MatchSummaryCode names)

phoneNumbers

public EntityScreeningHitAnalysis phoneNumbers(MatchSummaryCode phoneNumbers)

getPhoneNumbers

@Nullable
public MatchSummaryCode getPhoneNumbers()

Get phoneNumbers

Returns:

phoneNumbers

setPhoneNumbers

public void setPhoneNumbers(MatchSummaryCode phoneNumbers)

urls

public EntityScreeningHitAnalysis urls(MatchSummaryCode urls)

getUrls

@Nullable
public MatchSummaryCode getUrls()

Get urls

Returns:

urls

setUrls

public void setUrls(MatchSummaryCode urls)

searchTermsVersion

public EntityScreeningHitAnalysis searchTermsVersion(Integer searchTermsVersion)

getSearchTermsVersion

public Integer getSearchTermsVersion()

The version of the entity screening's `search_terms` that were compared when the entity screening hit was added. entity screening hits are immutable once they have been reviewed. If changes are detected due to updates to the entity screening's `search_terms`, the associated entity program, or the list's source data prior to review, the entity screening hit will be updated to reflect those changes.

Returns:

searchTermsVersion

setSearchTermsVersion

public void setSearchTermsVersion(Integer searchTermsVersion)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object