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

Interface MedicalTranscriptionJobSummary.Builder

    • Method Detail

      • medicalTranscriptionJobName

        MedicalTranscriptionJobSummary.Builder medicalTranscriptionJobName​(String medicalTranscriptionJobName)

        The name of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.

        Parameters:
        medicalTranscriptionJobName - The name of the medical 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

        MedicalTranscriptionJobSummary.Builder creationTime​(Instant creationTime)

        The date and time the specified medical 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 medical 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

        MedicalTranscriptionJobSummary.Builder startTime​(Instant startTime)

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

        MedicalTranscriptionJobSummary.Builder completionTime​(Instant completionTime)

        The date and time the specified medical 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 medical 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

        MedicalTranscriptionJobSummary.Builder languageCode​(String languageCode)

        The language code used to create your medical transcription. US English (en-US) is the only supported language for medical transcriptions.

        Parameters:
        languageCode - The language code used to create your medical transcription. US English (en-US) is the only supported language for medical transcriptions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LanguageCode, LanguageCode

      • languageCode

        MedicalTranscriptionJobSummary.Builder languageCode​(LanguageCode languageCode)

        The language code used to create your medical transcription. US English (en-US) is the only supported language for medical transcriptions.

        Parameters:
        languageCode - The language code used to create your medical transcription. US English (en-US) is the only supported language for medical transcriptions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LanguageCode, LanguageCode

      • transcriptionJobStatus

        MedicalTranscriptionJobSummary.Builder transcriptionJobStatus​(String transcriptionJobStatus)

        Provides the status of your medical transcription job.

        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.

        Parameters:
        transcriptionJobStatus - Provides the status of your medical transcription job.

        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.

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

      • transcriptionJobStatus

        MedicalTranscriptionJobSummary.Builder transcriptionJobStatus​(TranscriptionJobStatus transcriptionJobStatus)

        Provides the status of your medical transcription job.

        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.

        Parameters:
        transcriptionJobStatus - Provides the status of your medical transcription job.

        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.

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

      • failureReason

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

        MedicalTranscriptionJobSummary.Builder outputLocationType​(String outputLocationType)

        Indicates where the specified medical 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 field.

        Parameters:
        outputLocationType - Indicates where the specified medical 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 field.

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

      • outputLocationType

        MedicalTranscriptionJobSummary.Builder outputLocationType​(OutputLocationType outputLocationType)

        Indicates where the specified medical 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 field.

        Parameters:
        outputLocationType - Indicates where the specified medical 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 field.

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

      • specialty

        MedicalTranscriptionJobSummary.Builder specialty​(String specialty)

        Provides the medical specialty represented in your media.

        Parameters:
        specialty - Provides the medical specialty represented in your media.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Specialty, Specialty

      • specialty

        MedicalTranscriptionJobSummary.Builder specialty​(Specialty specialty)

        Provides the medical specialty represented in your media.

        Parameters:
        specialty - Provides the medical specialty represented in your media.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Specialty, Specialty

      • type

        MedicalTranscriptionJobSummary.Builder type​(String type)

        Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

        Parameters:
        type - Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Type, Type

      • type

        MedicalTranscriptionJobSummary.Builder type​(Type type)

        Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

        Parameters:
        type - Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Type, Type