Package com.onfido.model

Class KnownFacesReport

java.lang.Object

com.onfido.model.KnownFacesReport

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.9.0")
public class KnownFacesReport
extends Object

KnownFacesReport

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KnownFacesReport.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_BREAKDOWN
static String	SERIALIZED_NAME_CHECK_ID
static String	SERIALIZED_NAME_CREATED_AT
static String	SERIALIZED_NAME_DOCUMENTS
static String	SERIALIZED_NAME_HREF
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_NAME
static String	SERIALIZED_NAME_PROPERTIES
static String	SERIALIZED_NAME_RESULT
static String	SERIALIZED_NAME_STATUS
static String	SERIALIZED_NAME_SUB_RESULT

Constructor Summary

Constructors

Constructor	Description
KnownFacesReport()

Method Summary

Modifier and Type	Method	Description
KnownFacesReport	addDocumentsItem(ReportDocument documentsItem)
KnownFacesReport	breakdown(KnownFacesBreakdown breakdown)
KnownFacesReport	checkId(UUID checkId)
KnownFacesReport	createdAt(OffsetDateTime createdAt)
KnownFacesReport	documents(List<ReportDocument> documents)
boolean	equals(Object o)
static KnownFacesReport	fromJson(String jsonString)	Create an instance of KnownFacesReport given an JSON string
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
KnownFacesBreakdown	getBreakdown()	Get breakdown
UUID	getCheckId()	The ID of the check to which the report belongs.
OffsetDateTime	getCreatedAt()	The date and time at which the report was first initiated.
List<ReportDocument>	getDocuments()	Array of objects with document ids that were used in the Onfido engine.
String	getHref()	The API endpoint to retrieve the report.
UUID	getId()	The unique identifier for the report.
ReportName	getName()	Get name
KnownFacesProperties	getProperties()	Get properties
ReportResult	getResult()	Get result
ReportStatus	getStatus()	Get status
ReportSubResult	getSubResult()	Get subResult
int	hashCode()
KnownFacesReport	href(String href)
KnownFacesReport	id(UUID id)
KnownFacesReport	name(ReportName name)
KnownFacesReport	properties(KnownFacesProperties properties)
KnownFacesReport	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
KnownFacesReport	result(ReportResult result)
void	setBreakdown(KnownFacesBreakdown breakdown)
void	setCheckId(UUID checkId)
void	setCreatedAt(OffsetDateTime createdAt)
void	setDocuments(List<ReportDocument> documents)
void	setHref(String href)
void	setId(UUID id)
void	setName(ReportName name)
void	setProperties(KnownFacesProperties properties)
void	setResult(ReportResult result)
void	setStatus(ReportStatus status)
void	setSubResult(ReportSubResult subResult)
KnownFacesReport	status(ReportStatus status)
KnownFacesReport	subResult(ReportSubResult subResult)
String	toJson()	Convert an instance of KnownFacesReport to an JSON string
String	toString()
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

Constant Field Values

SERIALIZED_NAME_HREF

public static final String SERIALIZED_NAME_HREF

See Also:

Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

Constant Field Values

SERIALIZED_NAME_RESULT

public static final String SERIALIZED_NAME_RESULT

See Also:

Constant Field Values

SERIALIZED_NAME_SUB_RESULT

public static final String SERIALIZED_NAME_SUB_RESULT

See Also:

Constant Field Values

SERIALIZED_NAME_CHECK_ID

public static final String SERIALIZED_NAME_CHECK_ID

See Also:

Constant Field Values

SERIALIZED_NAME_DOCUMENTS

public static final String SERIALIZED_NAME_DOCUMENTS

See Also:

Constant Field Values

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_BREAKDOWN

public static final String SERIALIZED_NAME_BREAKDOWN

See Also:

Constant Field Values

SERIALIZED_NAME_PROPERTIES

public static final String SERIALIZED_NAME_PROPERTIES

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

KnownFacesReport

public KnownFacesReport()

Method Detail

id

public KnownFacesReport id(UUID id)

getId

@Nonnull
public UUID getId()

The unique identifier for the report. Read-only.

Returns:

id

setId

public void setId(UUID id)

createdAt

public KnownFacesReport createdAt(OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

The date and time at which the report was first initiated. Read-only.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

href

public KnownFacesReport href(String href)

getHref

@Nullable
public String getHref()

The API endpoint to retrieve the report. Read-only.

Returns:

href

setHref

public void setHref(String href)

status

public KnownFacesReport status(ReportStatus status)

getStatus

@Nullable
public ReportStatus getStatus()

Get status

Returns:

status

setStatus

public void setStatus(ReportStatus status)

result

public KnownFacesReport result(ReportResult result)

getResult

@Nullable
public ReportResult getResult()

Get result

Returns:

result

setResult

public void setResult(ReportResult result)

subResult

public KnownFacesReport subResult(ReportSubResult subResult)

getSubResult

@Nullable
public ReportSubResult getSubResult()

Get subResult

Returns:

subResult

setSubResult

public void setSubResult(ReportSubResult subResult)

checkId

public KnownFacesReport checkId(UUID checkId)

getCheckId

@Nullable
public UUID getCheckId()

The ID of the check to which the report belongs. Read-only.

Returns:

checkId

setCheckId

public void setCheckId(UUID checkId)

documents

public KnownFacesReport documents(List<ReportDocument> documents)

addDocumentsItem

public KnownFacesReport addDocumentsItem(ReportDocument documentsItem)

getDocuments

@Nullable
public List<ReportDocument> getDocuments()

Array of objects with document ids that were used in the Onfido engine. [ONLY POPULATED FOR DOCUMENT AND FACIAL SIMILARITY REPORTS]

Returns:

documents

setDocuments

public void setDocuments(List<ReportDocument> documents)

name

public KnownFacesReport name(ReportName name)

getName

@Nonnull
public ReportName getName()

Get name

Returns:

name

setName

public void setName(ReportName name)

breakdown

public KnownFacesReport breakdown(KnownFacesBreakdown breakdown)

getBreakdown

@Nullable
public KnownFacesBreakdown getBreakdown()

Get breakdown

Returns:

breakdown

setBreakdown

public void setBreakdown(KnownFacesBreakdown breakdown)

properties

public KnownFacesReport properties(KnownFacesProperties properties)

getProperties

@Nullable
public KnownFacesProperties getProperties()

Get properties

Returns:

properties

setProperties

public void setProperties(KnownFacesProperties properties)

putAdditionalProperty

public KnownFacesReport putAdditionalProperty(String key,
                                              Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - name of the property

value - value of the property

Returns:

the KnownFacesReport instance itself

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

a map of objects

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - name of the property

Returns:

an object

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

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

IOException - if the JSON Element is invalid with respect to KnownFacesReport

fromJson

public static KnownFacesReport fromJson(String jsonString)
                                 throws IOException

Create an instance of KnownFacesReport given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of KnownFacesReport

Throws:

IOException - if the JSON string is invalid with respect to KnownFacesReport

toJson

public String toJson()

Convert an instance of KnownFacesReport to an JSON string

Returns:

JSON string