TranscriptionJob (AWS Java SDK for Amazon Transcribe 1.11.415 API)

java.lang.Object
- com.amazonaws.services.transcribe.model.TranscriptionJob

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TranscriptionJob
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes an asynchronous transcription job that was created with the StartTranscriptionJob operation.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TranscriptionJob()

Constructors
Constructor and Description
`TranscriptionJob()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TranscriptionJob`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCompletionTime()` A timestamp that shows when the job was completed.
`Date`	`getCreationTime()` A timestamp that shows when the job was created.
`String`	`getFailureReason()` If the `TranscriptionJobStatus` field is `FAILED`, this field contains information about why the job failed.
`String`	`getLanguageCode()` The language code for the input speech.
`Media`	`getMedia()` An object that describes the input media for the transcription job.
`String`	`getMediaFormat()` The format of the input media file.
`Integer`	`getMediaSampleRateHertz()` The sample rate, in Hertz, of the audio track in the input media file.
`Settings`	`getSettings()` Optional settings for the transcription job.
`Transcript`	`getTranscript()` An object that describes the output of the transcription job.
`String`	`getTranscriptionJobName()` The name of the transcription job.
`String`	`getTranscriptionJobStatus()` The status of the transcription job.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setCompletionTime(Date completionTime)` A timestamp that shows when the job was completed.
`void`	`setCreationTime(Date creationTime)` A timestamp that shows when the job was created.
`void`	`setFailureReason(String failureReason)` If the `TranscriptionJobStatus` field is `FAILED`, this field contains information about why the job failed.
`void`	`setLanguageCode(String languageCode)` The language code for the input speech.
`void`	`setMedia(Media media)` An object that describes the input media for the transcription job.
`void`	`setMediaFormat(String mediaFormat)` The format of the input media file.
`void`	`setMediaSampleRateHertz(Integer mediaSampleRateHertz)` The sample rate, in Hertz, of the audio track in the input media file.
`void`	`setSettings(Settings settings)` Optional settings for the transcription job.
`void`	`setTranscript(Transcript transcript)` An object that describes the output of the transcription job.
`void`	`setTranscriptionJobName(String transcriptionJobName)` The name of the transcription job.
`void`	`setTranscriptionJobStatus(String transcriptionJobStatus)` The status of the transcription job.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`TranscriptionJob`	`withCompletionTime(Date completionTime)` A timestamp that shows when the job was completed.
`TranscriptionJob`	`withCreationTime(Date creationTime)` A timestamp that shows when the job was created.
`TranscriptionJob`	`withFailureReason(String failureReason)` If the `TranscriptionJobStatus` field is `FAILED`, this field contains information about why the job failed.
`TranscriptionJob`	`withLanguageCode(LanguageCode languageCode)` The language code for the input speech.
`TranscriptionJob`	`withLanguageCode(String languageCode)` The language code for the input speech.
`TranscriptionJob`	`withMedia(Media media)` An object that describes the input media for the transcription job.
`TranscriptionJob`	`withMediaFormat(MediaFormat mediaFormat)` The format of the input media file.
`TranscriptionJob`	`withMediaFormat(String mediaFormat)` The format of the input media file.
`TranscriptionJob`	`withMediaSampleRateHertz(Integer mediaSampleRateHertz)` The sample rate, in Hertz, of the audio track in the input media file.
`TranscriptionJob`	`withSettings(Settings settings)` Optional settings for the transcription job.
`TranscriptionJob`	`withTranscript(Transcript transcript)` An object that describes the output of the transcription job.
`TranscriptionJob`	`withTranscriptionJobName(String transcriptionJobName)` The name of the transcription job.
`TranscriptionJob`	`withTranscriptionJobStatus(String transcriptionJobStatus)` The status of the transcription job.
`TranscriptionJob`	`withTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)` The status of the transcription job.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TranscriptionJob
```
public TranscriptionJob()
```
- Method Detail
  - setTranscriptionJobName
