java.lang.Object
- ai.rev.speechtotext.models.asynchronous.RevAiJobOptions

```
public class RevAiJobOptions
extends Object
```
A RevAiJobOptions object represents parameters that are submitted along a new job.

See Also:

https://docs.rev.ai/api/asynchronous/reference/#operation/SubmitTranscriptionJob

Constructor Summary

Constructors
Constructor Description

RevAiJobOptions()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`String`	`getCallbackUrl()`	Deprecated. Use notificationConfig and getNotificationConfig instead
`List<CustomVocabulary>`	`getCustomVocabularies()`	Returns a list of `CustomVocabulary` objects.
`String`	`getCustomVocabularyId()`	Returns the custom vocabulary ID.
`Integer`	`getDeleteAfterSeconds()`	Returns the value of deleteAfterSeconds.
`Boolean`	`getFilterProfanity()`	Returns the value of the filterProfanity Boolean
`String`	`getLanguage()`	Returns the value of language.
`String`	`getMediaUrl()`	Deprecated. Set sourceConfig and use getSourceConfig instead
`String`	`getMetadata()`	Returns the metadata.
`CustomerUrlData`	`getNotificationConfig()`	Returns the notification config object.
`Boolean`	`getRemoveDisfluencies()`	Returns the value of the removeDisfluencies Boolean
`Boolean`	`getRush()`	Returns the value of rush
`List<SegmentToTranscribe>`	`getSegmentsToTranscribe()`	Returns the segments in media to transcribe
`Boolean`	`getSkipDiarization()`	Returns the value of the skip diarization Boolean.
`Boolean`	`getSkipPunctuation()`	Returns the value of the skip punctuation Boolean.
`CustomerUrlData`	`getSourceConfig()`	Returns the source config object.
`Integer`	`getSpeakerChannelsCount()`	Returns the speaker channel count.
`Boolean`	`getTestMode()`	Returns the value of testMode
`String`	`getTranscriber()`	Specifies the type of transcriber to use to transcribe the media file
`Boolean`	`getVerbatim()`	Returns the value of verbatim
`void`	`setCallbackUrl(String callbackUrl)`	Deprecated. Use setNotificationConfig instead
`void`	`setCustomVocabularies(List<CustomVocabulary> customVocabularies)`	Provides the custom vocabularies to be used by the speech engine when processing the transcript.
`void`	`setCustomVocabularyId(String customVocabularyId)`	Specifies the ID of the custom vocabulary the speech engine should use while processing audio samples.
`void`	`setDeleteAfterSeconds(Integer deleteAfterSeconds)`	Specifies the number of seconds to be waited until the job is auto-deleted after its completion.
`void`	`setFilterProfanity(Boolean filterProfanity)`	Specifies whether or not the speech engine should filter profanity in the output.
`void`	`setLanguage(String language)`	Specifies language for ASR system using ISO 639-1 2-letter language code.
`void`	`setMediaUrl(String mediaUrl)`	Deprecated. Use setSourceConfig instead
`void`	`setMetadata(String metadata)`	Optional metadata that is provided during job submission limited to 512 characters.
`void`	`setNotificationConfig(String callbackUrl)`	Optional property to specify the callback url that Rev AI will POST to when job processing is complete
`void`	`setNotificationConfig(String callbackUrl, Map<String,String> authHeaders)`	Optional property to specify the callback url that Rev AI will POST to when job processing is complete
`void`	`setRemoveDisfluencies(Boolean removeDisfluencies)`	Specifies whether or not the speech engine should remove disfluencies in the output.
`void`	`setRush(Boolean rush)`	Sets whether job is given higher priority by human transcriber to be worked on sooner in exchange for a higher price.
`void`	`setSegmentsToTranscribe(List<SegmentToTranscribe> segmentsToTranscribe)`	Specifies specific segments of the media to transcribe.
`void`	`setSkipDiarization(Boolean skipDiarization)`	Specifies if speaker diarization will be skipped by the speech engine.
`void`	`setSkipPunctuation(Boolean skipPunctuation)`	Specifies if the "punct" elements will be skipped by the speech engine.
`void`	`setSourceConfig(String sourceMediaUrl)`	Specifies the source media download url.
`void`	`setSourceConfig(String sourceMediaUrl, Map<String,String> sourceAuth)`	Specifies the url and any optional auth headers to access the source media download url.
`void`	`setSpeakerChannelsCount(Integer speakerChannelsCount)`	Specifies the number of speaker channels in the audio.
`void`	`setTestMode(Boolean testMode)`	Sets whether job is a mocked job which will return a mock transcript.
`void`	`setTranscriber(String transcriber)`	Specifies the type of transcriber to use to transcribe the media file
`void`	`setVerbatim(Boolean verbatim)`	Sets whether transcriber will transcribe every syllable including disfluencies.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RevAiJobOptions
```
public RevAiJobOptions()
```
- Method Detail
  - getMediaUrl
```
@Deprecated
public String getMediaUrl()
```
    Deprecated.
    Set sourceConfig and use getSourceConfig instead
    
    Returns the media url.
    
    Returns:
    
    The media url.
  - setMediaUrl
