Package software.amazon.awssdk.services.transcribe.model

Interface TranscriptionJobSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<TranscriptionJobSummary.Builder,TranscriptionJobSummary>, SdkBuilder<TranscriptionJobSummary.Builder,TranscriptionJobSummary>, SdkPojo
Enclosing class:
TranscriptionJobSummary
public static interface TranscriptionJobSummary.Builder extends SdkPojo, CopyableBuilder<TranscriptionJobSummary.Builder,TranscriptionJobSummary>

  • Method Details

    • transcriptionJobName

      TranscriptionJobSummary.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.

    • creationTime

      TranscriptionJobSummary.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.

    • startTime

      TranscriptionJobSummary.Builder startTime(Instant startTime)

      The date and time your 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 your 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.

    • completionTime

      TranscriptionJobSummary.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.

    • languageCode

      TranscriptionJobSummary.Builder languageCode(String languageCode)

      The language code used to create your transcription.

      Parameters:
      languageCode - The language code used to create your transcription.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • languageCode

      TranscriptionJobSummary.Builder languageCode(LanguageCode languageCode)

      The language code used to create your transcription.

      Parameters:
      languageCode - The language code used to create your transcription.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • transcriptionJobStatus

      TranscriptionJobSummary.Builder transcriptionJobStatus(String transcriptionJobStatus)

      Provides the status of your 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 your 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

      TranscriptionJobSummary.Builder transcriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)

      Provides the status of your 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 your 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:

    • failureReason

      TranscriptionJobSummary.Builder failureReason(String failureReason)

      If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.

      Parameters:
      failureReason - If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputLocationType

      TranscriptionJobSummary.Builder outputLocationType(String outputLocationType)

      Indicates where the specified transcription output is stored.

      If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your request. If you also included OutputKey in your request, your output is located in the path you specified in your request.

      If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri or RedactedTranscriptFileUri field.

      Parameters:
      outputLocationType - Indicates where the specified transcription output is stored.

      If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your request. If you also included OutputKey in your request, your output is located in the path you specified in your request.

      If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri or RedactedTranscriptFileUri field.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputLocationType

      TranscriptionJobSummary.Builder outputLocationType(OutputLocationType outputLocationType)

      Indicates where the specified transcription output is stored.

      If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your request. If you also included OutputKey in your request, your output is located in the path you specified in your request.

      If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri or RedactedTranscriptFileUri field.

      Parameters:
      outputLocationType - Indicates where the specified transcription output is stored.

      If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your request. If you also included OutputKey in your request, your output is located in the path you specified in your request.

      If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri or RedactedTranscriptFileUri field.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • contentRedaction

      TranscriptionJobSummary.Builder contentRedaction(ContentRedaction contentRedaction)

      The content redaction settings of the transcription job.

      Parameters:
      contentRedaction - The content redaction settings of the transcription job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contentRedaction

      default TranscriptionJobSummary.Builder contentRedaction(Consumer<ContentRedaction.Builder> contentRedaction)

      The content redaction settings of the transcription job.

      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:

    • modelSettings

      TranscriptionJobSummary.Builder modelSettings(ModelSettings modelSettings)
      Sets the value of the ModelSettings property for this object.
      Parameters:
      modelSettings - The new value for the ModelSettings property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelSettings

      default TranscriptionJobSummary.Builder modelSettings(Consumer<ModelSettings.Builder> modelSettings)
      Sets the value of the ModelSettings property for this object. 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:

    • identifyLanguage

      TranscriptionJobSummary.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

      TranscriptionJobSummary.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.

    • identifiedLanguageScore

      TranscriptionJobSummary.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

      TranscriptionJobSummary.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, the singular version of this parameter, LanguageCode, is present.

      Parameters:
      languageCodes - The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification, the singular version of this parameter, LanguageCode, is present.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • languageCodes

      TranscriptionJobSummary.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, the singular version of this parameter, LanguageCode, is present.

      Parameters:
      languageCodes - The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification, the singular version of this parameter, LanguageCode, is present.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • languageCodes

      TranscriptionJobSummary.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, the singular version of this parameter, LanguageCode, is present.

      This is a convenience method that creates an instance of the LanguageCodeItem.Builder avoiding the need to create one manually via LanguageCodeItem.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to languageCodes(List<LanguageCodeItem>).

      Parameters:
      languageCodes - a consumer that will call methods on LanguageCodeItem.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • toxicityDetection

      TranscriptionJobSummary.Builder toxicityDetection(Collection<ToxicityDetectionSettings> toxicityDetection)

      Indicates whether toxicity detection was enabled for the specified transcription job.

      Parameters:
      toxicityDetection - Indicates whether toxicity detection was enabled for the specified transcription job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • toxicityDetection

      TranscriptionJobSummary.Builder toxicityDetection(ToxicityDetectionSettings... toxicityDetection)

      Indicates whether toxicity detection was enabled for the specified transcription job.

      Parameters:
      toxicityDetection - Indicates whether toxicity detection was enabled for the specified transcription job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • toxicityDetection

      TranscriptionJobSummary.Builder toxicityDetection(Consumer<ToxicityDetectionSettings.Builder>... toxicityDetection)

      Indicates whether toxicity detection was enabled for the specified transcription job.

      This is a convenience method that creates an instance of the ToxicityDetectionSettings.Builder avoiding the need to create one manually via ToxicityDetectionSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to toxicityDetection(List<ToxicityDetectionSettings>).

      Parameters:
      toxicityDetection - a consumer that will call methods on ToxicityDetectionSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: