Package com.onfido.model

Class DocumentWithDriverVerificationReport

java.lang.Object

com.onfido.model.DocumentWithDriverVerificationReport

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

DocumentWithDriverVerificationReport

Nested Class Summary

Nested Classes

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

Method Summary

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

DocumentWithDriverVerificationReport

public DocumentWithDriverVerificationReport()

Method Detail

id

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

getStatus

@Nullable
public ReportStatus getStatus()

Get status

Returns:

status

setStatus

public void setStatus(ReportStatus status)

result

public DocumentWithDriverVerificationReport result(ReportResult result)

getResult

@Nullable
public ReportResult getResult()

Get result

Returns:

result

setResult

public void setResult(ReportResult result)

subResult

public DocumentWithDriverVerificationReport subResult(ReportSubResult subResult)

getSubResult

@Nullable
public ReportSubResult getSubResult()

Get subResult

Returns:

subResult

setSubResult

public void setSubResult(ReportSubResult subResult)

checkId

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

addDocumentsItem

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

getName

@Nonnull
public ReportName getName()

Get name

Returns:

name

setName

public void setName(ReportName name)

breakdown

public DocumentWithDriverVerificationReport breakdown(DocumentBreakdown breakdown)

getBreakdown

@Nullable
public DocumentBreakdown getBreakdown()

Get breakdown

Returns:

breakdown

setBreakdown

public void setBreakdown(DocumentBreakdown breakdown)

properties

public DocumentWithDriverVerificationReport properties(DocumentWithDriverVerificationReportAllOfProperties properties)

getProperties

@Nullable
public DocumentWithDriverVerificationReportAllOfProperties getProperties()

Get properties

Returns:

properties

setProperties

public void setProperties(DocumentWithDriverVerificationReportAllOfProperties properties)

putAdditionalProperty

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

fromJson

public static DocumentWithDriverVerificationReport fromJson(String jsonString)
                                                     throws IOException

Create an instance of DocumentWithDriverVerificationReport given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of DocumentWithDriverVerificationReport

Throws:

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

toJson

public String toJson()

Convert an instance of DocumentWithDriverVerificationReport to an JSON string

Returns:

JSON string