```
public void setTranscriptionJobName(String transcriptionJobName)
```
    The name of the transcription job.
    
    Parameters:
    
    transcriptionJobName - The name of the transcription job.
  - getTranscriptionJobName
```
public String getTranscriptionJobName()
```
    The name of the transcription job.
    
    Returns:
    
    The name of the transcription job.
  - withTranscriptionJobName
```
public TranscriptionJob withTranscriptionJobName(String transcriptionJobName)
```
    The name of the transcription job.
    
    Parameters:
    
    transcriptionJobName - The name of the transcription job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTranscriptionJobStatus
```
public void setTranscriptionJobStatus(String transcriptionJobStatus)
```
    The status of the transcription job.
    
    Parameters:
    
    transcriptionJobStatus - The status of the transcription job.
    
    See Also:
    
    TranscriptionJobStatus
  - getTranscriptionJobStatus
```
public String getTranscriptionJobStatus()
```
    The status of the transcription job.
    
    Returns:
    
    The status of the transcription job.
    
    See Also:
    
    TranscriptionJobStatus
  - withTranscriptionJobStatus
```
public TranscriptionJob withTranscriptionJobStatus(String transcriptionJobStatus)
```
    The status of the transcription job.
    
    Parameters:
    
    transcriptionJobStatus - The status of the transcription job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TranscriptionJobStatus
  - withTranscriptionJobStatus
```
public TranscriptionJob withTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)
```
    The status of the transcription job.
    
    Parameters:
    
    transcriptionJobStatus - The status of the transcription job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TranscriptionJobStatus
  - setLanguageCode
```
public void setLanguageCode(String languageCode)
```
    The language code for the input speech.
    
    Parameters:
    
    languageCode - The language code for the input speech.
    
    See Also:
    
    LanguageCode
  - getLanguageCode
```
public String getLanguageCode()
```
    The language code for the input speech.
    
    Returns:
    
    The language code for the input speech.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public TranscriptionJob withLanguageCode(String languageCode)