```
@Deprecated
public void setMediaUrl(String mediaUrl)
```
    Deprecated.
    Use setSourceConfig instead
    
    Specifies the url where the media can be downloaded.
    
    Parameters:
    
    mediaUrl - The direct download url to the file.
  - getSourceConfig
```
public CustomerUrlData getSourceConfig()
```
    Returns the source config object.
    
    Returns:
    
    the source config.
  - setSourceConfig
```
public void setSourceConfig(String sourceMediaUrl,
                            Map<String,String> sourceAuth)
```
    Specifies the url and any optional auth headers to access the source media download url.
    
    Parameters:
    
    sourceMediaUrl - The direct download url to the file.
    
    sourceAuth - The auth headers to the source media download url.
  - setSourceConfig
```
public void setSourceConfig(String sourceMediaUrl)
```
    Specifies the source media download url.
    
    Parameters:
    
    sourceMediaUrl - The direct download url to the file.
  - getCallbackUrl
```
@Deprecated
public String getCallbackUrl()
```
    Deprecated.
    Use notificationConfig and getNotificationConfig instead
    
    Returns the callback url.
    
    Returns:
    
    the callback url.
  - setCallbackUrl
```
@Deprecated
public void setCallbackUrl(String callbackUrl)
```
    Deprecated.
    Use setNotificationConfig instead
    
    Specifies the callback url that Rev AI will POST to when job processing is complete. This property is optional.
    
    Parameters:
    
    callbackUrl - The url to POST to when job processing is complete.
  - getNotificationConfig
```
public CustomerUrlData getNotificationConfig()
```
    Returns the notification config object.
    
    Returns:
    
    the notification config.
  - setNotificationConfig
```
public void setNotificationConfig(String callbackUrl,
                                  Map<String,String> authHeaders)
```
    Optional property to specify the callback url that Rev AI will POST to when job processing is complete
    
    Parameters:
    
    callbackUrl - The url to POST to when job processing is complete.
    
    authHeaders - Optional parameter to authenticate access to the callback url
  - setNotificationConfig
```
public void setNotificationConfig(String callbackUrl)
```
    Optional property to specify the callback url that Rev AI will POST to when job processing is complete
    
    Parameters:
    
    callbackUrl - The url to POST to when job processing is complete.
  - getSkipDiarization
```
public Boolean getSkipDiarization()
```
    Returns the value of the skip diarization Boolean.
    
    Returns:
    
    The skip diarization value.
  - setSkipDiarization
```
public void setSkipDiarization(Boolean skipDiarization)
```
    Specifies if speaker diarization will be skipped by the speech engine. This property is optional and defaults to false.
    
    Parameters:
    
    skipDiarization - The value of the Boolean.
  - getSkipPunctuation
```
public Boolean getSkipPunctuation()
```
    Returns the value of the skip punctuation Boolean.
    
    Returns:
    
    The skip punctuation value.
  - setSkipPunctuation
```
public void setSkipPunctuation(Boolean skipPunctuation)
```
    Specifies if the "punct" elements will be skipped by the speech engine. This property is optional and defaults to false.
    
    Parameters:
    
    skipPunctuation - The value of the Boolean.
  - getSpeakerChannelsCount
```
public Integer getSpeakerChannelsCount()
```
    Returns the speaker channel count.
    
    Returns:
    
    The speaker channel count.
  - setSpeakerChannelsCount
```
public void setSpeakerChannelsCount(Integer speakerChannelsCount)
```
    Specifies the number of speaker channels in the audio. Each speaker channel is processed separately. When set the account will be charged the file * duration multiplied by the number of specified channels. This property is optional and defaults to null.
    
    Parameters:
    
    speakerChannelsCount - The number of separate speaker channels in the audio.
  - getCustomVocabularyId
```
public String getCustomVocabularyId()
```
    Returns the custom vocabulary ID.
    
    Returns:
    
    The custom vocabulary ID.
  - setCustomVocabularyId
```
public void setCustomVocabularyId(String customVocabularyId)
```
    Specifies the ID of the custom vocabulary the speech engine should use while processing audio samples. Custom vocabularies are submitted prior to usage in the stream and assigned an Id.
    
    Parameters:
    
    customVocabularyId - The ID of the custom vocabulary.
  - getCustomVocabularies
```
public List<CustomVocabulary> getCustomVocabularies()
```
    Returns a list of CustomVocabulary objects.
    
    Returns:
    
    A list of CustomVocabulary objects.
    
    See Also:
    
    CustomVocabulary
  - setCustomVocabularies
```
public void setCustomVocabularies(List<CustomVocabulary> customVocabularies)
```
    Provides the custom vocabularies to be used by the speech engine when processing the transcript. List size is limited to 50 items. Providing custom vocabularies is optional.
    
    Parameters:
    
    customVocabularies - A list of custom vocabularies.
    
    See Also:
    
    CustomVocabulary
  - getMetadata
```
public String getMetadata()
```
    Returns the metadata.
    
    Returns:
    
    A String that contains the metadata.
  - setMetadata
