DocumentMeta (Java Client Library for Affinda Resume Parser API 3.2.0 API)

java.lang.Object
- com.affinda.api.client.models.DocumentMeta

public final class DocumentMeta
extends Object

The DocumentMeta model.

Constructor Summary

Constructors
Constructor and Description

DocumentMeta()

Constructors
Constructor and Description
`DocumentMeta()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.time.OffsetDateTime`	`getArchivedDt()` Get the archivedDt property: The archivedDt property.
`List<DocumentMetaChildDocumentsItem>`	`getChildDocuments()` Get the childDocuments property: If this document has been splitted into a number of child documents, this attribute points to those child documents.
`DocumentMetaCollection`	`getCollection()` Get the collection property: The collection property.
`UserNullable`	`getConfirmedBy()` Get the confirmedBy property: The confirmedBy property.
`java.time.OffsetDateTime`	`getConfirmedDt()` Get the confirmedDt property: The confirmedDt property.
`java.time.OffsetDateTime`	`getCreatedDt()` Get the createdDt property: The createdDt property.
`String`	`getErrorCode()` Get the errorCode property: The errorCode property.
`String`	`getErrorDetail()` Get the errorDetail property: The errorDetail property.
`java.time.OffsetDateTime`	`getExpiryTime()` Get the expiryTime property: The date/time in ISO-8601 format when the document will be automatically deleted.
`String`	`getFile()` Get the file property: URL to view the file.
`String`	`getFileName()` Get the fileName property: Optional filename of the file.
`String`	`getIdentifier()` Get the identifier property: Uniquely identify a document.
`String`	`getLanguage()` Get the language property: The document's language.
`Float`	`getOcrConfidence()` Get the ocrConfidence property: The ocrConfidence property.
`List<PageMeta>`	`getPages()` Get the pages property: The document's pages.
`DocumentMetaParentDocument`	`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.
`java.time.OffsetDateTime`	`getRejectedDt()` Get the rejectedDt property: The rejectedDt property.
`String`	`getReviewUrl()` Get the reviewUrl property: The reviewUrl property.
`String`	`getSourceEmail()` Get the sourceEmail property: If the document is created via email ingestion, this field stores the email file's URL.
`List<Tag>`	`getTags()` Get the tags property: The tags property.
`DocumentMetaWorkspace`	`getWorkspace()` Get the workspace property: The workspace property.
`Boolean`	`isArchived()` Get the isArchived property: The isArchived property.
`Boolean`	`isConfirmed()` Get the isConfirmed property: The isConfirmed property.
`Boolean`	`isFailed()` Get the failed property: If true, some exception was raised during processing.
`Boolean`	`isOcrd()` Get the isOcrd property: The isOcrd property.
`Boolean`	`isReady()` Get the ready property: If true, the document has finished processing.
`Boolean`	`isRejected()` Get the isRejected property: The isRejected property.
`DocumentMeta`	`setArchivedDt(java.time.OffsetDateTime archivedDt)` Set the archivedDt property: The archivedDt property.
`DocumentMeta`	`setChildDocuments(List<DocumentMetaChildDocumentsItem> childDocuments)` Set the childDocuments property: If this document has been splitted into a number of child documents, this attribute points to those child documents.
`DocumentMeta`	`setCollection(DocumentMetaCollection collection)` Set the collection property: The collection property.
`DocumentMeta`	`setConfirmedBy(UserNullable confirmedBy)` Set the confirmedBy property: The confirmedBy property.
`DocumentMeta`	`setConfirmedDt(java.time.OffsetDateTime confirmedDt)` Set the confirmedDt property: The confirmedDt property.
`DocumentMeta`	`setCreatedDt(java.time.OffsetDateTime createdDt)` Set the createdDt property: The createdDt property.
`DocumentMeta`	`setErrorCode(String errorCode)` Set the errorCode property: The errorCode property.
`DocumentMeta`	`setErrorDetail(String errorDetail)` Set the errorDetail property: The errorDetail property.
`DocumentMeta`	`setExpiryTime(java.time.OffsetDateTime expiryTime)` Set the expiryTime property: The date/time in ISO-8601 format when the document will be automatically deleted.
`DocumentMeta`	`setFailed(Boolean failed)` Set the failed property: If true, some exception was raised during processing.
`DocumentMeta`	`setFile(String file)` Set the file property: URL to view the file.
`DocumentMeta`	`setFileName(String fileName)` Set the fileName property: Optional filename of the file.
`DocumentMeta`	`setIdentifier(String identifier)` Set the identifier property: Uniquely identify a document.
`DocumentMeta`	`setIsArchived(Boolean isArchived)` Set the isArchived property: The isArchived property.
`DocumentMeta`	`setIsConfirmed(Boolean isConfirmed)` Set the isConfirmed property: The isConfirmed property.
`DocumentMeta`	`setIsOcrd(Boolean isOcrd)` Set the isOcrd property: The isOcrd property.
`DocumentMeta`	`setIsRejected(Boolean isRejected)` Set the isRejected property: The isRejected property.
`DocumentMeta`	`setLanguage(String language)` Set the language property: The document's language.
`DocumentMeta`	`setOcrConfidence(Float ocrConfidence)` Set the ocrConfidence property: The ocrConfidence property.
`DocumentMeta`	`setPages(List<PageMeta> pages)` Set the pages property: The document's pages.
`DocumentMeta`	`setParentDocument(DocumentMetaParentDocument parentDocument)` Set 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.
`DocumentMeta`	`setPdf(String pdf)` Set 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).
`DocumentMeta`	`setReady(Boolean ready)` Set the ready property: If true, the document has finished processing.
`DocumentMeta`	`setReadyDt(java.time.OffsetDateTime readyDt)` Set the readyDt property: The datetime when the document was ready.
`DocumentMeta`	`setRejectedDt(java.time.OffsetDateTime rejectedDt)` Set the rejectedDt property: The rejectedDt property.
`DocumentMeta`	`setReviewUrl(String reviewUrl)` Set the reviewUrl property: The reviewUrl property.
`DocumentMeta`	`setSourceEmail(String sourceEmail)` Set the sourceEmail property: If the document is created via email ingestion, this field stores the email file's URL.
`DocumentMeta`	`setTags(List<Tag> tags)` Set the tags property: The tags property.
`DocumentMeta`	`setWorkspace(DocumentMetaWorkspace workspace)` Set the workspace property: The workspace property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DocumentMeta
```
public DocumentMeta()
```
- Method Detail
  - getIdentifier
```
public String getIdentifier()
```
    Get the identifier property: Uniquely identify a document.
    
    Returns:
    
    the identifier value.
  - setIdentifier
```
public DocumentMeta setIdentifier(String identifier)
```
    Set the identifier property: Uniquely identify a document.
    
    Parameters:
    
    identifier - the identifier value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - getFileName
```
public String getFileName()
```
    Get the fileName property: Optional filename of the file.
    
    Returns:
    
    the fileName value.
  - setFileName
```
public DocumentMeta setFileName(String fileName)
```
    Set the fileName property: Optional filename of the file.
    
    Parameters:
    
    fileName - the fileName value to set.
    
    Returns:
    
    the DocumentMeta 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 DocumentMeta 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 DocumentMeta 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 DocumentMeta 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 DocumentMeta 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 DocumentMeta 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 DocumentMeta 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 DocumentMeta 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 DocumentMeta object itself.
  - getLanguage
```
public String getLanguage()
```
    Get the language property: The document's language.
    
    Returns:
    
    the language value.
  - setLanguage
```
public DocumentMeta setLanguage(String language)
```
    Set the language property: The document's language.
    
    Parameters:
    
    language - the language value to set.
    
    Returns:
    
    the DocumentMeta 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.
  - setPdf
```
public DocumentMeta setPdf(String pdf)
```
    Set 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).
    
    Parameters:
    
    pdf - the pdf value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - getParentDocument
```
public DocumentMetaParentDocument 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.
  - setParentDocument
```
public DocumentMeta setParentDocument(DocumentMetaParentDocument parentDocument)
```
    Set 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.
    
    Parameters:
    
    parentDocument - the parentDocument value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - getChildDocuments
```
public List<DocumentMetaChildDocumentsItem> 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.
  - setChildDocuments
```
public DocumentMeta setChildDocuments(List<DocumentMetaChildDocumentsItem> childDocuments)
```
    Set the childDocuments property: If this document has been splitted into a number of child documents, this attribute points to those child documents.
    
    Parameters:
    
    childDocuments - the childDocuments value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - getPages
```
public List<PageMeta> getPages()
```
    Get the pages property: The document's pages.
    
    Returns:
    
    the pages value.
  - setPages
```
public DocumentMeta setPages(List<PageMeta> pages)
```
    Set the pages property: The document's pages.
    
    Parameters:
    
    pages - the pages value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - isOcrd
```
public Boolean isOcrd()
```
    Get the isOcrd property: The isOcrd property.
    
    Returns:
    
    the isOcrd value.
  - setIsOcrd
```
public DocumentMeta setIsOcrd(Boolean isOcrd)
```
    Set the isOcrd property: The isOcrd property.
    
    Parameters:
    
    isOcrd - the isOcrd value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - getOcrConfidence
```
public Float getOcrConfidence()
```
    Get the ocrConfidence property: The ocrConfidence property.
    
    Returns:
    
    the ocrConfidence value.
  - setOcrConfidence
```
public DocumentMeta setOcrConfidence(Float ocrConfidence)
```
    Set the ocrConfidence property: The ocrConfidence property.
    
    Parameters:
    
    ocrConfidence - the ocrConfidence value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - getReviewUrl
```
public String getReviewUrl()
```
    Get the reviewUrl property: The reviewUrl property.
    
    Returns:
    
    the reviewUrl value.
  - setReviewUrl
```
public DocumentMeta setReviewUrl(String reviewUrl)
```
    Set the reviewUrl property: The reviewUrl property.
    
    Parameters:
    
    reviewUrl - the reviewUrl value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - getCollection
```
public DocumentMetaCollection getCollection()
```
    Get the collection property: The collection property.
    
    Returns:
    
    the collection value.
  - setCollection
```
public DocumentMeta setCollection(DocumentMetaCollection collection)
```
    Set the collection property: The collection property.
    
    Parameters:
    
    collection - the collection value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - getWorkspace
```
public DocumentMetaWorkspace getWorkspace()
```
    Get the workspace property: The workspace property.
    
    Returns:
    
    the workspace value.
  - setWorkspace
```
public DocumentMeta setWorkspace(DocumentMetaWorkspace workspace)
```
    Set the workspace property: The workspace property.
    
    Parameters:
    
    workspace - the workspace value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - getArchivedDt
```
public java.time.OffsetDateTime getArchivedDt()
```
    Get the archivedDt property: The archivedDt property.
    
    Returns:
    
    the archivedDt value.
  - setArchivedDt
```
public DocumentMeta setArchivedDt(java.time.OffsetDateTime archivedDt)
```
    Set the archivedDt property: The archivedDt property.
    
    Parameters:
    
    archivedDt - the archivedDt value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - isArchived
```
public Boolean isArchived()
```
    Get the isArchived property: The isArchived property.
    
    Returns:
    
    the isArchived value.
  - setIsArchived
```
public DocumentMeta setIsArchived(Boolean isArchived)
```
    Set the isArchived property: The isArchived property.
    
    Parameters:
    
    isArchived - the isArchived value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - getConfirmedDt
```
public java.time.OffsetDateTime getConfirmedDt()
```
    Get the confirmedDt property: The confirmedDt property.
    
    Returns:
    
    the confirmedDt value.
  - setConfirmedDt
```
public DocumentMeta setConfirmedDt(java.time.OffsetDateTime confirmedDt)
```
    Set the confirmedDt property: The confirmedDt property.
    
    Parameters:
    
    confirmedDt - the confirmedDt value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - isConfirmed
```
public Boolean isConfirmed()
```
    Get the isConfirmed property: The isConfirmed property.
    
    Returns:
    
    the isConfirmed value.
  - setIsConfirmed
```
public DocumentMeta setIsConfirmed(Boolean isConfirmed)
```
    Set the isConfirmed property: The isConfirmed property.
    
    Parameters:
    
    isConfirmed - the isConfirmed value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - getRejectedDt
```
public java.time.OffsetDateTime getRejectedDt()
```
    Get the rejectedDt property: The rejectedDt property.
    
    Returns:
    
    the rejectedDt value.
  - setRejectedDt
```
public DocumentMeta setRejectedDt(java.time.OffsetDateTime rejectedDt)
```
    Set the rejectedDt property: The rejectedDt property.
    
    Parameters:
    
    rejectedDt - the rejectedDt value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - isRejected
```
public Boolean isRejected()
```
    Get the isRejected property: The isRejected property.
    
    Returns:
    
    the isRejected value.
  - setIsRejected
```
public DocumentMeta setIsRejected(Boolean isRejected)
```
    Set the isRejected property: The isRejected property.
    
    Parameters:
    
    isRejected - the isRejected value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - getCreatedDt
```
public java.time.OffsetDateTime getCreatedDt()
```
    Get the createdDt property: The createdDt property.
    
    Returns:
    
    the createdDt value.
  - setCreatedDt
```
public DocumentMeta setCreatedDt(java.time.OffsetDateTime createdDt)
```
    Set the createdDt property: The createdDt property.
    
    Parameters:
    
    createdDt - the createdDt value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - getErrorCode
```
public String getErrorCode()
```
    Get the errorCode property: The errorCode property.
    
    Returns:
    
    the errorCode value.
  - setErrorCode
```
public DocumentMeta setErrorCode(String errorCode)
```
    Set the errorCode property: The errorCode property.
    
    Parameters:
    
    errorCode - the errorCode value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - getErrorDetail
```
public String getErrorDetail()
```
    Get the errorDetail property: The errorDetail property.
    
    Returns:
    
    the errorDetail value.
  - setErrorDetail
```
public DocumentMeta setErrorDetail(String errorDetail)
```
    Set the errorDetail property: The errorDetail property.
    
    Parameters:
    
    errorDetail - the errorDetail value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - getFile
```
public String getFile()
```
    Get the file property: URL to view the file.
    
    Returns:
    
    the file value.
  - setFile
```
public DocumentMeta setFile(String file)
```
    Set the file property: URL to view the file.
    
    Parameters:
    
    file - the file value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - getTags
```
public List<Tag> getTags()
```
    Get the tags property: The tags property.
    
    Returns:
    
    the tags value.
  - setTags
```
public DocumentMeta setTags(List<Tag> tags)
```
    Set the tags property: The tags property.
    
    Parameters:
    
    tags - the tags value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - getConfirmedBy
```
public UserNullable getConfirmedBy()
```
    Get the confirmedBy property: The confirmedBy property.
    
    Returns:
    
    the confirmedBy value.
  - setConfirmedBy
```
public DocumentMeta setConfirmedBy(UserNullable confirmedBy)
```
    Set the confirmedBy property: The confirmedBy property.
    
    Parameters:
    
    confirmedBy - the confirmedBy value to set.
    
    Returns:
    
    the DocumentMeta object itself.
  - getSourceEmail
```
public String getSourceEmail()
```
    Get the sourceEmail property: If the document is created via email ingestion, this field stores the email file's URL.
    
    Returns:
    
    the sourceEmail value.
  - setSourceEmail
```
public DocumentMeta setSourceEmail(String sourceEmail)
```
    Set the sourceEmail property: If the document is created via email ingestion, this field stores the email file's URL.
    
    Parameters:
    
    sourceEmail - the sourceEmail value to set.
    
    Returns:
    
    the DocumentMeta object itself.

Class DocumentMeta

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentMeta

Method Detail

getIdentifier

setIdentifier

getFileName

setFileName

isReady

setReady

getReadyDt

setReadyDt

isFailed

setFailed

getExpiryTime

setExpiryTime

getLanguage

setLanguage

getPdf

setPdf

getParentDocument

setParentDocument

getChildDocuments

setChildDocuments

getPages

setPages

isOcrd

setIsOcrd

getOcrConfidence

setOcrConfidence

getReviewUrl

setReviewUrl

getCollection

setCollection

getWorkspace

setWorkspace

getArchivedDt

setArchivedDt

isArchived

setIsArchived

getConfirmedDt

setConfirmedDt

isConfirmed

setIsConfirmed

getRejectedDt

setRejectedDt

isRejected

setIsRejected

getCreatedDt

setCreatedDt

getErrorCode

setErrorCode

getErrorDetail

setErrorDetail

getFile

setFile

getTags

setTags

getConfirmedBy

setConfirmedBy

getSourceEmail

setSourceEmail