Package ai.rev.sentimentanalysis.models
Class SentimentAnalysisJob
- java.lang.Object
-
- ai.rev.sentimentanalysis.models.SentimentAnalysisJob
-
public class SentimentAnalysisJob extends Object
A Sentiment Analysis Job object provides all the information associated with a job submitted by the user.
-
-
Constructor Summary
Constructors Constructor Description SentimentAnalysisJob()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetCallbackUrl()Returns the callback url provided in the submission request.StringgetCompletedOn()Returns a String that contains the date and time the job was completed on in ISO-8601 UTC form.StringgetCreatedOn()Returns a String that contains the date and time the job was created on in ISO-8601 UTC form.IntegergetDeleteAfterSeconds()Returns the duration in seconds before job is deletedRevAiFailureTypegetFailure()Returns theRevAiFailureTypeenumeration value.StringgetFailureDetails()Returns a detailed, human readable explanation of the failure.StringgetJobId()Returns a String that contains the job ID.SentimentAnalysisJobStatusgetJobStatus()Returns theSentimentAnalysisJobStatusenumeration value.StringgetLanguage()Returns language of the jobStringgetMetadata()Returns the metadata provided in the submission request.RevAiJobTypegetType()Returns theRevAiJobTypeenumeration value.IntegergetWordCount()Returns the word count of the submission.voidsetCallbackUrl(String callbackUrl)Sets the callback url.voidsetCompletedOn(String completedOn)Set the date and time the job was completed on.voidsetCreatedOn(String createdOn)Sets the time and date the job was created on.voidsetDeleteAfterSeconds(Integer deleteAfterSeconds)Sets the duration in seconds before job is deletedvoidsetFailure(RevAiFailureType failure)Sets the failure to the providedRevAiFailureTypeenumeration.voidsetFailureDetails(String failureDetails)Sets the failure details to the provided value.voidsetJobId(String jobId)Sets the Job ID.voidsetJobStatus(SentimentAnalysisJobStatus jobStatus)Sets the job status to the providedSentimentAnalysisJobStatusenumeration value.voidsetLanguage(String language)Sets the language for jobvoidsetMetadata(String metadata)Sets the metadata.voidsetType(RevAiJobType type)Sets the job type to the providedRevAiJobTypeenumeration.voidsetWordCount(Integer wordCount)Sets the word count.StringtoString()
-
-
-
Method Detail
-
getJobId
public String getJobId()
Returns a String that contains the job ID.- Returns:
- A String that contains the job ID.
-
setJobId
public void setJobId(String jobId)
Sets the Job ID.- Parameters:
jobId- The String value to set as the job ID.
-
getJobStatus
public SentimentAnalysisJobStatus getJobStatus()
Returns theSentimentAnalysisJobStatusenumeration value.- Returns:
- The
SentimentAnalysisJobStatusenumeration value. - See Also:
SentimentAnalysisJobStatus
-
setJobStatus
public void setJobStatus(SentimentAnalysisJobStatus jobStatus)
Sets the job status to the providedSentimentAnalysisJobStatusenumeration value.- Parameters:
jobStatus- The enumeration value to set as the job status.- See Also:
SentimentAnalysisJobStatus
-
getCreatedOn
public String getCreatedOn()
Returns a String that contains the date and time the job was created on in ISO-8601 UTC form.- Returns:
- A String that contains the date and time the job was created on in ISO-8601 UTC form.
-
setCreatedOn
public void setCreatedOn(String createdOn)
Sets the time and date the job was created on.- Parameters:
createdOn- The String value to set as the created on date and time.
-
getCompletedOn
public String getCompletedOn()
Returns a String that contains the date and time the job was completed on in ISO-8601 UTC form.- Returns:
- A String that contains the date and time the job was completed on in ISO-8601 UTC form.
-
setCompletedOn
public void setCompletedOn(String completedOn)
Set the date and time the job was completed on.- Parameters:
completedOn- The String value to set as the date and time the job was completed on.
-
getCallbackUrl
public String getCallbackUrl()
Returns the callback url provided in the submission request.- Returns:
- A String containing the callback url provided in the submission request.
-
setCallbackUrl
public void setCallbackUrl(String callbackUrl)
Sets the callback url.- Parameters:
callbackUrl- A String value to set as the callback url.
-
getWordCount
public Integer getWordCount()
Returns the word count of the submission.- Returns:
- A String containing the word count of the submission.
-
setWordCount
public void setWordCount(Integer wordCount)
Sets the word count.- Parameters:
wordCount- An Integer value to set as the word count.
-
getMetadata
public String getMetadata()
Returns the metadata provided in the submission request.- Returns:
- A String containing the metadata provided in the submission request.
-
setMetadata
public void setMetadata(String metadata)
Sets the metadata.- Parameters:
metadata- A String to set as the metadata.
-
getType
public RevAiJobType getType()
Returns theRevAiJobTypeenumeration value.- Returns:
- the enumeration value.
- See Also:
RevAiJobType
-
setType
public void setType(RevAiJobType type)
Sets the job type to the providedRevAiJobTypeenumeration.- Parameters:
type- The enumeration value to set as the job type.- See Also:
RevAiJobType
-
getFailureDetails
public String getFailureDetails()
Returns a detailed, human readable explanation of the failure.- Returns:
- A detailed, human readable explanation of the failure.
-
setFailureDetails
public void setFailureDetails(String failureDetails)
Sets the failure details to the provided value.- Parameters:
failureDetails- A String to set as the failure details.
-
getFailure
public RevAiFailureType getFailure()
Returns theRevAiFailureTypeenumeration value.- Returns:
- The
RevAiFailureTypeenumeration value. - See Also:
RevAiFailureType
-
setFailure
public void setFailure(RevAiFailureType failure)
Sets the failure to the providedRevAiFailureTypeenumeration.- Parameters:
failure- The enumeration value to set as the failure.- See Also:
RevAiFailureType
-
getDeleteAfterSeconds
public Integer getDeleteAfterSeconds()
Returns the duration in seconds before job is deleted- Returns:
- The duration in seconds.
-
setDeleteAfterSeconds
public void setDeleteAfterSeconds(Integer deleteAfterSeconds)
Sets the duration in seconds before job is deleted- Parameters:
deleteAfterSeconds- An Integer value to set as seconds before deletion.
-
getLanguage
public String getLanguage()
Returns language of the job- Returns:
- language of the job
-
setLanguage
public void setLanguage(String language)
Sets the language for job- Parameters:
language- An String value to set for language
-
-