```
    The language code for the input speech.
    
    Parameters:
    
    languageCode - The language code for the input speech.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - withLanguageCode
```
public TranscriptionJob withLanguageCode(LanguageCode languageCode)
```
    The language code for the input speech.
    
    Parameters:
    
    languageCode - The language code for the input speech.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode
  - setMediaSampleRateHertz
```
public void setMediaSampleRateHertz(Integer mediaSampleRateHertz)
```
    The sample rate, in Hertz, of the audio track in the input media file.
    
    Parameters:
    
    mediaSampleRateHertz - The sample rate, in Hertz, of the audio track in the input media file.
  - getMediaSampleRateHertz
```
public Integer getMediaSampleRateHertz()
```
    The sample rate, in Hertz, of the audio track in the input media file.
    
    Returns:
    
    The sample rate, in Hertz, of the audio track in the input media file.
  - withMediaSampleRateHertz
```
public TranscriptionJob withMediaSampleRateHertz(Integer mediaSampleRateHertz)
```
    The sample rate, in Hertz, of the audio track in the input media file.
    
    Parameters:
    
    mediaSampleRateHertz - The sample rate, in Hertz, of the audio track in the input media file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMediaFormat
```
public void setMediaFormat(String mediaFormat)
```
    The format of the input media file.
    
    Parameters:
    
    mediaFormat - The format of the input media file.
    
    See Also:
    
    MediaFormat
  - getMediaFormat
```
public String getMediaFormat()
```
    The format of the input media file.
    
    Returns:
    
    The format of the input media file.
    
    See Also:
    
    MediaFormat
  - withMediaFormat
```
public TranscriptionJob withMediaFormat(String mediaFormat)
```
    The format of the input media file.
    
    Parameters:
    
    mediaFormat - The format of the input media file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MediaFormat
  - withMediaFormat
```
public TranscriptionJob withMediaFormat(MediaFormat mediaFormat)
```
    The format of the input media file.
    
    Parameters:
    
    mediaFormat - The format of the input media file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MediaFormat
  - setMedia
```
public void setMedia(Media media)
```
    An object that describes the input media for the transcription job.
    
    Parameters:
    
    media - An object that describes the input media for the transcription job.
  - getMedia
```
public Media getMedia()
```
    An object that describes the input media for the transcription job.
    
    Returns:
    
    An object that describes the input media for the transcription job.
  - withMedia
```
public TranscriptionJob withMedia(Media media)
```
    An object that describes the input media for the transcription job.
    
    Parameters:
    
    media - An object that describes the input media for the transcription job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTranscript
```
public void setTranscript(Transcript transcript)
```
    An object that describes the output of the transcription job.
    
    Parameters:
    
    transcript - An object that describes the output of the transcription job.
  - getTranscript
```
public Transcript getTranscript()
```
    An object that describes the output of the transcription job.
    
    Returns:
    
    An object that describes the output of the transcription job.
  - withTranscript
```
public TranscriptionJob withTranscript(Transcript transcript)
```
    An object that describes the output of the transcription job.
    
    Parameters:
    
    transcript - An object that describes the output of the transcription job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    A timestamp that shows when the job was created.
    
    Parameters:
    
    creationTime - A timestamp that shows when the job was created.
  - getCreationTime
```
public Date getCreationTime()
```
    A timestamp that shows when the job was created.
    
    Returns:
    
    A timestamp that shows when the job was created.
  - withCreationTime
```
public TranscriptionJob withCreationTime(Date creationTime)
```
    A timestamp that shows when the job was created.
    
    Parameters:
    
    creationTime - A timestamp that shows when the job was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCompletionTime
```
public void setCompletionTime(Date completionTime)
```
    A timestamp that shows when the job was completed.
    
    Parameters:
    
    completionTime - A timestamp that shows when the job was completed.
  - getCompletionTime
```
public Date getCompletionTime()
```
    A timestamp that shows when the job was completed.
    
    Returns:
    
    A timestamp that shows when the job was completed.
  - withCompletionTime
```
public TranscriptionJob withCompletionTime(Date completionTime)
```
    A timestamp that shows when the job was completed.
    
    Parameters:
    
    completionTime - A timestamp that shows when the job was completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.
    
    Parameters:
    
    failureReason - If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.
  - getFailureReason
```
public String getFailureReason()
```
    If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.
    
    Returns:
    
    If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.
  - withFailureReason
```
public TranscriptionJob withFailureReason(String failureReason)
```
    If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.
    
    Parameters:
    
    failureReason - If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSettings
```
public void setSettings(Settings settings)
```
    Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.
    
    Parameters:
    
    settings - Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.
  - getSettings
```
public Settings getSettings()
```
    Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.
    
    Returns:
    
    Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.
  - withSettings
```
public TranscriptionJob withSettings(Settings settings)
```
    Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.
    
    Parameters:
    
    settings - Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public TranscriptionJob clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class TranscriptionJob

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TranscriptionJob

Method Detail

setTranscriptionJobName

getTranscriptionJobName

withTranscriptionJobName

setTranscriptionJobStatus

getTranscriptionJobStatus

withTranscriptionJobStatus

withTranscriptionJobStatus

setLanguageCode

getLanguageCode

withLanguageCode

withLanguageCode

setMediaSampleRateHertz

getMediaSampleRateHertz

withMediaSampleRateHertz

setMediaFormat

getMediaFormat

withMediaFormat

withMediaFormat

setMedia

getMedia

withMedia

setTranscript

getTranscript

withTranscript

setCreationTime

getCreationTime

withCreationTime

setCompletionTime

getCompletionTime

withCompletionTime

setFailureReason

getFailureReason

withFailureReason

setSettings

getSettings

withSettings

toString

equals

hashCode

clone

marshall