TranscriptionJob (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.transcribe.model.TranscriptionJob

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TranscriptionJob.Builder,TranscriptionJob>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class TranscriptionJob
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TranscriptionJob.Builder,TranscriptionJob>
```
Describes an asynchronous transcription job that was created with the StartTranscriptionJob operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface TranscriptionJob.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`TranscriptionJob.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static TranscriptionJob.Builder`	`builder()`
`Instant`	`completionTime()` A timestamp that shows when the job completed.
`ContentRedaction`	`contentRedaction()` An object that describes content redaction settings for the transcription job.
`Instant`	`creationTime()` A timestamp that shows when the job was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`String`	`failureReason()` If the `TranscriptionJobStatus` field is `FAILED`, this field contains information about why the job failed.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasLanguageOptions()` For responses, this returns true if the service returned a value for the LanguageOptions property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`Float`	`identifiedLanguageScore()` A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio.
`Boolean`	`identifyLanguage()` A value that shows if automatic language identification was enabled for a transcription job.
`JobExecutionSettings`	`jobExecutionSettings()` Provides information about how a transcription job is executed.
`LanguageCode`	`languageCode()` The language code for the input speech.
`String`	`languageCodeAsString()` The language code for the input speech.
`List<LanguageCode>`	`languageOptions()` An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.
`List<String>`	`languageOptionsAsStrings()` An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.
`Media`	`media()` An object that describes the input media for the transcription job.
`MediaFormat`	`mediaFormat()` The format of the input media file.
`String`	`mediaFormatAsString()` The format of the input media file.
`Integer`	`mediaSampleRateHertz()` The sample rate, in Hertz, of the audio track in the input media file.
`ModelSettings`	`modelSettings()` An object containing the details of your custom language model.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TranscriptionJob.Builder>`	`serializableBuilderClass()`
`Settings`	`settings()` Optional settings for the transcription job.
`Instant`	`startTime()` A timestamp that shows when the job started processing.
`SubtitlesOutput`	`subtitles()` Generate subtitles for your batch transcription job.
`List<Tag>`	`tags()` A key:value pair assigned to a given transcription job.
`TranscriptionJob.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.
`Transcript`	`transcript()` An object that describes the output of the transcription job.
`String`	`transcriptionJobName()` The name of the transcription job.
`TranscriptionJobStatus`	`transcriptionJobStatus()` The status of the transcription job.
`String`	`transcriptionJobStatusAsString()` The status of the transcription job.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - transcriptionJobName
```
public final String transcriptionJobName()
```
    The name of the transcription job.
    
    Returns:
    
    The name of the transcription job.
  - transcriptionJobStatus
```
public final TranscriptionJobStatus transcriptionJobStatus()
```
    The status of the transcription job.
    
    If the service returns an enum value that is not available in the current SDK version, transcriptionJobStatus will return TranscriptionJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transcriptionJobStatusAsString().
    
    Returns:
    
    The status of the transcription job.
    
    See Also:
    
    TranscriptionJobStatus
  - transcriptionJobStatusAsString
```
public final String transcriptionJobStatusAsString()
```
    The status of the transcription job.
    
    If the service returns an enum value that is not available in the current SDK version, transcriptionJobStatus will return TranscriptionJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transcriptionJobStatusAsString().
    
    Returns:
    
    The status of the transcription job.
    
    See Also:
    
    TranscriptionJobStatus
  - languageCode
```
public final LanguageCode languageCode()
```
    The language code for the input speech.
    
    If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().
    
    Returns:
    
    The language code for the input speech.
    
    See Also:
    
    LanguageCode
  - languageCodeAsString
```
public final String languageCodeAsString()
```
    The language code for the input speech.
    
    If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().
    
    Returns:
    
    The language code for the input speech.
    
    See Also:
    
    LanguageCode
  - mediaSampleRateHertz
```
public final Integer mediaSampleRateHertz()
```
    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.
  - mediaFormat
```
public final MediaFormat mediaFormat()
```
    The format of the input media file.
    
    If the service returns an enum value that is not available in the current SDK version, mediaFormat will return MediaFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaFormatAsString().
    
    Returns:
    
    The format of the input media file.
    
    See Also:
    
    MediaFormat
  - mediaFormatAsString
```
public final String mediaFormatAsString()
```
    The format of the input media file.
    
    If the service returns an enum value that is not available in the current SDK version, mediaFormat will return MediaFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaFormatAsString().
    
    Returns:
    
    The format of the input media file.
    
    See Also:
    
    MediaFormat
  - media
```
public final Media media()
```
    An object that describes the input media for the transcription job.
    
    Returns:
    
    An object that describes the input media for the transcription job.
  - transcript
```
public final Transcript transcript()
```
    An object that describes the output of the transcription job.
    
    Returns:
    
    An object that describes the output of the transcription job.
  - startTime
```
public final Instant startTime()
```
    A timestamp that shows when the job started processing.
    
    Returns:
    
    A timestamp that shows when the job started processing.
  - creationTime
```
public final Instant creationTime()
```
    A timestamp that shows when the job was created.
    
    Returns:
    
    A timestamp that shows when the job was created.
  - completionTime
```
public final Instant completionTime()
```
    A timestamp that shows when the job completed.
    
    Returns:
    
    A timestamp that shows when the job completed.
  - failureReason
```
public final String failureReason()
```
    If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.
    
    The FailureReason field can contain one of the following values:
    - Unsupported media format - The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.
    - The media format provided does not match the detected media format - The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure that the two values match.
    - Invalid sample rate for audio file - The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.
    - The sample rate provided does not match the detected sample rate - The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.
    - Invalid file size: file size too large - The size of your audio file is larger than Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide.
    - Invalid number of channels: number of channels too large - Your audio contains more channels than Amazon Transcribe is configured to process. To request additional channels, see Amazon Transcribe Limits in the Amazon Web Services General Reference.
    Returns:
    If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.
    
    The FailureReason field can contain one of the following values:
    
    Unsupported media format - The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.
    
    The media format provided does not match the detected media format - The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure that the two values match.
    
    Invalid sample rate for audio file - The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz.
    
    The sample rate provided does not match the detected sample rate - The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.
    
    Invalid file size: file size too large - The size of your audio file is larger than Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide.
    
    Invalid number of channels: number of channels too large - Your audio contains more channels than Amazon Transcribe is configured to process. To request additional channels, see Amazon Transcribe Limits in the Amazon Web Services General Reference.
  - settings
```
public final 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.
    
    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.
  - modelSettings
```
public final ModelSettings modelSettings()
```
    An object containing the details of your custom language model.
    
    Returns:
    
    An object containing the details of your custom language model.
  - jobExecutionSettings
```
public final JobExecutionSettings jobExecutionSettings()
```
    Provides information about how a transcription job is executed.
    
    Returns:
    
    Provides information about how a transcription job is executed.
  - contentRedaction
```
public final ContentRedaction contentRedaction()
```
    An object that describes content redaction settings for the transcription job.
    
    Returns:
    
    An object that describes content redaction settings for the transcription job.
  - identifyLanguage
```
public final Boolean identifyLanguage()
```
    A value that shows if automatic language identification was enabled for a transcription job.
    
    Returns:
    
    A value that shows if automatic language identification was enabled for a transcription job.
  - languageOptions
```
public final List<LanguageCode> languageOptions()
```
    An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLanguageOptions() method.
    
    Returns:
    
    An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.
  - hasLanguageOptions
```
public final boolean hasLanguageOptions()
```
    For responses, this returns true if the service returned a value for the LanguageOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - languageOptionsAsStrings
```
public final List<String> languageOptionsAsStrings()
```
    An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLanguageOptions() method.
    
    Returns:
    
    An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.
  - identifiedLanguageScore
```
public final Float identifiedLanguageScore()
```
    A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the language it identified.
    
    Returns:
    
    A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the language it identified.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<Tag> tags()
```
    A key:value pair assigned to a given transcription job.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    A key:value pair assigned to a given transcription job.
  - subtitles
```
public final SubtitlesOutput subtitles()
```
    Generate subtitles for your batch transcription job.
    
    Returns:
    
    Generate subtitles for your batch transcription job.
  - toBuilder
```
public TranscriptionJob.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TranscriptionJob.Builder,TranscriptionJob>
    
    Returns:
    
    a builder for type T
  - builder
```
public static TranscriptionJob.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TranscriptionJob.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.17.66

Class TranscriptionJob

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

transcriptionJobName

transcriptionJobStatus

transcriptionJobStatusAsString

languageCode

languageCodeAsString

mediaSampleRateHertz

mediaFormat

mediaFormatAsString

media

transcript

startTime

creationTime

completionTime

failureReason

settings

modelSettings

jobExecutionSettings

contentRedaction

identifyLanguage

languageOptions

hasLanguageOptions

languageOptionsAsStrings

identifiedLanguageScore

hasTags

tags

subtitles

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields