com.amazonaws.services.transcribe.model

Class MedicalTranscriptionJob

java.lang.Object

com.amazonaws.services.transcribe.model.MedicalTranscriptionJob

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MedicalTranscriptionJob
extends Object
implements Serializable, Cloneable, StructuredPojo

Provides detailed information about a medical transcription job.

To view the status of the specified medical transcription job, check the TranscriptionJobStatus field. 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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
MedicalTranscriptionJob()

Method Summary

Modifier and Type	Method and Description
MedicalTranscriptionJob	clone()
boolean	equals(Object obj)
Date	getCompletionTime() The date and time the specified medical transcription job finished processing.
String	getContentIdentificationType() Indicates whether content identification was enabled for your transcription request.
Date	getCreationTime() The date and time the specified medical transcription job request was made.
String	getFailureReason() If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.
String	getLanguageCode() The language code used to create your medical transcription job.
Media	getMedia()
String	getMediaFormat() The format of the input media file.
Integer	getMediaSampleRateHertz() The sample rate, in hertz, of the audio track in your input media file.
String	getMedicalTranscriptionJobName() The name of the medical transcription job.
MedicalTranscriptionSetting	getSettings() Provides information on any additional settings that were included in your request.
String	getSpecialty() Describes the medical specialty represented in your media.
Date	getStartTime() The date and time the specified medical transcription job began processing.
List<Tag>	getTags() The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
MedicalTranscript	getTranscript() Provides you with the Amazon S3 URI you can use to access your transcript.
String	getTranscriptionJobStatus() Provides the status of the specified medical transcription job.
String	getType() Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setCompletionTime(Date completionTime) The date and time the specified medical transcription job finished processing.
void	setContentIdentificationType(String contentIdentificationType) Indicates whether content identification was enabled for your transcription request.
void	setCreationTime(Date creationTime) The date and time the specified medical transcription job request was made.
void	setFailureReason(String failureReason) If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.
void	setLanguageCode(String languageCode) The language code used to create your medical transcription job.
void	setMedia(Media media)
void	setMediaFormat(String mediaFormat) The format of the input media file.
void	setMediaSampleRateHertz(Integer mediaSampleRateHertz) The sample rate, in hertz, of the audio track in your input media file.
void	setMedicalTranscriptionJobName(String medicalTranscriptionJobName) The name of the medical transcription job.
void	setSettings(MedicalTranscriptionSetting settings) Provides information on any additional settings that were included in your request.
void	setSpecialty(String specialty) Describes the medical specialty represented in your media.
void	setStartTime(Date startTime) The date and time the specified medical transcription job began processing.
void	setTags(Collection<Tag> tags) The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
void	setTranscript(MedicalTranscript transcript) Provides you with the Amazon S3 URI you can use to access your transcript.
void	setTranscriptionJobStatus(String transcriptionJobStatus) Provides the status of the specified medical transcription job.
void	setType(String type) Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.
String	toString() Returns a string representation of this object.
MedicalTranscriptionJob	withCompletionTime(Date completionTime) The date and time the specified medical transcription job finished processing.
MedicalTranscriptionJob	withContentIdentificationType(MedicalContentIdentificationType contentIdentificationType) Indicates whether content identification was enabled for your transcription request.
MedicalTranscriptionJob	withContentIdentificationType(String contentIdentificationType) Indicates whether content identification was enabled for your transcription request.
MedicalTranscriptionJob	withCreationTime(Date creationTime) The date and time the specified medical transcription job request was made.
MedicalTranscriptionJob	withFailureReason(String failureReason) If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.
MedicalTranscriptionJob	withLanguageCode(LanguageCode languageCode) The language code used to create your medical transcription job.
MedicalTranscriptionJob	withLanguageCode(String languageCode) The language code used to create your medical transcription job.
MedicalTranscriptionJob	withMedia(Media media)
MedicalTranscriptionJob	withMediaFormat(MediaFormat mediaFormat) The format of the input media file.
MedicalTranscriptionJob	withMediaFormat(String mediaFormat) The format of the input media file.
MedicalTranscriptionJob	withMediaSampleRateHertz(Integer mediaSampleRateHertz) The sample rate, in hertz, of the audio track in your input media file.
MedicalTranscriptionJob	withMedicalTranscriptionJobName(String medicalTranscriptionJobName) The name of the medical transcription job.
MedicalTranscriptionJob	withSettings(MedicalTranscriptionSetting settings) Provides information on any additional settings that were included in your request.
MedicalTranscriptionJob	withSpecialty(Specialty specialty) Describes the medical specialty represented in your media.
MedicalTranscriptionJob	withSpecialty(String specialty) Describes the medical specialty represented in your media.
MedicalTranscriptionJob	withStartTime(Date startTime) The date and time the specified medical transcription job began processing.
MedicalTranscriptionJob	withTags(Collection<Tag> tags) The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
MedicalTranscriptionJob	withTags(Tag... tags) The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
MedicalTranscriptionJob	withTranscript(MedicalTranscript transcript) Provides you with the Amazon S3 URI you can use to access your transcript.
MedicalTranscriptionJob	withTranscriptionJobStatus(String transcriptionJobStatus) Provides the status of the specified medical transcription job.
MedicalTranscriptionJob	withTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus) Provides the status of the specified medical transcription job.
MedicalTranscriptionJob	withType(String type) Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.
MedicalTranscriptionJob	withType(Type type) Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MedicalTranscriptionJob

