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

Interface MedicalScribeJobSummary.Builder

    • Method Detail

      • medicalScribeJobName

        MedicalScribeJobSummary.Builder medicalScribeJobName​(String medicalScribeJobName)

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

        Parameters:
        medicalScribeJobName - The name of the Medical Scribe 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

        MedicalScribeJobSummary.Builder creationTime​(Instant creationTime)

        The date and time the specified Medical Scribe 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 Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.

        Parameters:
        creationTime - The date and time the specified Medical Scribe 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 Medical Scribe 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

        MedicalScribeJobSummary.Builder startTime​(Instant startTime)

        The date and time your Medical Scribe 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 Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.

        Parameters:
        startTime - The date and time your Medical Scribe 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 Medical Scribe 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

        MedicalScribeJobSummary.Builder completionTime​(Instant completionTime)

        The date and time the specified Medical Scribe job finished processing.

        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 Medical Scribe job that finished processing at 12:32 PM UTC-7 on May 4, 2022.

        Parameters:
        completionTime - The date and time the specified Medical Scribe job finished processing.

        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 Medical Scribe job that finished 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.

      • languageCode

        MedicalScribeJobSummary.Builder languageCode​(String languageCode)

        The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.

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

      • languageCode

        MedicalScribeJobSummary.Builder languageCode​(MedicalScribeLanguageCode languageCode)

        The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.

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

      • medicalScribeJobStatus

        MedicalScribeJobSummary.Builder medicalScribeJobStatus​(String medicalScribeJobStatus)

        Provides the status of the specified Medical Scribe job.

        If the status is COMPLETED, the job is finished and you can find the results at the location specified in MedicalScribeOutput If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.

        Parameters:
        medicalScribeJobStatus - Provides the status of the specified Medical Scribe job.

        If the status is COMPLETED, the job is finished and you can find the results at the location specified in MedicalScribeOutput If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.

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

      • medicalScribeJobStatus

        MedicalScribeJobSummary.Builder medicalScribeJobStatus​(MedicalScribeJobStatus medicalScribeJobStatus)

        Provides the status of the specified Medical Scribe job.

        If the status is COMPLETED, the job is finished and you can find the results at the location specified in MedicalScribeOutput If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.

        Parameters:
        medicalScribeJobStatus - Provides the status of the specified Medical Scribe job.

        If the status is COMPLETED, the job is finished and you can find the results at the location specified in MedicalScribeOutput If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.

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

      • failureReason

        MedicalScribeJobSummary.Builder failureReason​(String failureReason)

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

        Parameters:
        failureReason - If MedicalScribeJobStatus 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.