StartMedicalTranscriptionJobRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.transcribe.model.TranscribeRequest
    - - software.amazon.awssdk.services.transcribe.model.StartMedicalTranscriptionJobRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<StartMedicalTranscriptionJobRequest.Builder,StartMedicalTranscriptionJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartMedicalTranscriptionJobRequest
extends TranscribeRequest
implements ToCopyableBuilder<StartMedicalTranscriptionJobRequest.Builder,StartMedicalTranscriptionJobRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StartMedicalTranscriptionJobRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StartMedicalTranscriptionJobRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static StartMedicalTranscriptionJobRequest.Builder`	`builder()`
`MedicalContentIdentificationType`	`contentIdentificationType()` You can configure Amazon Transcribe Medical to label content in the transcription output.
`String`	`contentIdentificationTypeAsString()` You can configure Amazon Transcribe Medical to label content in the transcription output.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasKmsEncryptionContext()` For responses, this returns true if the service returned a value for the KMSEncryptionContext property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`Map<String,String>`	`kmsEncryptionContext()` A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.
`LanguageCode`	`languageCode()` The language code for the language spoken in the input media file.
`String`	`languageCodeAsString()` The language code for the language spoken in the input media file.
`Media`	`media()` Returns the value of the Media property for this object.
`MediaFormat`	`mediaFormat()` The audio format of the input media file.
`String`	`mediaFormatAsString()` The audio format of the input media file.
`Integer`	`mediaSampleRateHertz()` The sample rate, in Hertz, of the audio track in the input media file.
`String`	`medicalTranscriptionJobName()` The name of the medical transcription job.
`String`	`outputBucketName()` The Amazon S3 location where the transcription is stored.
`String`	`outputEncryptionKMSKeyId()` The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job.
`String`	`outputKey()` You can specify a location in an Amazon S3 bucket to store the output of your medical transcription job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StartMedicalTranscriptionJobRequest.Builder>`	`serializableBuilderClass()`
`MedicalTranscriptionSetting`	`settings()` Optional settings for the medical transcription job.
`Specialty`	`specialty()` The medical specialty of any clinician speaking in the input media.
`String`	`specialtyAsString()` The medical specialty of any clinician speaking in the input media.
`List<Tag>`	`tags()` Add tags to an Amazon Transcribe medical transcription job.
`StartMedicalTranscriptionJobRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Type`	`type()` The type of speech in the input audio.
`String`	`typeAsString()` The type of speech in the input audio.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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. You can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a medical transcription job with the same name as a previous medical transcription job, you get a ConflictException error.
    
    Returns:
    
    The name of the medical transcription job. You can't use the strings "." or ".. " by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a medical transcription job with the same name as a previous medical transcription job, you get a ConflictException error.
  - languageCode
```
public final LanguageCode languageCode()
```
    The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
    
    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 for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
    
    See Also:
    
    LanguageCode
  - languageCodeAsString
```
public final String languageCodeAsString()
```
    The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
    
    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 for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
    
    See Also:
    
    LanguageCode
  - mediaSampleRateHertz
```
public final Integer mediaSampleRateHertz()
```
    The sample rate, in Hertz, of the audio track in the input media file.
    
    If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the sample rate.
    
    Returns:
    
    The sample rate, in Hertz, of the audio track in the input media file.
    
    If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the sample rate.
  - mediaFormat
```
public final MediaFormat mediaFormat()
```
    The audio format of the input media file.
    
    If the service returns an enum value that is not available in the current SDK version, mediaFormat will return MediaFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaFormatAsString().
    
    Returns:
    
    The audio format of the input media file.
    
    See Also:
    
    MediaFormat
  - mediaFormatAsString
```
public final String mediaFormatAsString()
```
    The audio format of the input media file.
    
    If the service returns an enum value that is not available in the current SDK version, mediaFormat will return MediaFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaFormatAsString().
    
    Returns:
    
    The audio format of the input media file.
    
    See Also:
    
    MediaFormat
  - media
```
public final Media media()
```
    Returns the value of the Media property for this object.
    
    Returns:
    
    The value of the Media property for this object.
  - outputBucketName
```
public final String outputBucketName()
```
    The Amazon S3 location where the transcription is stored.
    
    You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
    
    You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
    
    Returns:
    
    The Amazon S3 location where the transcription is stored.
    
    You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.
    
    You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
  - outputKey
```
public final String outputKey()
```
    You can specify a location in an Amazon S3 bucket to store the output of your medical transcription job.
    
    If you don't specify an output key, Amazon Transcribe Medical stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".
    
    You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".
    
    If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.
    
    Returns:
    
    You can specify a location in an Amazon S3 bucket to store the output of your medical transcription job.
    
    If you don't specify an output key, Amazon Transcribe Medical stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".
    
    You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".
    
    If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.
  - outputEncryptionKMSKeyId
```
public final String outputEncryptionKMSKeyId()
```
    The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.
    
    You use either of the following to identify a KMS key in the current account:
    - KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    - KMS Key Alias: "alias/ExampleAlias"
    You can use either of the following to identify a KMS key in the current account or another account:
    - Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    - ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
    If you don't specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 key (SSE-S3).
    
    If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.
    Returns:
    The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.
    
    You use either of the following to identify a KMS key in the current account:
    
    KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
    
    KMS Key Alias: "alias/ExampleAlias"
    
    You can use either of the following to identify a KMS key in the current account or another account:
    
    Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    
    ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias"
    
    If you don't specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 key (SSE-S3).
    
    If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.
  - hasKmsEncryptionContext
```
public final boolean hasKmsEncryptionContext()
```
    For responses, this returns true if the service returned a value for the KMSEncryptionContext property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - kmsEncryptionContext
```
public final Map<String,String> kmsEncryptionContext()
```
    A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasKmsEncryptionContext() method.
    
    Returns:
    
    A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.
  - settings
```
public final MedicalTranscriptionSetting settings()
```
    Optional settings for the medical transcription job.
    
    Returns:
    
    Optional settings for the medical transcription job.
  - contentIdentificationType
```
public final MedicalContentIdentificationType contentIdentificationType()
```
    You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify PHI, Amazon Transcribe Medical labels the personal health information (PHI) that it identifies in the transcription output.
    
    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:
    
    You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify PHI, Amazon Transcribe Medical labels the personal health information (PHI) that it identifies in the transcription output.
    
    See Also:
    
    MedicalContentIdentificationType
  - contentIdentificationTypeAsString
```
public final String contentIdentificationTypeAsString()
```
    You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify PHI, Amazon Transcribe Medical labels the personal health information (PHI) that it identifies in the transcription output.
    
    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:
    
    You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify PHI, Amazon Transcribe Medical labels the personal health information (PHI) that it identifies in the transcription output.
    
    See Also:
    
    MedicalContentIdentificationType
  - specialty
```
public final Specialty specialty()
```
    The medical specialty of any clinician speaking in the input 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:
    
    The medical specialty of any clinician speaking in the input media.
    
    See Also:
    
    Specialty
  - specialtyAsString
```
public final String specialtyAsString()
```
    The medical specialty of any clinician speaking in the input 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:
    
    The medical specialty of any clinician speaking in the input media.
    
    See Also:
    
    Specialty
  - type
```
public final Type type()
```
    The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, such as clinical notes.
    
    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 type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, such as clinical notes.
    
    See Also:
    
    Type
  - typeAsString
```
public final String typeAsString()
```
    The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, such as clinical notes.
    
    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 type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, such as clinical notes.
    
    See Also:
    
    Type
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<Tag> tags()
```
    Add tags to an Amazon Transcribe medical transcription job.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    Add tags to an Amazon Transcribe medical transcription job.
  - toBuilder
```
public StartMedicalTranscriptionJobRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartMedicalTranscriptionJobRequest.Builder,StartMedicalTranscriptionJobRequest>
    
    Specified by:
    
    toBuilder in class TranscribeRequest
  - builder
```
public static StartMedicalTranscriptionJobRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StartMedicalTranscriptionJobRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class StartMedicalTranscriptionJobRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

medicalTranscriptionJobName

languageCode

languageCodeAsString

mediaSampleRateHertz

mediaFormat

mediaFormatAsString

media

outputBucketName

outputKey

outputEncryptionKMSKeyId

hasKmsEncryptionContext

kmsEncryptionContext

settings

contentIdentificationType

contentIdentificationTypeAsString

specialty

specialtyAsString

type

typeAsString

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields