com.affinda.api.client.models

Class Meta

java.lang.Object

com.affinda.api.client.models.Meta

public final class Meta
extends Object

The Meta model.

Constructor Summary

Constructors

Constructor and Description
Meta()

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getAdditionalProperties() Get the additionalProperties property: Dictionary of <any>.
List<SplitRelation>	getChildDocuments() Get the childDocuments property: If this document has been splitted into a number of child documents, this attribute points to those child documents.
java.time.OffsetDateTime	getExpiryTime() Get the expiryTime property: The date/time in ISO-8601 format when the document will be automatically deleted.
String	getFileName() Get the fileName property: Optional filename of the file.
String	getIdentifier() Get the identifier property: Unique identifier for the document.
String	getLanguage() Get the language property: The document's language.
Float	getOcrConfidence() Get the ocrConfidence property: The overall confidence in the conversion of image to text.
List<PageMeta>	getPages() Get the pages property: The document's pages.
SplitRelation	getParentDocument() Get the parentDocument property: If this document is part of a splitted document, this attribute points to the original document that this document is splitted from.
String	getPdf() Get the pdf property: The URL to the document's pdf (if the uploaded document is not already pdf, it's converted to pdf as part of the parsing process).
java.time.OffsetDateTime	getReadyDt() Get the readyDt property: The datetime when the document was ready.
String	getReviewUrl() Get the reviewUrl property: Signed URL (valid for 60 minutes) to access the validation tool.
boolean	isFailed() Get the failed property: If true, some exception was raised during processing.
boolean	isReady() Get the ready property: If true, the document has finished processing.
Boolean	isVerified() Get the isVerified property: This is true if the "confirm" button has been clicked in the Affinda validation tool.
Meta	setAdditionalProperties(Map<String,Object> additionalProperties) Set the additionalProperties property: Dictionary of <any>.
Meta	setExpiryTime(java.time.OffsetDateTime expiryTime) Set the expiryTime property: The date/time in ISO-8601 format when the document will be automatically deleted.
Meta	setFailed(boolean failed) Set the failed property: If true, some exception was raised during processing.
Meta	setFileName(String fileName) Set the fileName property: Optional filename of the file.
Meta	setIdentifier(String identifier) Set the identifier property: Unique identifier for the document.
Meta	setIsVerified(Boolean isVerified) Set the isVerified property: This is true if the "confirm" button has been clicked in the Affinda validation tool.
Meta	setLanguage(String language) Set the language property: The document's language.
Meta	setOcrConfidence(Float ocrConfidence) Set the ocrConfidence property: The overall confidence in the conversion of image to text.
Meta	setPages(List<PageMeta> pages) Set the pages property: The document's pages.
Meta	setReady(boolean ready) Set the ready property: If true, the document has finished processing.
Meta	setReadyDt(java.time.OffsetDateTime readyDt) Set the readyDt property: The datetime when the document was ready.
Meta	setReviewUrl(String reviewUrl) Set the reviewUrl property: Signed URL (valid for 60 minutes) to access the validation tool.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Meta

public Meta()

Method Detail

getIdentifier

public String getIdentifier()

Get the identifier property: Unique identifier for the document. If creating a document and left blank, one will be automatically generated.

Returns:

the identifier value.

setIdentifier

public Meta setIdentifier(String identifier)

Set the identifier property: Unique identifier for the document. If creating a document and left blank, one will be automatically generated.

Parameters:

identifier - the identifier value to set.

Returns:

the Meta object itself.

getFileName

public String getFileName()

Get the fileName property: Optional filename of the file.

Returns:

the fileName value.

setFileName

public Meta setFileName(String fileName)

Set the fileName property: Optional filename of the file.

Parameters:

fileName - the fileName value to set.

Returns:

the Meta object itself.

isReady

public boolean isReady()

Get the ready property: If true, the document has finished processing. Particularly useful if an endpoint request specified wait=False, when polling use this variable to determine when to stop polling.

Returns:

the ready value.

setReady

public Meta setReady(boolean ready)

Set the ready property: If true, the document has finished processing. Particularly useful if an endpoint request specified wait=False, when polling use this variable to determine when to stop polling.

Parameters:

ready - the ready value to set.

Returns:

the Meta object itself.

getReadyDt

public java.time.OffsetDateTime getReadyDt()

Get the readyDt property: The datetime when the document was ready.

Returns:

the readyDt value.

setReadyDt

public Meta setReadyDt(java.time.OffsetDateTime readyDt)

Set the readyDt property: The datetime when the document was ready.

Parameters:

readyDt - the readyDt value to set.

Returns:

the Meta object itself.

isFailed

public boolean isFailed()

Get the failed property: If true, some exception was raised during processing. Check the 'error' field of the main return object.

Returns:

the failed value.

setFailed

public Meta setFailed(boolean failed)

Set the failed property: If true, some exception was raised during processing. Check the 'error' field of the main return object.

Parameters:

failed - the failed value to set.

Returns:

the Meta object itself.

getExpiryTime

public java.time.OffsetDateTime getExpiryTime()

Get the expiryTime property: The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.

Returns:

the expiryTime value.

setExpiryTime

public Meta setExpiryTime(java.time.OffsetDateTime expiryTime)

Set the expiryTime property: The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.

Parameters:

expiryTime - the expiryTime value to set.

Returns:

the Meta object itself.

getLanguage

public String getLanguage()

Get the language property: The document's language.

Returns:

the language value.

setLanguage

public Meta setLanguage(String language)

Set the language property: The document's language.

Parameters:

language - the language value to set.

Returns:

the Meta object itself.

getPdf

public String getPdf()

Get the pdf property: The URL to the document's pdf (if the uploaded document is not already pdf, it's converted to pdf as part of the parsing process).

Returns:

the pdf value.

getParentDocument

public SplitRelation getParentDocument()

Get the parentDocument property: If this document is part of a splitted document, this attribute points to the original document that this document is splitted from.

Returns:

the parentDocument value.

getChildDocuments

public List<SplitRelation> getChildDocuments()

Get the childDocuments property: If this document has been splitted into a number of child documents, this attribute points to those child documents.

Returns:

the childDocuments value.

getPages

public List<PageMeta> getPages()

Get the pages property: The document's pages.

Returns:

the pages value.

setPages

public Meta setPages(List<PageMeta> pages)

Set the pages property: The document's pages.

Parameters:

pages - the pages value to set.

Returns:

the Meta object itself.

isVerified

public Boolean isVerified()

Get the isVerified property: This is true if the "confirm" button has been clicked in the Affinda validation tool.

Returns:

the isVerified value.

setIsVerified

public Meta setIsVerified(Boolean isVerified)

Set the isVerified property: This is true if the "confirm" button has been clicked in the Affinda validation tool.

Parameters:

isVerified - the isVerified value to set.

Returns:

the Meta object itself.

getReviewUrl

public String getReviewUrl()

Get the reviewUrl property: Signed URL (valid for 60 minutes) to access the validation tool. Not applicable for documents types such a resumes.

Returns:

the reviewUrl value.

setReviewUrl

public Meta setReviewUrl(String reviewUrl)

Set the reviewUrl property: Signed URL (valid for 60 minutes) to access the validation tool. Not applicable for documents types such a resumes.

Parameters:

reviewUrl - the reviewUrl value to set.

Returns:

the Meta object itself.

getOcrConfidence

public Float getOcrConfidence()

Get the ocrConfidence property: The overall confidence in the conversion of image to text. (only applicable for images or PDF documents without a text layer).

Returns:

the ocrConfidence value.

setOcrConfidence

public Meta setOcrConfidence(Float ocrConfidence)

Set the ocrConfidence property: The overall confidence in the conversion of image to text. (only applicable for images or PDF documents without a text layer).

Parameters:

ocrConfidence - the ocrConfidence value to set.

Returns:

the Meta object itself.

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Get the additionalProperties property: Dictionary of <any>.

Returns:

the additionalProperties value.

setAdditionalProperties

public Meta setAdditionalProperties(Map<String,Object> additionalProperties)

Set the additionalProperties property: Dictionary of <any>.

Parameters:

additionalProperties - the additionalProperties value to set.

Returns:

the Meta object itself.