com.affinda.api.client.models

Class JobDescriptionRequestBody

java.lang.Object

com.affinda.api.client.models.JobDescriptionRequestBody

public final class JobDescriptionRequestBody
extends Object

JobDescriptionRequestBody.

Constructor Summary

Constructors

Constructor and Description
JobDescriptionRequestBody()

Method Summary

Modifier and Type	Method and Description
java.time.OffsetDateTime	getExpiryTime() Get the expiryTime property: The date/time in ISO-8601 format when the document will be automatically deleted.
reactor.core.publisher.Flux<ByteBuffer>	getFile() Get the file property: File as binary data blob.
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: Language code in ISO 639-1 format.
String	getUrl() Get the url property: URL to a job description to download and process.
Boolean	isWait() Get the wait property: If "true" (default), will return a response only after processing has completed.
JobDescriptionRequestBody	setExpiryTime(java.time.OffsetDateTime expiryTime) Set the expiryTime property: The date/time in ISO-8601 format when the document will be automatically deleted.
JobDescriptionRequestBody	setFile(reactor.core.publisher.Flux<ByteBuffer> file) Set the file property: File as binary data blob.
JobDescriptionRequestBody	setFileName(String fileName) Set the fileName property: Optional filename of the file.
JobDescriptionRequestBody	setIdentifier(String identifier) Set the identifier property: Unique identifier for the document.
JobDescriptionRequestBody	setLanguage(String language) Set the language property: Language code in ISO 639-1 format.
JobDescriptionRequestBody	setUrl(String url) Set the url property: URL to a job description to download and process.
JobDescriptionRequestBody	setWait(Boolean wait) Set the wait property: If "true" (default), will return a response only after processing has completed.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobDescriptionRequestBody

public JobDescriptionRequestBody()

Method Detail

getFile

public reactor.core.publisher.Flux<ByteBuffer> getFile()

Get the file property: File as binary data blob. Supported formats: PDF, DOC, DOCX, TXT, RTF, HTML, PNG, JPG.

Returns:

the file value.

setFile

public JobDescriptionRequestBody setFile(reactor.core.publisher.Flux<ByteBuffer> file)

Set the file property: File as binary data blob. Supported formats: PDF, DOC, DOCX, TXT, RTF, HTML, PNG, JPG.

Parameters:

file - the file value to set.

Returns:

the JobDescriptionRequestBody object itself.

getUrl

public String getUrl()

Get the url property: URL to a job description to download and process.

Returns:

the url value.

setUrl

public JobDescriptionRequestBody setUrl(String url)

Set the url property: URL to a job description to download and process.

Parameters:

url - the url value to set.

Returns:

the JobDescriptionRequestBody object itself.

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 JobDescriptionRequestBody 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 JobDescriptionRequestBody object itself.

getFileName

public String getFileName()

Get the fileName property: Optional filename of the file.

Returns:

the fileName value.

setFileName

public JobDescriptionRequestBody setFileName(String fileName)

Set the fileName property: Optional filename of the file.

Parameters:

fileName - the fileName value to set.

Returns:

the JobDescriptionRequestBody object itself.

isWait

public Boolean isWait()

Get the wait property: If "true" (default), will return a response only after processing has completed. If "false", will return an empty data object which can be polled at the GET endpoint until processing is complete.

Returns:

the wait value.

setWait

public JobDescriptionRequestBody setWait(Boolean wait)

Set the wait property: If "true" (default), will return a response only after processing has completed. If "false", will return an empty data object which can be polled at the GET endpoint until processing is complete.

Parameters:

wait - the wait value to set.

Returns:

the JobDescriptionRequestBody object itself.

getLanguage

public String getLanguage()

Get the language property: Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.

Returns:

the language value.

setLanguage

public JobDescriptionRequestBody setLanguage(String language)

Set the language property: Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.

Parameters:

language - the language value to set.

Returns:

the JobDescriptionRequestBody 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 JobDescriptionRequestBody 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 JobDescriptionRequestBody object itself.