Class RevAiJob


  • public class RevAiJob
    extends Object
    A RevAi Job object provides all the information associated with a job submitted by the user.
    • Constructor Detail

      • RevAiJob

        public RevAiJob()
    • 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.
      • setJobStatus

        public void setJobStatus​(RevAiJobStatus jobStatus)
        Sets the job status to the provided RevAiJobStatus enumeration value.
        Parameters:
        jobStatus - The enumeration value to set as the job status.
        See Also:
        RevAiJobStatus
      • 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.
      • getDurationSeconds

        public Double getDurationSeconds()
        Returns the audio duration of the file in seconds.
        Returns:
        The audio duration of the file in seconds.
      • setDurationSeconds

        public void setDurationSeconds​(Double durationSeconds)
        Sets the audio duration.
        Parameters:
        durationSeconds - An Integer value to set as audio duration.
      • getMediaUrl

        public String getMediaUrl()
        Returns the media url provided in the submission request.
        Returns:
        A String containing the media url provided in the submission request.
      • setMediaUrl

        public void setMediaUrl​(String mediaUrl)
        Sets the media url.
        Parameters:
        mediaUrl - A String value to set as the media url.
      • 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.
      • getName

        public String getName()
        Returns the name of the file provided in the submission request.
        Returns:
        A String that contains the name of the file provided in the submission request.
      • setName

        public void setName​(String name)
        Sets the file name.
        Parameters:
        name - A String to set as the file name.
      • setType

        public void setType​(RevAiJobType type)
        Sets the job type to the provided RevAiJobType enumeration.
        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.