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(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MedicalTranscriptionJobSummary.Builder

Method Summary

Modifier and Type	Method and Description
static MedicalTranscriptionJobSummary.Builder	builder()
Instant	completionTime() The date and time the specified medical transcription job finished processing.
MedicalContentIdentificationType	contentIdentificationType() Labels all personal health information (PHI) identified in your transcript.
String	contentIdentificationTypeAsString() Labels all personal health information (PHI) identified in your transcript.
Instant	creationTime() The date and time the specified medical transcription job request was made.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason() If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
LanguageCode	languageCode() The language code used to create your medical transcription.
String	languageCodeAsString() The language code used to create your medical transcription.
String	medicalTranscriptionJobName() The name of the medical transcription job.
OutputLocationType	outputLocationType() Indicates where the specified medical transcription output is stored.
String	outputLocationTypeAsString() Indicates where the specified medical transcription output is stored.
List<SdkField<?>>	sdkFields()
static Class<? extends MedicalTranscriptionJobSummary.Builder>	serializableBuilderClass()
Specialty	specialty() Provides the medical specialty represented in your media.
String	specialtyAsString() Provides the medical specialty represented in your media.
Instant	startTime() The date and time your medical transcription job began processing.
MedicalTranscriptionJobSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TranscriptionJobStatus	transcriptionJobStatus() Provides the status of your medical transcription job.
String	transcriptionJobStatusAsString() Provides the status of your medical transcription job.
Type	type() Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.
String	typeAsString() Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

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

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:

LanguageCode

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:

LanguageCode

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:

TranscriptionJobStatus

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:

TranscriptionJobStatus

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:

OutputLocationType

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:

OutputLocationType

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:

Specialty

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:

Specialty

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:

MedicalContentIdentificationType

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:

MedicalContentIdentificationType

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:

Type

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:

Type

toBuilder

public MedicalTranscriptionJobSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MedicalTranscriptionJobSummary.Builder,MedicalTranscriptionJobSummary>

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)

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