com.affinda.api.client.models

Class Meta

java.lang.Object

com.affinda.api.client.models.Meta

Direct Known Subclasses:

InvoiceMeta

public 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>.
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 resume's language.
java.time.OffsetDateTime	getReadyDt() Get the readyDt property: The datetime when the document was ready.
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.
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	setLanguage(String language) Set the language property: The resume's language.
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.

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 resume's language.

Returns:

the language value.

setLanguage

public Meta setLanguage(String language)

Set the language property: The resume's language.

Parameters:

language - the language 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.