Class MedicalScribeJobSummary

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

Provides detailed information about a specific Medical Scribe job.

See Also:

  • Method Details

    • medicalScribeJobName

      public final String medicalScribeJobName()

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

      Returns:
      The name of the Medical Scribe 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 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:
      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.

    • startTime

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

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

    • completionTime

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

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

    • languageCode

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

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

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

    • languageCodeAsString

      public final String languageCodeAsString()

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

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

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

    • medicalScribeJobStatus

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

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

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

      See Also:

    • medicalScribeJobStatusAsString

      public final String medicalScribeJobStatusAsString()

      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.

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

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

      See Also:

    • failureReason

      public final String failureReason()

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

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

    • toBuilder

      public MedicalScribeJobSummary.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<MedicalScribeJobSummary.Builder,MedicalScribeJobSummary>
      Returns:
      a builder for type T

    • builder

      public static MedicalScribeJobSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MedicalScribeJobSummary.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.