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 summary information about a 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() A timestamp that shows when the job was completed.
MedicalContentIdentificationType	contentIdentificationType() Shows the type of information you've configured Amazon Transcribe Medical to identify in a transcription job.
String	contentIdentificationTypeAsString() Shows the type of information you've configured Amazon Transcribe Medical to identify in a transcription job.
Instant	creationTime() A timestamp that shows when the medical transcription job was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason() If the TranscriptionJobStatus field is FAILED, a description of the error.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
LanguageCode	languageCode() The language of the transcript in the source audio file.
String	languageCodeAsString() The language of the transcript in the source audio file.
String	medicalTranscriptionJobName() The name of a medical transcription job.
OutputLocationType	outputLocationType() Indicates the location of the transcription job's output.
String	outputLocationTypeAsString() Indicates the location of the transcription job's output.
List<SdkField<?>>	sdkFields()
static Class<? extends MedicalTranscriptionJobSummary.Builder>	serializableBuilderClass()
Specialty	specialty() The medical specialty of the transcription job.
String	specialtyAsString() The medical specialty of the transcription job.
Instant	startTime() A timestamp that shows when the job began processing.
MedicalTranscriptionJobSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TranscriptionJobStatus	transcriptionJobStatus() The status of the medical transcription job.
String	transcriptionJobStatusAsString() The status of the medical transcription job.
Type	type() The speech of the clinician in the input audio.
String	typeAsString() The speech of the clinician in the input audio.

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 a medical transcription job.

Returns:

The name of a medical transcription job.

creationTime

public final Instant creationTime()

A timestamp that shows when the medical transcription job was created.

Returns:

A timestamp that shows when the medical transcription job was created.

startTime

public final Instant startTime()

A timestamp that shows when the job began processing.

Returns:

A timestamp that shows when the job began processing.

completionTime

public final Instant completionTime()

A timestamp that shows when the job was completed.

Returns:

A timestamp that shows when the job was completed.

languageCode

public final LanguageCode languageCode()

The language of the transcript in the source audio file.

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 of the transcript in the source audio file.

See Also:

LanguageCode

languageCodeAsString

public final String languageCodeAsString()

The language of the transcript in the source audio file.

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 of the transcript in the source audio file.

See Also:

LanguageCode

transcriptionJobStatus

public final TranscriptionJobStatus transcriptionJobStatus()

The status of the medical transcription job.

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:

The status of the medical transcription job.

See Also:

TranscriptionJobStatus

transcriptionJobStatusAsString

public final String transcriptionJobStatusAsString()

The status of the medical transcription job.

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:

The status of the medical transcription job.

See Also:

TranscriptionJobStatus

failureReason

public final String failureReason()

If the TranscriptionJobStatus field is FAILED, a description of the error.

Returns:

If the TranscriptionJobStatus field is FAILED, a description of the error.

outputLocationType

public final OutputLocationType outputLocationType()

Indicates the location of the transcription job's output. This field must be the path of an S3 bucket; if you don't already have an S3 bucket, one is created based on the path you add.

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 the location of the transcription job's output. This field must be the path of an S3 bucket; if you don't already have an S3 bucket, one is created based on the path you add.

See Also:

OutputLocationType

outputLocationTypeAsString

public final String outputLocationTypeAsString()

Indicates the location of the transcription job's output. This field must be the path of an S3 bucket; if you don't already have an S3 bucket, one is created based on the path you add.

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 the location of the transcription job's output. This field must be the path of an S3 bucket; if you don't already have an S3 bucket, one is created based on the path you add.

See Also:

OutputLocationType

specialty

public final Specialty specialty()

The medical specialty of the transcription job. Refer to Transcribing a medical conversationfor a list of supported specialties.

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:

The medical specialty of the transcription job. Refer to Transcribing a medical conversationfor a list of supported specialties.

See Also:

Specialty

specialtyAsString

public final String specialtyAsString()

The medical specialty of the transcription job. Refer to Transcribing a medical conversationfor a list of supported specialties.

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:

The medical specialty of the transcription job. Refer to Transcribing a medical conversationfor a list of supported specialties.

See Also:

Specialty

contentIdentificationType

public final MedicalContentIdentificationType contentIdentificationType()

Shows the type of information you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you've configured the transcription job to identify personal health information (PHI).

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:

Shows the type of information you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you've configured the transcription job to identify personal health information (PHI).

See Also:

MedicalContentIdentificationType

contentIdentificationTypeAsString

public final String contentIdentificationTypeAsString()

Shows the type of information you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you've configured the transcription job to identify personal health information (PHI).

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:

Shows the type of information you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is PHI, you've configured the transcription job to identify personal health information (PHI).

See Also:

MedicalContentIdentificationType

type

public final Type type()

The speech of the clinician in the input audio.

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:

The speech of the clinician in the input audio.

See Also:

Type

typeAsString

public final String typeAsString()

The speech of the clinician in the input audio.

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:

The speech of the clinician in the input audio.

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