Package com.mypurecloud.sdk.v2.model

Class KnowledgeExportJobResponse

java.lang.Object

com.mypurecloud.sdk.v2.model.KnowledgeExportJobResponse

All Implemented Interfaces:

Serializable

public class KnowledgeExportJobResponse
extends Object
implements Serializable

KnowledgeExportJobResponse

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	KnowledgeExportJobResponse.FileTypeEnum	File type of the document
static enum	KnowledgeExportJobResponse.StatusEnum	The status of the export job.

Constructor Summary

Constructors

Constructor	Description
KnowledgeExportJobResponse()
KnowledgeExportJobResponse(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
KnowledgeExportJobResponse	countDocumentProcessed(Integer countDocumentProcessed)	The current count of the number of records processed.
KnowledgeExportJobResponse	createdBy(UserReference createdBy)	The user who created the operation
KnowledgeExportJobResponse	dateCreated(Date dateCreated)	The timestamp of when the export began.
KnowledgeExportJobResponse	dateModified(Date dateModified)	The timestamp of when the export stopped.
KnowledgeExportJobResponse	downloadURL(String downloadURL)	The URL of the location at which the caller can download the export file, when available.
boolean	equals(Object o)
KnowledgeExportJobResponse	errorInformation(ErrorBody errorInformation)	Any error information, or null of the processing is not in failed state.
KnowledgeExportJobResponse	exportFilter(KnowledgeExportJobFilter exportFilter)	Filters to narrow down what to export.
KnowledgeExportJobResponse	fileType(KnowledgeExportJobResponse.FileTypeEnum fileType)	File type of the document
Integer	getCountDocumentProcessed()
UserReference	getCreatedBy()
Date	getDateCreated()
Date	getDateModified()
String	getDownloadURL()
ErrorBody	getErrorInformation()
KnowledgeExportJobFilter	getExportFilter()
KnowledgeExportJobResponse.FileTypeEnum	getFileType()
String	getId()
Integer	getJsonFileVersion()
KnowledgeBase	getKnowledgeBase()
String	getSelfUri()
KnowledgeOperationSource	getSource()
KnowledgeExportJobResponse.StatusEnum	getStatus()
int	hashCode()
KnowledgeExportJobResponse	id(String id)	Id of the export job.
KnowledgeExportJobResponse	jsonFileVersion(Integer jsonFileVersion)	Requested version of the exported json file.
KnowledgeExportJobResponse	knowledgeBase(KnowledgeBase knowledgeBase)	Knowledge base which document export belongs to.
void	setCountDocumentProcessed(Integer countDocumentProcessed)
void	setCreatedBy(UserReference createdBy)
void	setDateCreated(Date dateCreated)
void	setDateModified(Date dateModified)
void	setDownloadURL(String downloadURL)
void	setErrorInformation(ErrorBody errorInformation)
void	setExportFilter(KnowledgeExportJobFilter exportFilter)
void	setFileType(KnowledgeExportJobResponse.FileTypeEnum fileType)
void	setId(String id)
void	setJsonFileVersion(Integer jsonFileVersion)
void	setKnowledgeBase(KnowledgeBase knowledgeBase)
void	setSource(KnowledgeOperationSource source)
void	setStatus(KnowledgeExportJobResponse.StatusEnum status)
KnowledgeExportJobResponse	source(KnowledgeOperationSource source)	Source of the export job.
KnowledgeExportJobResponse	status(KnowledgeExportJobResponse.StatusEnum status)	The status of the export job.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

KnowledgeExportJobResponse

public KnowledgeExportJobResponse()

KnowledgeExportJobResponse

public KnowledgeExportJobResponse(Boolean initWithEmptyList)

Method Details

id

public KnowledgeExportJobResponse id(String id)

Id of the export job.

getId

public String getId()

setId

public void setId(String id)

downloadURL

public KnowledgeExportJobResponse downloadURL(String downloadURL)

The URL of the location at which the caller can download the export file, when available.

getDownloadURL

public String getDownloadURL()

setDownloadURL

public void setDownloadURL(String downloadURL)

fileType

public KnowledgeExportJobResponse fileType(KnowledgeExportJobResponse.FileTypeEnum fileType)

File type of the document

getFileType

public KnowledgeExportJobResponse.FileTypeEnum getFileType()

setFileType

public void setFileType(KnowledgeExportJobResponse.FileTypeEnum fileType)

jsonFileVersion

public KnowledgeExportJobResponse jsonFileVersion(Integer jsonFileVersion)

Requested version of the exported json file.

getJsonFileVersion

public Integer getJsonFileVersion()

setJsonFileVersion

public void setJsonFileVersion(Integer jsonFileVersion)

countDocumentProcessed

public KnowledgeExportJobResponse countDocumentProcessed(Integer countDocumentProcessed)

The current count of the number of records processed.

getCountDocumentProcessed

public Integer getCountDocumentProcessed()

setCountDocumentProcessed

public void setCountDocumentProcessed(Integer countDocumentProcessed)

exportFilter

public KnowledgeExportJobResponse exportFilter(KnowledgeExportJobFilter exportFilter)

Filters to narrow down what to export.

getExportFilter

public KnowledgeExportJobFilter getExportFilter()

setExportFilter

public void setExportFilter(KnowledgeExportJobFilter exportFilter)

status

public KnowledgeExportJobResponse status(KnowledgeExportJobResponse.StatusEnum status)

The status of the export job.

getStatus

public KnowledgeExportJobResponse.StatusEnum getStatus()

setStatus

public void setStatus(KnowledgeExportJobResponse.StatusEnum status)

knowledgeBase

public KnowledgeExportJobResponse knowledgeBase(KnowledgeBase knowledgeBase)

Knowledge base which document export belongs to.

getKnowledgeBase

public KnowledgeBase getKnowledgeBase()

setKnowledgeBase

public void setKnowledgeBase(KnowledgeBase knowledgeBase)

createdBy

public KnowledgeExportJobResponse createdBy(UserReference createdBy)

The user who created the operation

getCreatedBy

public UserReference getCreatedBy()

setCreatedBy

public void setCreatedBy(UserReference createdBy)

dateCreated

public KnowledgeExportJobResponse dateCreated(Date dateCreated)

The timestamp of when the export began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getDateCreated

public Date getDateCreated()

setDateCreated

public void setDateCreated(Date dateCreated)

dateModified

public KnowledgeExportJobResponse dateModified(Date dateModified)

The timestamp of when the export stopped. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getDateModified

public Date getDateModified()

setDateModified

public void setDateModified(Date dateModified)

errorInformation

public KnowledgeExportJobResponse errorInformation(ErrorBody errorInformation)

Any error information, or null of the processing is not in failed state.

getErrorInformation

public ErrorBody getErrorInformation()

setErrorInformation

public void setErrorInformation(ErrorBody errorInformation)

source

public KnowledgeExportJobResponse source(KnowledgeOperationSource source)

Source of the export job.

getSource

public KnowledgeOperationSource getSource()

setSource

public void setSource(KnowledgeOperationSource source)

getSelfUri

public String getSelfUri()

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