TranscriptionJob.Builder (AWS Java SDK :: Services

All Superinterfaces:

Buildable, CopyableBuilder<TranscriptionJob.Builder,TranscriptionJob>, SdkBuilder<TranscriptionJob.Builder,TranscriptionJob>, SdkPojo

Enclosing class:

TranscriptionJob
```
public static interface TranscriptionJob.Builder
extends SdkPojo, CopyableBuilder<TranscriptionJob.Builder,TranscriptionJob>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`TranscriptionJob.Builder`	`completionTime(Instant completionTime)` The date and time the specified transcription job finished processing.
`default TranscriptionJob.Builder`	`contentRedaction(Consumer<ContentRedaction.Builder> contentRedaction)` Redacts or flags specified personally identifiable information (PII) in your transcript.
`TranscriptionJob.Builder`	`contentRedaction(ContentRedaction contentRedaction)` Redacts or flags specified personally identifiable information (PII) in your transcript.
`TranscriptionJob.Builder`	`creationTime(Instant creationTime)` The date and time the specified transcription job request was made.
`TranscriptionJob.Builder`	`failureReason(String failureReason)` If `TranscriptionJobStatus` is `FAILED`, `FailureReason` contains information about why the transcription job request failed.
`TranscriptionJob.Builder`	`identifiedLanguageScore(Float identifiedLanguageScore)` The confidence score associated with the language identified in your media file.
`TranscriptionJob.Builder`	`identifyLanguage(Boolean identifyLanguage)` Indicates whether automatic language identification was enabled (`TRUE`) for the specified transcription job.
`TranscriptionJob.Builder`	`identifyMultipleLanguages(Boolean identifyMultipleLanguages)` Indicates whether automatic multi-language identification was enabled (`TRUE`) for the specified transcription job.
`default TranscriptionJob.Builder`	`jobExecutionSettings(Consumer<JobExecutionSettings.Builder> jobExecutionSettings)` Provides information about how your transcription job is being processed.
`TranscriptionJob.Builder`	`jobExecutionSettings(JobExecutionSettings jobExecutionSettings)` Provides information about how your transcription job is being processed.
`TranscriptionJob.Builder`	`languageCode(LanguageCode languageCode)` The language code used to create your transcription job.
`TranscriptionJob.Builder`	`languageCode(String languageCode)` The language code used to create your transcription job.
`TranscriptionJob.Builder`	`languageCodes(Collection<LanguageCodeItem> languageCodes)` The language codes used to create your transcription job.
`TranscriptionJob.Builder`	`languageCodes(Consumer<LanguageCodeItem.Builder>... languageCodes)` The language codes used to create your transcription job.
`TranscriptionJob.Builder`	`languageCodes(LanguageCodeItem... languageCodes)` The language codes used to create your transcription job.
`TranscriptionJob.Builder`	`languageIdSettings(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`).
`TranscriptionJob.Builder`	`languageIdSettingsWithStrings(Map<String,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`).
`TranscriptionJob.Builder`	`languageOptions(Collection<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.
`TranscriptionJob.Builder`	`languageOptions(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.
`TranscriptionJob.Builder`	`languageOptionsWithStrings(Collection<String> 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.
`TranscriptionJob.Builder`	`languageOptionsWithStrings(String... 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.
`default TranscriptionJob.Builder`	`media(Consumer<Media.Builder> media)` Describes the Amazon S3 location of the media file you want to use in your request.
`TranscriptionJob.Builder`	`media(Media media)` Describes the Amazon S3 location of the media file you want to use in your request.
`TranscriptionJob.Builder`	`mediaFormat(MediaFormat mediaFormat)` The format of the input media file.
`TranscriptionJob.Builder`	`mediaFormat(String mediaFormat)` The format of the input media file.
`TranscriptionJob.Builder`	`mediaSampleRateHertz(Integer mediaSampleRateHertz)` The sample rate, in Hertz, of the audio track in your input media file.
`default TranscriptionJob.Builder`	`modelSettings(Consumer<ModelSettings.Builder> modelSettings)` The custom language model you want to include with your transcription job.
`TranscriptionJob.Builder`	`modelSettings(ModelSettings modelSettings)` The custom language model you want to include with your transcription job.
`default TranscriptionJob.Builder`	`settings(Consumer<Settings.Builder> settings)` Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker labeling; allows you to apply custom vocabularies and vocabulary filters.
`TranscriptionJob.Builder`	`settings(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.
`TranscriptionJob.Builder`	`startTime(Instant startTime)` The date and time the specified transcription job began processing.
`default TranscriptionJob.Builder`	`subtitles(Consumer<SubtitlesOutput.Builder> subtitles)` Generate subtitles for your media file with your transcription request.
`TranscriptionJob.Builder`	`subtitles(SubtitlesOutput subtitles)` Generate subtitles for your media file with your transcription request.
`TranscriptionJob.Builder`	`tags(Collection<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`	`tags(Consumer<Tag.Builder>... 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`	`tags(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.
`default TranscriptionJob.Builder`	`transcript(Consumer<Transcript.Builder> transcript)` Provides you with the Amazon S3 URI you can use to access your transcript.
`TranscriptionJob.Builder`	`transcript(Transcript transcript)` Provides you with the Amazon S3 URI you can use to access your transcript.
`TranscriptionJob.Builder`	`transcriptionJobName(String transcriptionJobName)` The name of the transcription job.
`TranscriptionJob.Builder`	`transcriptionJobStatus(String transcriptionJobStatus)` Provides the status of the specified transcription job.
`TranscriptionJob.Builder`	`transcriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)` Provides the status of the specified transcription job.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

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

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - transcriptionJobName
```
TranscriptionJob.Builder transcriptionJobName(String transcriptionJobName)
```
    The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
    
    Parameters:
    
    transcriptionJobName - The name of the transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - transcriptionJobStatus
```
TranscriptionJob.Builder transcriptionJobStatus(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TranscriptionJobStatus, TranscriptionJobStatus
  - transcriptionJobStatus
```
TranscriptionJob.Builder transcriptionJobStatus(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TranscriptionJobStatus, TranscriptionJobStatus
  - languageCode
```
TranscriptionJob.Builder languageCode(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode, LanguageCode
  - languageCode
```
TranscriptionJob.Builder languageCode(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LanguageCode, LanguageCode
  - mediaSampleRateHertz
```
TranscriptionJob.Builder mediaSampleRateHertz(Integer mediaSampleRateHertz)
```
    The sample rate, in Hertz, of the audio track in your input media file.
    
    Parameters:
    
    mediaSampleRateHertz - The sample rate, in Hertz, of the audio track in your input media file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - mediaFormat
```
TranscriptionJob.Builder mediaFormat(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, MediaFormat
  - mediaFormat
```
TranscriptionJob.Builder mediaFormat(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, MediaFormat
  - media
```
TranscriptionJob.Builder media(Media media)
```
    Describes the Amazon S3 location of the media file you want to use in your request.
    
    Parameters:
    
    media - Describes the Amazon S3 location of the media file you want to use in your request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - media
```
default TranscriptionJob.Builder media(Consumer<Media.Builder> media)
```
    Describes the Amazon S3 location of the media file you want to use in your request.
    This is a convenience method that creates an instance of the Media.Builder avoiding the need to create one manually via Media.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to media(Media).
    
    Parameters:
    
    media - a consumer that will call methods on Media.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    media(Media)
  - transcript
```
TranscriptionJob.Builder transcript(Transcript transcript)
```
    Provides you with the Amazon S3 URI you can use to access your transcript.
    
    Parameters:
    
    transcript - Provides you with the Amazon S3 URI you can use to access your transcript.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - transcript
```
default TranscriptionJob.Builder transcript(Consumer<Transcript.Builder> transcript)
```
    Provides you with the Amazon S3 URI you can use to access your transcript.
    This is a convenience method that creates an instance of the Transcript.Builder avoiding the need to create one manually via Transcript.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to transcript(Transcript).
    
    Parameters:
    
    transcript - a consumer that will call methods on Transcript.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    transcript(Transcript)
  - startTime
```
TranscriptionJob.Builder startTime(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - creationTime
```
TranscriptionJob.Builder creationTime(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - completionTime
```
TranscriptionJob.Builder completionTime(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - failureReason
```
TranscriptionJob.Builder failureReason(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - settings
```
TranscriptionJob.Builder settings(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.
    Parameters: 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: Returns a reference to this object so that method calls can be chained together.
  settings default TranscriptionJob.Builder settings(Consumer<Settings.Builder> 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. This is a convenience method that creates an instance of the Settings.Builder avoiding the need to create one manually via Settings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to settings(Settings). Parameters: settings - a consumer that will call methods on Settings.Builder Returns: Returns a reference to this object so that method calls can be chained together. See Also: settings(Settings) modelSettings TranscriptionJob.Builder modelSettings(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. Parameters: 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: Returns a reference to this object so that method calls can be chained together. modelSettings default TranscriptionJob.Builder modelSettings(Consumer<ModelSettings.Builder> 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. This is a convenience method that creates an instance of the ModelSettings.Builder avoiding the need to create one manually via ModelSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to modelSettings(ModelSettings). Parameters: modelSettings - a consumer that will call methods on ModelSettings.Builder Returns: Returns a reference to this object so that method calls can be chained together. See Also: modelSettings(ModelSettings) jobExecutionSettings TranscriptionJob.Builder jobExecutionSettings(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. Parameters: 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: Returns a reference to this object so that method calls can be chained together. jobExecutionSettings default TranscriptionJob.Builder jobExecutionSettings(Consumer<JobExecutionSettings.Builder> 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. This is a convenience method that creates an instance of the JobExecutionSettings.Builder avoiding the need to create one manually via JobExecutionSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jobExecutionSettings(JobExecutionSettings). Parameters: jobExecutionSettings - a consumer that will call methods on JobExecutionSettings.Builder Returns: Returns a reference to this object so that method calls can be chained together. See Also: jobExecutionSettings(JobExecutionSettings) contentRedaction TranscriptionJob.Builder contentRedaction(ContentRedaction contentRedaction) Redacts or flags specified personally identifiable information (PII) in your transcript. Parameters: contentRedaction - Redacts or flags specified personally identifiable information (PII) in your transcript. Returns: Returns a reference to this object so that method calls can be chained together. contentRedaction default TranscriptionJob.Builder contentRedaction(Consumer<ContentRedaction.Builder> contentRedaction) Redacts or flags specified personally identifiable information (PII) in your transcript. This is a convenience method that creates an instance of the ContentRedaction.Builder avoiding the need to create one manually via ContentRedaction.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to contentRedaction(ContentRedaction). Parameters: contentRedaction - a consumer that will call methods on ContentRedaction.Builder Returns: Returns a reference to this object so that method calls can be chained together. See Also: contentRedaction(ContentRedaction) identifyLanguage TranscriptionJob.Builder identifyLanguage(Boolean identifyLanguage) Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job. Parameters: identifyLanguage - Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job. Returns: Returns a reference to this object so that method calls can be chained together. identifyMultipleLanguages TranscriptionJob.Builder identifyMultipleLanguages(Boolean identifyMultipleLanguages) Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job. Parameters: identifyMultipleLanguages - Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job. Returns: Returns a reference to this object so that method calls can be chained together. languageOptionsWithStrings TranscriptionJob.Builder languageOptionsWithStrings(Collection<String> 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. Parameters: 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. Returns: Returns a reference to this object so that method calls can be chained together. languageOptionsWithStrings TranscriptionJob.Builder languageOptionsWithStrings(String... 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. Parameters: 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. Returns: Returns a reference to this object so that method calls can be chained together. languageOptions TranscriptionJob.Builder languageOptions(Collection<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. Parameters: 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. Returns: Returns a reference to this object so that method calls can be chained together. languageOptions TranscriptionJob.Builder languageOptions(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. Parameters: 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. Returns: Returns a reference to this object so that method calls can be chained together. identifiedLanguageScore TranscriptionJob.Builder identifiedLanguageScore(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. Parameters: 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: Returns a reference to this object so that method calls can be chained together. languageCodes TranscriptionJob.Builder languageCodes(Collection<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. Parameters: 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. Returns: Returns a reference to this object so that method calls can be chained together. languageCodes TranscriptionJob.Builder languageCodes(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. Parameters: 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. Returns: Returns a reference to this object so that method calls can be chained together. languageCodes TranscriptionJob.Builder languageCodes(Consumer<LanguageCodeItem.Builder>... 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. This is a convenience method that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #languageCodes(List). Parameters: languageCodes - a consumer that will call methods on List.Builder Returns: Returns a reference to this object so that method calls can be chained together. See Also: #languageCodes(List) tags TranscriptionJob.Builder tags(Collection<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. Parameters: 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. Returns: Returns a reference to this object so that method calls can be chained together. tags TranscriptionJob.Builder tags(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. Parameters: 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. Returns: Returns a reference to this object so that method calls can be chained together. tags TranscriptionJob.Builder tags(Consumer<Tag.Builder>... 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. This is a convenience method that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List). Parameters: tags - a consumer that will call methods on List.Builder Returns: Returns a reference to this object so that method calls can be chained together. See Also: #tags(List) subtitles TranscriptionJob.Builder subtitles(SubtitlesOutput subtitles) Generate subtitles for your media file with your transcription request. Parameters: subtitles - Generate subtitles for your media file with your transcription request. Returns: Returns a reference to this object so that method calls can be chained together. subtitles default TranscriptionJob.Builder subtitles(Consumer<SubtitlesOutput.Builder> subtitles) Generate subtitles for your media file with your transcription request. This is a convenience method that creates an instance of the SubtitlesOutput.Builder avoiding the need to create one manually via SubtitlesOutput.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to subtitles(SubtitlesOutput). Parameters: subtitles - a consumer that will call methods on SubtitlesOutput.Builder Returns: Returns a reference to this object so that method calls can be chained together. See Also: subtitles(SubtitlesOutput) languageIdSettingsWithStrings TranscriptionJob.Builder languageIdSettingsWithStrings(Map<String,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. Parameters: 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. Returns: Returns a reference to this object so that method calls can be chained together. languageIdSettings TranscriptionJob.Builder languageIdSettings(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. Parameters: 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. Returns: Returns a reference to this object so that method calls can be chained together.

Interface TranscriptionJob.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

transcriptionJobName

transcriptionJobStatus

transcriptionJobStatus

languageCode

languageCode

mediaSampleRateHertz

mediaFormat

mediaFormat

media

media

transcript

transcript

startTime

creationTime

completionTime

failureReason

settings

settings

modelSettings

modelSettings

jobExecutionSettings

jobExecutionSettings

contentRedaction

contentRedaction

identifyLanguage

identifyMultipleLanguages

languageOptionsWithStrings

languageOptionsWithStrings

languageOptions

languageOptions

identifiedLanguageScore

languageCodes

languageCodes

languageCodes

tags

tags

tags

subtitles

subtitles

languageIdSettingsWithStrings

languageIdSettings