Package com.onfido.model

Class ExtractionDocumentClassification

java.lang.Object

com.onfido.model.ExtractionDocumentClassification

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

ExtractionDocumentClassification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExtractionDocumentClassification.CustomTypeAdapterFactory
static class	ExtractionDocumentClassification.SubtypeEnum	The document subtype (if available).

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_DOCUMENT_TYPE
static String	SERIALIZED_NAME_ISSUING_COUNTRY
static String	SERIALIZED_NAME_ISSUING_STATE
static String	SERIALIZED_NAME_SUBTYPE
static String	SERIALIZED_NAME_VERSION

Constructor Summary

Constructors

Constructor	Description
ExtractionDocumentClassification()

Method Summary

Modifier and Type	Method	Description
ExtractionDocumentClassification	documentType(DocumentTypes documentType)
boolean	equals(Object o)
static ExtractionDocumentClassification	fromJson(String jsonString)	Create an instance of ExtractionDocumentClassification 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.
DocumentTypes	getDocumentType()	Type of document.
CountryCodes	getIssuingCountry()	Document country in 3-letter ISO code.
String	getIssuingState()	The state that issued the document (if available).
ExtractionDocumentClassification.SubtypeEnum	getSubtype()	The document subtype (if available).
String	getVersion()	The document issuing version (if available).
int	hashCode()
ExtractionDocumentClassification	issuingCountry(CountryCodes issuingCountry)
ExtractionDocumentClassification	issuingState(String issuingState)
ExtractionDocumentClassification	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setDocumentType(DocumentTypes documentType)
void	setIssuingCountry(CountryCodes issuingCountry)
void	setIssuingState(String issuingState)
void	setSubtype(ExtractionDocumentClassification.SubtypeEnum subtype)
void	setVersion(String version)
ExtractionDocumentClassification	subtype(ExtractionDocumentClassification.SubtypeEnum subtype)
String	toJson()	Convert an instance of ExtractionDocumentClassification 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
ExtractionDocumentClassification	version(String version)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_ISSUING_COUNTRY

public static final String SERIALIZED_NAME_ISSUING_COUNTRY

See Also:

Constant Field Values

SERIALIZED_NAME_DOCUMENT_TYPE

public static final String SERIALIZED_NAME_DOCUMENT_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_ISSUING_STATE

public static final String SERIALIZED_NAME_ISSUING_STATE

See Also:

Constant Field Values

SERIALIZED_NAME_SUBTYPE

public static final String SERIALIZED_NAME_SUBTYPE

See Also:

Constant Field Values

SERIALIZED_NAME_VERSION

public static final String SERIALIZED_NAME_VERSION

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

ExtractionDocumentClassification

public ExtractionDocumentClassification()

Method Detail

issuingCountry

public ExtractionDocumentClassification issuingCountry(CountryCodes issuingCountry)

getIssuingCountry

@Nullable
public CountryCodes getIssuingCountry()

Document country in 3-letter ISO code.

Returns:

issuingCountry

setIssuingCountry

public void setIssuingCountry(CountryCodes issuingCountry)

documentType

public ExtractionDocumentClassification documentType(DocumentTypes documentType)

getDocumentType

@Nullable
public DocumentTypes getDocumentType()

Type of document.

Returns:

documentType

setDocumentType

public void setDocumentType(DocumentTypes documentType)

issuingState

public ExtractionDocumentClassification issuingState(String issuingState)

getIssuingState

@Nullable
public String getIssuingState()

The state that issued the document (if available).

Returns:

issuingState

setIssuingState

public void setIssuingState(String issuingState)

subtype

public ExtractionDocumentClassification subtype(ExtractionDocumentClassification.SubtypeEnum subtype)

getSubtype

@Nullable
public ExtractionDocumentClassification.SubtypeEnum getSubtype()

The document subtype (if available).

Returns:

subtype

setSubtype

public void setSubtype(ExtractionDocumentClassification.SubtypeEnum subtype)

version

public ExtractionDocumentClassification version(String version)

getVersion

@Nullable
public String getVersion()

The document issuing version (if available).

Returns:

version

setVersion

public void setVersion(String version)

putAdditionalProperty

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

fromJson

public static ExtractionDocumentClassification fromJson(String jsonString)
                                                 throws IOException

Create an instance of ExtractionDocumentClassification given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of ExtractionDocumentClassification

Throws:

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

toJson

public String toJson()

Convert an instance of ExtractionDocumentClassification to an JSON string

Returns:

JSON string