public MedicalTranscriptionJob()

Method Detail

setMedicalTranscriptionJobName

public void setMedicalTranscriptionJobName(String medicalTranscriptionJobName)

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

Parameters:

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

getMedicalTranscriptionJobName

public String getMedicalTranscriptionJobName()

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.

withMedicalTranscriptionJobName

public MedicalTranscriptionJob withMedicalTranscriptionJobName(String medicalTranscriptionJobName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setTranscriptionJobStatus

public void setTranscriptionJobStatus(String transcriptionJobStatus)

Provides the status of the specified 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.

Parameters:

transcriptionJobStatus - Provides the status of the specified 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

getTranscriptionJobStatus

public String getTranscriptionJobStatus()

Provides the status of the specified 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.

Returns:

Provides the status of the specified 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

withTranscriptionJobStatus

public MedicalTranscriptionJob withTranscriptionJobStatus(String transcriptionJobStatus)

Provides the status of the specified 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.

Parameters:

transcriptionJobStatus - Provides the status of the specified 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TranscriptionJobStatus

withTranscriptionJobStatus

public MedicalTranscriptionJob withTranscriptionJobStatus(TranscriptionJobStatus transcriptionJobStatus)

Provides the status of the specified 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.

Parameters:

transcriptionJobStatus - Provides the status of the specified 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TranscriptionJobStatus

setLanguageCode

public void setLanguageCode(String languageCode)

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

Parameters:

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

See Also:

LanguageCode

getLanguageCode

public String getLanguageCode()

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

Returns:

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

See Also:

LanguageCode

withLanguageCode

public MedicalTranscriptionJob withLanguageCode(String languageCode)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LanguageCode

withLanguageCode

public MedicalTranscriptionJob withLanguageCode(LanguageCode languageCode)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LanguageCode

setMediaSampleRateHertz

public void setMediaSampleRateHertz(Integer mediaSampleRateHertz)

The sample rate, in hertz, of the audio track in your input media file.

Parameters:

mediaSampleRateHertz - The sample rate, in hertz, of the audio track in your input media file.

getMediaSampleRateHertz

public Integer getMediaSampleRateHertz()

The sample rate, in hertz, of the audio track in your input media file.

Returns:

The sample rate, in hertz, of the audio track in your input media file.

withMediaSampleRateHertz

public MedicalTranscriptionJob withMediaSampleRateHertz(Integer mediaSampleRateHertz)

The sample rate, in hertz, of the audio track in your input media file.

Parameters:

mediaSampleRateHertz - The sample rate, in hertz, of the audio track in your input media file.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMediaFormat

public void setMediaFormat(String mediaFormat)

The format of the input media file.

Parameters:

mediaFormat - The format of the input media file.

See Also:

MediaFormat

getMediaFormat

public String getMediaFormat()

The format of the input media file.

Returns:

The format of the input media file.

See Also:

MediaFormat

withMediaFormat

public MedicalTranscriptionJob withMediaFormat(String mediaFormat)

The format of the input media file.

Parameters:

mediaFormat - The format of the input media file.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MediaFormat

withMediaFormat

public MedicalTranscriptionJob withMediaFormat(MediaFormat mediaFormat)

The format of the input media file.

Parameters:

mediaFormat - The format of the input media file.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MediaFormat

setMedia

public void setMedia(Media media)

Parameters:

media -

getMedia

public Media getMedia()

Returns:

withMedia

public MedicalTranscriptionJob withMedia(Media media)

Parameters:

media -

Returns:

Returns a reference to this object so that method calls can be chained together.

setTranscript

public void setTranscript(MedicalTranscript transcript)

Provides you with the Amazon S3 URI you can use to access your transcript.

Parameters:

transcript - Provides you with the Amazon S3 URI you can use to access your transcript.

getTranscript

public MedicalTranscript getTranscript()

Provides you with the Amazon S3 URI you can use to access your transcript.

Returns:

Provides you with the Amazon S3 URI you can use to access your transcript.

withTranscript

public MedicalTranscriptionJob withTranscript(MedicalTranscript transcript)

Provides you with the Amazon S3 URI you can use to access your transcript.

Parameters:

transcript - Provides you with the Amazon S3 URI you can use to access your transcript.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStartTime

public void setStartTime(Date startTime)

The date and time the specified 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.

Parameters:

startTime - The date and time the specified 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.

getStartTime

public Date getStartTime()

The date and time the specified 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 the specified 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.

withStartTime

public MedicalTranscriptionJob withStartTime(Date startTime)

The date and time the specified 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.

Parameters:

startTime - The date and time the specified 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:

Returns a reference to this object so that method calls can be chained together.

setCreationTime

public void setCreationTime(Date 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.

Parameters:

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.

getCreationTime

public Date getCreationTime()

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.

withCreationTime

public MedicalTranscriptionJob withCreationTime(Date 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setCompletionTime

public void setCompletionTime(Date 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.

Parameters:

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.

getCompletionTime

public Date getCompletionTime()

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.

withCompletionTime

public MedicalTranscriptionJob withCompletionTime(Date 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setFailureReason

public void setFailureReason(String failureReason)

If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.

The FailureReason field contains one of the following values:

• Unsupported media format.

  The media format specified in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats.

• The media format provided does not match the detected media format.

  The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

• Invalid sample rate for audio file.

  The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 16,000 and 48,000 hertz.

• The sample rate provided does not match the detected sample rate.

  The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

• Invalid file size: file size too large.

  The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.

• Invalid number of channels: number of channels too large.

  Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.

Parameters:

failureReason - If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.

The FailureReason field contains one of the following values:

• Unsupported media format.

  The media format specified in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats.

• The media format provided does not match the detected media format.

  The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

• Invalid sample rate for audio file.

  The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 16,000 and 48,000 hertz.

• The sample rate provided does not match the detected sample rate.

  The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

• Invalid file size: file size too large.

  The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.

• Invalid number of channels: number of channels too large.

  Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.

getFailureReason

public String getFailureReason()

If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.

The FailureReason field contains one of the following values:

• Unsupported media format.

  The media format specified in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats.

• The media format provided does not match the detected media format.

  The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

• Invalid sample rate for audio file.

  The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 16,000 and 48,000 hertz.

• The sample rate provided does not match the detected sample rate.

  The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

• Invalid file size: file size too large.

  The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.

• Invalid number of channels: number of channels too large.

  Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.

Returns:

If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.

The FailureReason field contains one of the following values:

• Unsupported media format.

  The media format specified in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats.

• The media format provided does not match the detected media format.

  The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

• Invalid sample rate for audio file.

  The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 16,000 and 48,000 hertz.

• The sample rate provided does not match the detected sample rate.

  The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

• Invalid file size: file size too large.

  The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.

• Invalid number of channels: number of channels too large.

  Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.

withFailureReason

public MedicalTranscriptionJob withFailureReason(String failureReason)

If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.

The FailureReason field contains one of the following values:

• Unsupported media format.

  The media format specified in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats.

• The media format provided does not match the detected media format.

  The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

• Invalid sample rate for audio file.

  The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 16,000 and 48,000 hertz.

• The sample rate provided does not match the detected sample rate.

  The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

• Invalid file size: file size too large.

  The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.

• Invalid number of channels: number of channels too large.

  Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.

Parameters:

failureReason - If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed.

The FailureReason field contains one of the following values:

• Unsupported media format.

  The media format specified in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats.

• The media format provided does not match the detected media format.

  The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value.

• Invalid sample rate for audio file.

  The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 16,000 and 48,000 hertz.

• The sample rate provided does not match the detected sample rate.

  The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.

• Invalid file size: file size too large.

  The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.

• Invalid number of channels: number of channels too large.

  Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSettings

public void setSettings(MedicalTranscriptionSetting settings)

Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

Parameters:

settings - Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

getSettings

public MedicalTranscriptionSetting getSettings()

Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

Returns:

Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

withSettings

public MedicalTranscriptionJob withSettings(MedicalTranscriptionSetting settings)

Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

Parameters:

settings - Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

Returns:

Returns a reference to this object so that method calls can be chained together.

setContentIdentificationType

public void setContentIdentificationType(String contentIdentificationType)

Indicates whether content identification was enabled for your transcription request.

Parameters:

contentIdentificationType - Indicates whether content identification was enabled for your transcription request.

See Also:

MedicalContentIdentificationType

getContentIdentificationType

public String getContentIdentificationType()

Indicates whether content identification was enabled for your transcription request.

Returns:

Indicates whether content identification was enabled for your transcription request.

See Also:

MedicalContentIdentificationType

withContentIdentificationType

public MedicalTranscriptionJob withContentIdentificationType(String contentIdentificationType)

Indicates whether content identification was enabled for your transcription request.

Parameters:

contentIdentificationType - Indicates whether content identification was enabled for your transcription request.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MedicalContentIdentificationType

withContentIdentificationType

public MedicalTranscriptionJob withContentIdentificationType(MedicalContentIdentificationType contentIdentificationType)

Indicates whether content identification was enabled for your transcription request.

Parameters:

contentIdentificationType - Indicates whether content identification was enabled for your transcription request.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MedicalContentIdentificationType

setSpecialty

public void setSpecialty(String specialty)

Describes the medical specialty represented in your media.

Parameters:

specialty - Describes the medical specialty represented in your media.

See Also:

Specialty

getSpecialty

public String getSpecialty()

Describes the medical specialty represented in your media.

Returns:

Describes the medical specialty represented in your media.

See Also:

Specialty

withSpecialty

public MedicalTranscriptionJob withSpecialty(String specialty)

Describes the medical specialty represented in your media.

Parameters:

specialty - Describes the medical specialty represented in your media.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Specialty

withSpecialty

public MedicalTranscriptionJob withSpecialty(Specialty specialty)

Describes the medical specialty represented in your media.

Parameters:

specialty - Describes the medical specialty represented in your media.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Specialty

setType

public void setType(String type)

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

Parameters:

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

See Also:

Type

getType

public String getType()

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

Returns:

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

See Also:

Type

withType

public MedicalTranscriptionJob withType(String type)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Type

withType

public MedicalTranscriptionJob withType(Type type)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Type

getTags

public List<Tag> getTags()

The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.

Returns:

The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.

setTags

public void setTags(Collection<Tag> tags)

The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.

Parameters:

tags - The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.

withTags

public MedicalTranscriptionJob withTags(Tag... tags)

The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public MedicalTranscriptionJob withTags(Collection<Tag> tags)

The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.

Parameters:

tags - The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public MedicalTranscriptionJob clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.