Package com.onfido.model

Class Extraction

java.lang.Object

com.onfido.model.Extraction

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

Extraction

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Extraction.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_DOCUMENT_CLASSIFICATION
static String	SERIALIZED_NAME_DOCUMENT_ID
static String	SERIALIZED_NAME_EXTRACTED_DATA

Constructor Summary

Constructors

Constructor	Description
Extraction()

Method Summary

Modifier and Type	Method	Description
Extraction	documentClassification(ExtractionDocumentClassification documentClassification)
Extraction	documentId(UUID documentId)
boolean	equals(Object o)
Extraction	extractedData(ExtractionExtractedData extractedData)
static Extraction	fromJson(String jsonString)	Create an instance of Extraction 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.
ExtractionDocumentClassification	getDocumentClassification()	Get documentClassification
UUID	getDocumentId()	The unique identifier of the uploaded document.
ExtractionExtractedData	getExtractedData()	Get extractedData
int	hashCode()
Extraction	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setDocumentClassification(ExtractionDocumentClassification documentClassification)
void	setDocumentId(UUID documentId)
void	setExtractedData(ExtractionExtractedData extractedData)
String	toJson()	Convert an instance of Extraction 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_DOCUMENT_ID

public static final String SERIALIZED_NAME_DOCUMENT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_DOCUMENT_CLASSIFICATION

public static final String SERIALIZED_NAME_DOCUMENT_CLASSIFICATION

See Also:

Constant Field Values

SERIALIZED_NAME_EXTRACTED_DATA

public static final String SERIALIZED_NAME_EXTRACTED_DATA

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

Extraction

public Extraction()

Method Detail

documentId

public Extraction documentId(UUID documentId)

getDocumentId

@Nullable
public UUID getDocumentId()

The unique identifier of the uploaded document.

Returns:

documentId

setDocumentId

public void setDocumentId(UUID documentId)

documentClassification

public Extraction documentClassification(ExtractionDocumentClassification documentClassification)

getDocumentClassification

@Nullable
public ExtractionDocumentClassification getDocumentClassification()

Get documentClassification

Returns:

documentClassification

setDocumentClassification

public void setDocumentClassification(ExtractionDocumentClassification documentClassification)

extractedData

public Extraction extractedData(ExtractionExtractedData extractedData)

getExtractedData

@Nullable
public ExtractionExtractedData getExtractedData()

Get extractedData

Returns:

extractedData

setExtractedData

public void setExtractedData(ExtractionExtractedData extractedData)

putAdditionalProperty

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

fromJson

public static Extraction fromJson(String jsonString)
                           throws IOException

Create an instance of Extraction given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of Extraction

Throws:

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

toJson

public String toJson()

Convert an instance of Extraction to an JSON string

Returns:

JSON string