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

Class MedicalTranscriptionJobSummary

java.lang.Object
software.amazon.awssdk.services.transcribe.model.MedicalTranscriptionJobSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MedicalTranscriptionJobSummary.Builder,MedicalTranscriptionJobSummary>
@Generated("software.amazon.awssdk:codegen") public final class MedicalTranscriptionJobSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MedicalTranscriptionJobSummary.Builder,MedicalTranscriptionJobSummary>

Provides detailed information about a specific medical transcription job.

See Also:

  • Method Details

    • medicalTranscriptionJobName

      public final String medicalTranscriptionJobName()

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

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

    • creationTime

      public final 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.

      Returns:
      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.

    • startTime

      public final 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.

      Returns:
      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.

    • completionTime

      public final 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.

      Returns:
      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.

    • languageCode

      public final LanguageCode languageCode()

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

      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 medical transcription. US English (en-US) is the only supported language for medical transcriptions.
      See Also:

    • languageCodeAsString

      public final String languageCodeAsString()

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

      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 medical transcription. US English (en-US) is the only supported language for medical transcriptions.
      See Also:

    • transcriptionJobStatus

      public final 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.

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

      See Also:

    • transcriptionJobStatusAsString

      public final String transcriptionJobStatusAsString()

      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.

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

      See Also:

    • failureReason

      public final String failureReason()

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

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

    • outputLocationType

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, outputLocationType will return OutputLocationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputLocationTypeAsString().

      Returns:
      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.

      See Also:

    • outputLocationTypeAsString

      public final String outputLocationTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, outputLocationType will return OutputLocationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputLocationTypeAsString().

      Returns:
      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.

      See Also:

    • specialty

      public final Specialty specialty()

      Provides the medical specialty represented in your media.

      If the service returns an enum value that is not available in the current SDK version, specialty will return Specialty.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from specialtyAsString().

      Returns:
      Provides the medical specialty represented in your media.
      See Also:

    • specialtyAsString

      public final String specialtyAsString()

      Provides the medical specialty represented in your media.

      If the service returns an enum value that is not available in the current SDK version, specialty will return Specialty.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from specialtyAsString().

      Returns:
      Provides the medical specialty represented in your media.
      See Also:

    • contentIdentificationType

      public final MedicalContentIdentificationType contentIdentificationType()

      Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.

      If the service returns an enum value that is not available in the current SDK version, contentIdentificationType will return MedicalContentIdentificationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentIdentificationTypeAsString().

      Returns:
      Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.
      See Also:

    • contentIdentificationTypeAsString

      public final String contentIdentificationTypeAsString()

      Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.

      If the service returns an enum value that is not available in the current SDK version, contentIdentificationType will return MedicalContentIdentificationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentIdentificationTypeAsString().

      Returns:
      Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.
      See Also:

    • type

      public final Type type()

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

      If the service returns an enum value that is not available in the current SDK version, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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

    • typeAsString

      public final String typeAsString()

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

      If the service returns an enum value that is not available in the current SDK version, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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

    • toBuilder

      public MedicalTranscriptionJobSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<MedicalTranscriptionJobSummary.Builder,MedicalTranscriptionJobSummary>
      Returns:
      a builder for type T

    • builder

      public static MedicalTranscriptionJobSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MedicalTranscriptionJobSummary.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.