```
public void setMetadata(String metadata)
```
    Optional metadata that is provided during job submission limited to 512 characters.
    
    Parameters:
    
    metadata - A String to set as the metadata.
  - getFilterProfanity
```
public Boolean getFilterProfanity()
```
    Returns the value of the filterProfanity Boolean
    
    Returns:
    
    The filter profanity value.
  - setFilterProfanity
```
public void setFilterProfanity(Boolean filterProfanity)
```
    Specifies whether or not the speech engine should filter profanity in the output. Setting the profanity filter is optional.
    
    Parameters:
    
    filterProfanity - The option to filter profanity.
  - getRemoveDisfluencies
```
public Boolean getRemoveDisfluencies()
```
    Returns the value of the removeDisfluencies Boolean
    
    Returns:
    
    The removeDisfluencies value.
  - setRemoveDisfluencies
```
public void setRemoveDisfluencies(Boolean removeDisfluencies)
```
    Specifies whether or not the speech engine should remove disfluencies in the output. Setting the option to remove disfluencies is optional.
    
    Parameters:
    
    removeDisfluencies - The option to remove disfluencies.
  - getDeleteAfterSeconds
```
public Integer getDeleteAfterSeconds()
```
    Returns the value of deleteAfterSeconds.
    
    Returns:
    
    The deleteAfterSeconds value.
  - setDeleteAfterSeconds
```
public void setDeleteAfterSeconds(Integer deleteAfterSeconds)
```
    Specifies the number of seconds to be waited until the job is auto-deleted after its completion.
    
    Parameters:
    
    deleteAfterSeconds - The number of seconds after job completion when job is auto-deleted.
  - getLanguage
```
public String getLanguage()
```
    Returns the value of language.
    
    Returns:
    
    the language value.
  - setLanguage
```
public void setLanguage(String language)
```
    Specifies language for ASR system using ISO 639-1 2-letter language code.
    
    Parameters:
    
    language - ISO 639-1 2-letter language code of desired ASR language.
  - getTranscriber
```
public String getTranscriber()
```
    Specifies the type of transcriber to use to transcribe the media file
    
    Returns:
    
    the name of the transcriber type
  - setTranscriber
```
public void setTranscriber(String transcriber)
```
    Specifies the type of transcriber to use to transcribe the media file
    
    Parameters:
    
    transcriber - the name of the transcriber type
  - getVerbatim
```
public Boolean getVerbatim()
```
    Returns the value of verbatim
    
    Returns:
    
    Whether verbatim is true or false
  - setVerbatim
```
public void setVerbatim(Boolean verbatim)
```
    Sets whether transcriber will transcribe every syllable including disfluencies. This property is optional but can only be used with "human" transcriber. Defaults to false.
    
    Parameters:
    
    verbatim - Whether to transcribe every syllable
  - getRush
```
public Boolean getRush()
```
    Returns the value of rush
    
    Returns:
    
    Whether rush is true or false
  - setRush
```
public void setRush(Boolean rush)
```
    Sets whether job is given higher priority by human transcriber to be worked on sooner in exchange for a higher price. This property is optional but can only be used with "human" transcriber. Defaults to false.
    
    Parameters:
    
    rush - Whether to give higher priority to the job
  - getTestMode
```
public Boolean getTestMode()
```
    Returns the value of testMode
    
    Returns:
    
    Whether testMode is true or false
  - setTestMode
```
public void setTestMode(Boolean testMode)
```
    Sets whether job is a mocked job which will return a mock transcript. This property is optional but can only be used with "human" transcriber. Defaults to false.
    
    Parameters:
    
    testMode - Whether to set job to be test mode
  - getSegmentsToTranscribe
```
public List<SegmentToTranscribe> getSegmentsToTranscribe()
```
    Returns the segments in media to transcribe
    
    Returns:
    
    Segments to transcribe for the job
  - setSegmentsToTranscribe
```
public void setSegmentsToTranscribe(List<SegmentToTranscribe> segmentsToTranscribe)
```
    Specifies specific segments of the media to transcribe. This property is optional but can only be used with "human" transcriber.
    
    Parameters:
    
    segmentsToTranscribe - List of segments to transcribe

Class RevAiJobOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RevAiJobOptions

Method Detail

getMediaUrl

setMediaUrl

getSourceConfig

setSourceConfig

setSourceConfig

getCallbackUrl

setCallbackUrl

getNotificationConfig

setNotificationConfig

setNotificationConfig

getSkipDiarization

setSkipDiarization

getSkipPunctuation

setSkipPunctuation

getSpeakerChannelsCount

setSpeakerChannelsCount

getCustomVocabularyId

setCustomVocabularyId

getCustomVocabularies

setCustomVocabularies

getMetadata

setMetadata

getFilterProfanity

setFilterProfanity

getRemoveDisfluencies

setRemoveDisfluencies

getDeleteAfterSeconds

setDeleteAfterSeconds

getLanguage

setLanguage

getTranscriber

setTranscriber

getVerbatim

setVerbatim

getRush

setRush

getTestMode

setTestMode

getSegmentsToTranscribe

setSegmentsToTranscribe