TranscriptionJob (AWS Java SDK :: Services

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>
```
Provides detailed information about a transcription job.

To view the status of the specified transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

If you enabled content redaction, the redacted transcript can be found at the location specified in RedactedTranscriptFileUri.

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()` The date and time the specified transcription job finished processing.
`ContentRedaction`	`contentRedaction()` Redacts or flags specified personally identifiable information (PII) in your transcript.
`Instant`	`creationTime()` The date and time the specified transcription job request was made.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureReason()` If `TranscriptionJobStatus` is `FAILED`, `FailureReason` contains information about why the transcription job request failed.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasLanguageCodes()` For responses, this returns true if the service returned a value for the LanguageCodes property.
`boolean`	`hasLanguageIdSettings()` For responses, this returns true if the service returned a value for the LanguageIdSettings property.
`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()` The confidence score associated with the language identified in your media file.
`Boolean`	`identifyLanguage()` Indicates whether automatic language identification was enabled (`TRUE`) for the specified transcription job.
`Boolean`	`identifyMultipleLanguages()` Indicates whether automatic multi-language identification was enabled (`TRUE`) for the specified transcription job.
`JobExecutionSettings`	`jobExecutionSettings()` Provides information about how your transcription job is being processed.
`LanguageCode`	`languageCode()` The language code used to create your transcription job.
`String`	`languageCodeAsString()` The language code used to create your transcription job.
`List<LanguageCodeItem>`	`languageCodes()` The language codes used to create your transcription job.
`Map<LanguageCode,LanguageIdSettings>`	`languageIdSettings()` If using automatic language identification (`IdentifyLanguage`) in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include `LanguageIdSettings` with the relevant sub-parameters (`VocabularyName`, `LanguageModelName`, and `VocabularyFilterName`).
`Map<String,LanguageIdSettings>`	`languageIdSettingsAsStrings()` If using automatic language identification (`IdentifyLanguage`) in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include `LanguageIdSettings` with the relevant sub-parameters (`VocabularyName`, `LanguageModelName`, and `VocabularyFilterName`).
`List<LanguageCode>`	`languageOptions()` You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended.
`List<String>`	`languageOptionsAsStrings()` You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended.
`Media`	`media()` Describes the Amazon S3 location of the media file you want to use in your request.
`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 your input media file.
`ModelSettings`	`modelSettings()` The custom language model you want to include with your transcription job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TranscriptionJob.Builder>`	`serializableBuilderClass()`
`Settings`	`settings()` Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker labeling; allows you to apply custom vocabularies and vocabulary filters.
`Instant`	`startTime()` The date and time the specified transcription job began processing.
`SubtitlesOutput`	`subtitles()` Generate subtitles for your media file with your transcription request.
`List<Tag>`	`tags()` Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job.
`TranscriptionJob.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Transcript`	`transcript()` Provides you with the Amazon S3 URI you can use to access your transcript.
`String`	`transcriptionJobName()` The name of the transcription job.
`TranscriptionJobStatus`	`transcriptionJobStatus()` Provides the status of the specified transcription job.
`String`	`transcriptionJobStatusAsString()` Provides the status of the specified transcription job.

Methods inherited from class java.lang.Object
clone, finalize, 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. Job names are case sensitive and must be unique within an Amazon Web Services account.
    
    Returns:
    
    The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
  - transcriptionJobStatus
```
public final TranscriptionJobStatus transcriptionJobStatus()
```
    Provides the status of the specified transcription job.
    
    If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.
    
    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:
    
    Provides the status of the specified transcription job.
    
    If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.
    
    See Also:
    
    TranscriptionJobStatus
  - transcriptionJobStatusAsString
```
public final String transcriptionJobStatusAsString()
```
    Provides the status of the specified transcription job.
    
    If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.
    
    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:
    
    Provides the status of the specified transcription job.
    
    If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.
    
    See Also:
    
    TranscriptionJobStatus
  - languageCode
```
public final LanguageCode languageCode()
```
    The language code used to create your transcription job. For a list of supported languages and their associated language codes, refer to the Supported languages table.
    
    Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.
    
    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 used to create your transcription job. For a list of supported languages and their associated language codes, refer to the Supported languages table.
    
    Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.
    
    See Also:
    
    LanguageCode
  - languageCodeAsString
```
public final String languageCodeAsString()
```
    The language code used to create your transcription job. For a list of supported languages and their associated language codes, refer to the Supported languages table.
    
    Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.
    
    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 used to create your transcription job. For a list of supported languages and their associated language codes, refer to the Supported languages table.
    
    Note that you must include one of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages in your request. If you include more than one of these parameters, your transcription job fails.
    
    See Also:
    
    LanguageCode
  - mediaSampleRateHertz
```
public final Integer mediaSampleRateHertz()
```
    The sample rate, in Hertz, of the audio track in your input media file.
    
    Returns:
    
    The sample rate, in Hertz, of the audio track in your 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()
```
    Describes the Amazon S3 location of the media file you want to use in your request.
    
    Returns:
    
    Describes the Amazon S3 location of the media file you want to use in your request.
  - transcript
```
public final Transcript transcript()
```
    Provides you with the Amazon S3 URI you can use to access your transcript.
    
    Returns:
    
    Provides you with the Amazon S3 URI you can use to access your transcript.
  - startTime
```
public final Instant startTime()
```
    The date and time the specified transcription job began processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
    
    Returns:
    
    The date and time the specified transcription job began processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
  - creationTime
```
public final Instant creationTime()
```
    The date and time the specified transcription job request was made.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
    
    Returns:
    
    The date and time the specified transcription job request was made.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.
  - completionTime
```
public final Instant completionTime()
```
    The date and time the specified transcription job finished processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.
    
    Returns:
    
    The date and time the specified transcription job finished processing.
    
    Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.
  - failureReason
```
public final String failureReason()
```
    If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.
    
    The FailureReason field contains one of the following values:
    - Unsupported media format.
      
      The media format specified in MediaFormat isn't valid. Refer to MediaFormat for a list of supported formats.
    - The media format provided does not match the detected media format.
      
      The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.
    - Invalid sample rate for audio file.
      
      The sample rate specified in MediaSampleRateHertz 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 specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.
    - Invalid file size: file size too large.
      
      The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.
    - Invalid number of channels: number of channels too large.
      
      Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.
    Returns:
    If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.
    
    The FailureReason field contains one of the following values:
    
    Unsupported media format.
    
    The media format specified in MediaFormat isn't valid. Refer to MediaFormat for a list of supported formats.
    
    The media format provided does not match the detected media format.
    
    The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.
    
    Invalid sample rate for audio file.
    
    The sample rate specified in MediaSampleRateHertz 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 specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.
    
    Invalid file size: file size too large.
    
    The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas.
    
    Invalid number of channels: number of channels too large.
    
    Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.
  - settings
```
public final Settings settings()
```
    Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker labeling; allows you to apply custom vocabularies and vocabulary filters.
    
    If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter.
    
    If you're using automatic language identification with your request and want to include a custom language model, a custom vocabulary, or a custom vocabulary filter, do not use the Settings parameter; use instead the parameter with the LanguageModelName, VocabularyName or VocabularyFilterName sub-parameters.
    Returns: Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker labeling; allows you to apply custom vocabularies and vocabulary filters. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use Settings with the VocabularyName or VocabularyFilterName (or both) sub-parameter. If you're using automatic language identification with your request and want to include a custom language model, a custom vocabulary, or a custom vocabulary filter, do not use the Settings parameter; use instead the parameter with the LanguageModelName, VocabularyName or VocabularyFilterName sub-parameters.
  modelSettings public final ModelSettings modelSettings() The custom language model you want to include with your transcription job. If you include ModelSettings in your request, you must include the LanguageModelName sub-parameter. Returns: The custom language model you want to include with your transcription job. If you include ModelSettings in your request, you must include the LanguageModelName sub-parameter. jobExecutionSettings public final JobExecutionSettings jobExecutionSettings() Provides information about how your transcription job is being processed. This parameter shows if your request is queued and what data access role is being used. Returns: Provides information about how your transcription job is being processed. This parameter shows if your request is queued and what data access role is being used. contentRedaction public final ContentRedaction contentRedaction() Redacts or flags specified personally identifiable information (PII) in your transcript. Returns: Redacts or flags specified personally identifiable information (PII) in your transcript. identifyLanguage public final Boolean identifyLanguage() Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job. Returns: Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job. identifyMultipleLanguages public final Boolean identifyMultipleLanguages() Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job. Returns: Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job. languageOptions public final List<LanguageCode> languageOptions() You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter. If you include LanguageOptions in your request, you must also include IdentifyLanguage. For more information, refer to Supported languages. To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher. 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: You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter. If you include LanguageOptions in your request, you must also include IdentifyLanguage. For more information, refer to Supported languages. To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher. 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() You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter. If you include LanguageOptions in your request, you must also include IdentifyLanguage. For more information, refer to Supported languages. To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher. 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: You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages are present, do not include this parameter. If you include LanguageOptions in your request, you must also include IdentifyLanguage. For more information, refer to Supported languages. To transcribe speech in Modern Standard Arabic (ar-SA), your media file must be encoded at a sample rate of 16,000 Hz or higher. identifiedLanguageScore public final Float identifiedLanguageScore() The confidence score associated with the language identified in your media file. Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media. Returns: The confidence score associated with the language identified in your media file. Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media. hasLanguageCodes public final boolean hasLanguageCodes() For responses, this returns true if the service returned a value for the LanguageCodes 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. languageCodes public final List<LanguageCodeItem> languageCodes() The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification requests, refer to the singular version of this parameter, LanguageCode. For a list of supported languages and their associated language codes, refer to the Supported languages table. 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 hasLanguageCodes() method. Returns: The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification requests, refer to the singular version of this parameter, LanguageCode. For a list of supported languages and their associated language codes, refer to the Supported languages table. 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() Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. 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: Adds one or more custom tags, each in the form of a key:value pair, to a new transcription job at the time you start this new job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources. subtitles public final SubtitlesOutput subtitles() Generate subtitles for your media file with your transcription request. Returns: Generate subtitles for your media file with your transcription request. languageIdSettings public final Map<LanguageCode,LanguageIdSettings> languageIdSettings() If using automatic language identification (IdentifyLanguage) in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters. To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification. If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter. 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 hasLanguageIdSettings() method. Returns: If using automatic language identification (IdentifyLanguage) in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters. To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification. If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter. hasLanguageIdSettings public final boolean hasLanguageIdSettings() For responses, this returns true if the service returned a value for the LanguageIdSettings 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. languageIdSettingsAsStrings public final Map<String,LanguageIdSettings> languageIdSettingsAsStrings() If using automatic language identification (IdentifyLanguage) in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters. To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification. If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter. 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 hasLanguageIdSettings() method. Returns: If using automatic language identification (IdentifyLanguage) in your request and you want to apply a custom language model, a custom vocabulary, or a custom vocabulary filter, include LanguageIdSettings with the relevant sub-parameters (VocabularyName, LanguageModelName, and VocabularyFilterName). You can specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. Each language code you include can have an associated custom language model, custom vocabulary, and custom vocabulary filter. The languages you specify must match the languages of the specified custom language models, custom vocabularies, and custom vocabulary filters. To include language options using IdentifyLanguage without including a custom language model, a custom vocabulary, or a custom vocabulary filter, use LanguageOptions instead of LanguageIdSettings. Including language options can improve the accuracy of automatic language identification. If you want to include a custom language model with your request but do not want to use automatic language identification, use instead the parameter with the LanguageModelName sub-parameter. If you want to include a custom vocabulary or a custom vocabulary filter (or both) with your request but do not want to use automatic language identification, use instead the parameter with the VocabularyName or VocabularyFilterName (or both) sub-parameter. toBuilder public TranscriptionJob.Builder toBuilder() Specified by: toBuilder in interface ToCopyableBuilder<TranscriptionJob.Builder,TranscriptionJob> 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) Specified by: equalsBySdkFields in interface SdkPojo 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

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

identifyMultipleLanguages

languageOptions

hasLanguageOptions

languageOptionsAsStrings

identifiedLanguageScore

hasLanguageCodes

languageCodes

hasTags

tags

subtitles

languageIdSettings

hasLanguageIdSettings

languageIdSettingsAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields