Interface MedicalTranscriptionJobSummary.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<MedicalTranscriptionJobSummary.Builder,
,MedicalTranscriptionJobSummary> SdkBuilder<MedicalTranscriptionJobSummary.Builder,
,MedicalTranscriptionJobSummary> SdkPojo
- Enclosing class:
MedicalTranscriptionJobSummary
-
Method Summary
Modifier and TypeMethodDescriptioncompletionTime
(Instant completionTime) The date and time the specified medical transcription job finished processing.contentIdentificationType
(String contentIdentificationType) Labels all personal health information (PHI) identified in your transcript.contentIdentificationType
(MedicalContentIdentificationType contentIdentificationType) Labels all personal health information (PHI) identified in your transcript.creationTime
(Instant creationTime) The date and time the specified medical transcription job request was made.failureReason
(String failureReason) IfTranscriptionJobStatus
isFAILED
,FailureReason
contains information about why the transcription job failed.languageCode
(String languageCode) The language code used to create your medical transcription.languageCode
(LanguageCode languageCode) The language code used to create your medical transcription.medicalTranscriptionJobName
(String medicalTranscriptionJobName) The name of the medical transcription job.outputLocationType
(String outputLocationType) Indicates where the specified medical transcription output is stored.outputLocationType
(OutputLocationType outputLocationType) Indicates where the specified medical transcription output is stored.Provides the medical specialty represented in your media.Provides the medical specialty represented in your media.The date and time your medical transcription job began processing.transcriptionJobStatus
(String transcriptionJobStatus) Provides the status of your medical transcription job.transcriptionJobStatus
(TranscriptionJobStatus transcriptionJobStatus) Provides the status of your medical transcription job.Indicates whether the input media is a dictation or a conversation, as specified in theStartMedicalTranscriptionJob
request.Indicates whether the input media is a dictation or a conversation, as specified in theStartMedicalTranscriptionJob
request.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
medicalTranscriptionJobName
MedicalTranscriptionJobSummary.Builder medicalTranscriptionJobName(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.
-
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.
-
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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
languageCode
The language code used to create your medical transcription. US English (
en-US
) is the only supported language for medical transcriptions.- Parameters:
languageCode
- The language code used to create your medical transcription. 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
The language code used to create your medical transcription. US English (
en-US
) is the only supported language for medical transcriptions.- Parameters:
languageCode
- The language code used to create your medical transcription. 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:
-
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 inTranscriptFileUri
. If the status isFAILED
,FailureReason
provides details on why your transcription job failed.- Parameters:
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 inTranscriptFileUri
. If the status isFAILED
,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
MedicalTranscriptionJobSummary.Builder transcriptionJobStatus(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 inTranscriptFileUri
. If the status isFAILED
,FailureReason
provides details on why your transcription job failed.- Parameters:
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 inTranscriptFileUri
. If the status isFAILED
,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:
-
failureReason
If
TranscriptionJobStatus
isFAILED
,FailureReason
contains information about why the transcription job failed. See also: Common Errors.- Parameters:
failureReason
- IfTranscriptionJobStatus
isFAILED
,FailureReason
contains information about why the transcription job failed. See also: Common Errors.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theOutputBucketName
parameter in your request. If you also includedOutputKey
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 theTranscriptFileUri
field.- Parameters:
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 theOutputBucketName
parameter in your request. If you also includedOutputKey
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 theTranscriptFileUri
field.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theOutputBucketName
parameter in your request. If you also includedOutputKey
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 theTranscriptFileUri
field.- Parameters:
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 theOutputBucketName
parameter in your request. If you also includedOutputKey
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 theTranscriptFileUri
field.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
specialty
Provides the medical specialty represented in your media.
- Parameters:
specialty
- Provides 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
Provides the medical specialty represented in your media.
- Parameters:
specialty
- Provides the medical specialty represented in your media.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
contentIdentificationType
Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.
- Parameters:
contentIdentificationType
- Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
contentIdentificationType
MedicalTranscriptionJobSummary.Builder contentIdentificationType(MedicalContentIdentificationType contentIdentificationType) Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.
- Parameters:
contentIdentificationType
- Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information (PHI) in a transcription.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theStartMedicalTranscriptionJob
request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theStartMedicalTranscriptionJob
request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-