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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface MedicalScribeJobSummary.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static MedicalScribeJobSummary.Builder`	`builder()`
`Instant`	`completionTime()`	The date and time the specified Medical Scribe job finished processing.
`Instant`	`creationTime()`	The date and time the specified Medical Scribe job request was made.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureReason()`	If `MedicalScribeJobStatus` is `FAILED`, `FailureReason` contains information about why the transcription job failed.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`MedicalScribeLanguageCode`	`languageCode()`	The language code used to create your Medical Scribe job.
`String`	`languageCodeAsString()`	The language code used to create your Medical Scribe job.
`String`	`medicalScribeJobName()`	The name of the Medical Scribe job.
`MedicalScribeJobStatus`	`medicalScribeJobStatus()`	Provides the status of the specified Medical Scribe job.
`String`	`medicalScribeJobStatusAsString()`	Provides the status of the specified Medical Scribe job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends MedicalScribeJobSummary.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()`	The date and time your Medical Scribe job began processing.
`MedicalScribeJobSummary.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    MedicalScribeLanguageCode
  - 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:
    
    MedicalScribeLanguageCode
  - 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:
    
    MedicalScribeJobStatus
  - 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:
    
    MedicalScribeJobStatus
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<MedicalScribeJobSummary.Builder,MedicalScribeJobSummary>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class MedicalScribeJobSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

medicalScribeJobName

creationTime

startTime

completionTime

languageCode

languageCodeAsString

medicalScribeJobStatus

medicalScribeJobStatusAsString

failureReason

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields