Package com.onfido.model

Class DocumentReport

java.lang.Object

com.onfido.model.DocumentReport

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

DocumentReport

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentReport.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
DocumentReport()

Method Summary

Modifier and Type	Method	Description
DocumentReport	addDocumentsItem(ReportDocument documentsItem)
DocumentReport	breakdown(DocumentBreakdown breakdown)
DocumentReport	checkId(UUID checkId)
DocumentReport	createdAt(OffsetDateTime createdAt)
DocumentReport	documents(List<ReportDocument> documents)
boolean	equals(Object o)
static DocumentReport	fromJson(String jsonString)	Create an instance of DocumentReport 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.
DocumentBreakdown	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
DocumentProperties	getProperties()	Get properties
ReportResult	getResult()	Get result
ReportStatus	getStatus()	Get status
ReportSubResult	getSubResult()	Get subResult
int	hashCode()
DocumentReport	href(String href)
DocumentReport	id(UUID id)
DocumentReport	name(ReportName name)
DocumentReport	properties(DocumentProperties properties)
DocumentReport	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
DocumentReport	result(ReportResult result)
void	setBreakdown(DocumentBreakdown 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(DocumentProperties properties)
void	setResult(ReportResult result)
void	setStatus(ReportStatus status)
void	setSubResult(ReportSubResult subResult)
DocumentReport	status(ReportStatus status)
DocumentReport	subResult(ReportSubResult subResult)
String	toJson()	Convert an instance of DocumentReport 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

DocumentReport

public DocumentReport()

Method Detail

id

public DocumentReport 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 DocumentReport 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 DocumentReport 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 DocumentReport status(ReportStatus status)

getStatus

@Nullable
public ReportStatus getStatus()

Get status

Returns:

status

setStatus

public void setStatus(ReportStatus status)

result

public DocumentReport result(ReportResult result)

getResult

@Nullable
public ReportResult getResult()

Get result

Returns:

result

setResult

public void setResult(ReportResult result)

subResult

public DocumentReport subResult(ReportSubResult subResult)

getSubResult

@Nullable
public ReportSubResult getSubResult()

Get subResult

Returns:

subResult

setSubResult

public void setSubResult(ReportSubResult subResult)

checkId

public DocumentReport 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 DocumentReport documents(List<ReportDocument> documents)

addDocumentsItem

public DocumentReport 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 DocumentReport name(ReportName name)

getName

@Nonnull
public ReportName getName()

Get name

Returns:

name

setName

public void setName(ReportName name)

breakdown

public DocumentReport breakdown(DocumentBreakdown breakdown)

getBreakdown

@Nullable
public DocumentBreakdown getBreakdown()

Get breakdown

Returns:

breakdown

setBreakdown

public void setBreakdown(DocumentBreakdown breakdown)

properties

public DocumentReport properties(DocumentProperties properties)

getProperties

@Nullable
public DocumentProperties getProperties()

Get properties

Returns:

properties

setProperties

public void setProperties(DocumentProperties properties)

putAdditionalProperty

public DocumentReport 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 DocumentReport 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 DocumentReport

fromJson

public static DocumentReport fromJson(String jsonString)
                               throws IOException

Create an instance of DocumentReport given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of DocumentReport

Throws:

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

toJson

public String toJson()

Convert an instance of DocumentReport to an JSON string

Returns:

JSON string