software.amazon.awssdk.services.transcribe.model.StartMedicalTranscriptionJobRequest Maven / Gradle / Ivy
Show all versions of transcribe Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.transcribe.model;
import java.beans.Transient;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class StartMedicalTranscriptionJobRequest extends TranscribeRequest implements
ToCopyableBuilder {
private static final SdkField MEDICAL_TRANSCRIPTION_JOB_NAME_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("MedicalTranscriptionJobName")
.getter(getter(StartMedicalTranscriptionJobRequest::medicalTranscriptionJobName))
.setter(setter(Builder::medicalTranscriptionJobName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MedicalTranscriptionJobName")
.build()).build();
private static final SdkField LANGUAGE_CODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("LanguageCode").getter(getter(StartMedicalTranscriptionJobRequest::languageCodeAsString))
.setter(setter(Builder::languageCode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LanguageCode").build()).build();
private static final SdkField MEDIA_SAMPLE_RATE_HERTZ_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MediaSampleRateHertz").getter(getter(StartMedicalTranscriptionJobRequest::mediaSampleRateHertz))
.setter(setter(Builder::mediaSampleRateHertz))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MediaSampleRateHertz").build())
.build();
private static final SdkField MEDIA_FORMAT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MediaFormat").getter(getter(StartMedicalTranscriptionJobRequest::mediaFormatAsString))
.setter(setter(Builder::mediaFormat))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MediaFormat").build()).build();
private static final SdkField MEDIA_FIELD = SdkField. builder(MarshallingType.SDK_POJO).memberName("Media")
.getter(getter(StartMedicalTranscriptionJobRequest::media)).setter(setter(Builder::media))
.constructor(Media::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Media").build()).build();
private static final SdkField OUTPUT_BUCKET_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OutputBucketName").getter(getter(StartMedicalTranscriptionJobRequest::outputBucketName))
.setter(setter(Builder::outputBucketName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OutputBucketName").build()).build();
private static final SdkField OUTPUT_KEY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OutputKey").getter(getter(StartMedicalTranscriptionJobRequest::outputKey))
.setter(setter(Builder::outputKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OutputKey").build()).build();
private static final SdkField OUTPUT_ENCRYPTION_KMS_KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OutputEncryptionKMSKeyId").getter(getter(StartMedicalTranscriptionJobRequest::outputEncryptionKMSKeyId))
.setter(setter(Builder::outputEncryptionKMSKeyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OutputEncryptionKMSKeyId").build())
.build();
private static final SdkField> KMS_ENCRYPTION_CONTEXT_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("KMSEncryptionContext")
.getter(getter(StartMedicalTranscriptionJobRequest::kmsEncryptionContext))
.setter(setter(Builder::kmsEncryptionContext))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KMSEncryptionContext").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField SETTINGS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Settings")
.getter(getter(StartMedicalTranscriptionJobRequest::settings)).setter(setter(Builder::settings))
.constructor(MedicalTranscriptionSetting::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Settings").build()).build();
private static final SdkField CONTENT_IDENTIFICATION_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ContentIdentificationType")
.getter(getter(StartMedicalTranscriptionJobRequest::contentIdentificationTypeAsString))
.setter(setter(Builder::contentIdentificationType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ContentIdentificationType").build())
.build();
private static final SdkField SPECIALTY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Specialty").getter(getter(StartMedicalTranscriptionJobRequest::specialtyAsString))
.setter(setter(Builder::specialty))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Specialty").build()).build();
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Type")
.getter(getter(StartMedicalTranscriptionJobRequest::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Type").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(StartMedicalTranscriptionJobRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
MEDICAL_TRANSCRIPTION_JOB_NAME_FIELD, LANGUAGE_CODE_FIELD, MEDIA_SAMPLE_RATE_HERTZ_FIELD, MEDIA_FORMAT_FIELD,
MEDIA_FIELD, OUTPUT_BUCKET_NAME_FIELD, OUTPUT_KEY_FIELD, OUTPUT_ENCRYPTION_KMS_KEY_ID_FIELD,
KMS_ENCRYPTION_CONTEXT_FIELD, SETTINGS_FIELD, CONTENT_IDENTIFICATION_TYPE_FIELD, SPECIALTY_FIELD, TYPE_FIELD,
TAGS_FIELD));
private final String medicalTranscriptionJobName;
private final String languageCode;
private final Integer mediaSampleRateHertz;
private final String mediaFormat;
private final Media media;
private final String outputBucketName;
private final String outputKey;
private final String outputEncryptionKMSKeyId;
private final Map kmsEncryptionContext;
private final MedicalTranscriptionSetting settings;
private final String contentIdentificationType;
private final String specialty;
private final String type;
private final List tags;
private StartMedicalTranscriptionJobRequest(BuilderImpl builder) {
super(builder);
this.medicalTranscriptionJobName = builder.medicalTranscriptionJobName;
this.languageCode = builder.languageCode;
this.mediaSampleRateHertz = builder.mediaSampleRateHertz;
this.mediaFormat = builder.mediaFormat;
this.media = builder.media;
this.outputBucketName = builder.outputBucketName;
this.outputKey = builder.outputKey;
this.outputEncryptionKMSKeyId = builder.outputEncryptionKMSKeyId;
this.kmsEncryptionContext = builder.kmsEncryptionContext;
this.settings = builder.settings;
this.contentIdentificationType = builder.contentIdentificationType;
this.specialty = builder.specialty;
this.type = builder.type;
this.tags = builder.tags;
}
/**
*
* A unique name, chosen by you, for your medical transcription job. The name you specify is also used as the
* default name of your transcription output file. If you want to specify a different name for your transcription
* output, use the OutputKey parameter.
*
*
* This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If
* you try to create a new job with the same name as an existing job, you get a ConflictException
* error.
*
*
* @return A unique name, chosen by you, for your medical transcription job. The name you specify is also used as
* the default name of your transcription output file. If you want to specify a different name for your
* transcription output, use the OutputKey parameter.
*
* This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services
* account. If you try to create a new job with the same name as an existing job, you get a
* ConflictException error.
*/
public final String medicalTranscriptionJobName() {
return medicalTranscriptionJobName;
}
/**
*
* The language code that represents the language spoken in the input media file. US English (en-US) is
* the only 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, {@link #languageCode} will
* return {@link LanguageCode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #languageCodeAsString}.
*
*
* @return The language code that represents the language spoken in the input media file. US English (
* en-US) is the only valid value for medical transcription jobs. Any other value you enter for
* language code results in a BadRequestException error.
* @see LanguageCode
*/
public final LanguageCode languageCode() {
return LanguageCode.fromValue(languageCode);
}
/**
*
* The language code that represents the language spoken in the input media file. US English (en-US) is
* the only 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, {@link #languageCode} will
* return {@link LanguageCode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #languageCodeAsString}.
*
*
* @return The language code that represents the language spoken in the input media file. US English (
* en-US) is the only valid value for medical transcription jobs. Any other value you enter for
* language code results in a BadRequestException error.
* @see LanguageCode
*/
public final String languageCodeAsString() {
return languageCode;
}
/**
*
* The sample rate, in Hertz, of the audio track in your input media file.
*
*
* If you don't specify the media sample rate, Amazon Transcribe Medical determines it for you. If you specify the
* sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the
* value you specify and the value detected, your job fails. Therefore, in most cases, it's advised to omit
* MediaSampleRateHertz and let Amazon Transcribe Medical determine the sample rate.
*
*
* @return The sample rate, in Hertz, of the audio track in your input media file.
*
* If you don't specify the media sample rate, Amazon Transcribe Medical determines it for you. If you
* specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a
* mismatch between the value you specify and the value detected, your job fails. Therefore, in most cases,
* it's advised to omit MediaSampleRateHertz and let Amazon Transcribe Medical determine the
* sample rate.
*/
public final Integer mediaSampleRateHertz() {
return mediaSampleRateHertz;
}
/**
*
* Specify the format of your input media file.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #mediaFormat} will
* return {@link MediaFormat#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #mediaFormatAsString}.
*
*
* @return Specify the format of your input media file.
* @see MediaFormat
*/
public final MediaFormat mediaFormat() {
return MediaFormat.fromValue(mediaFormat);
}
/**
*
* Specify the format of your input media file.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #mediaFormat} will
* return {@link MediaFormat#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #mediaFormatAsString}.
*
*
* @return Specify the format of your input media file.
* @see MediaFormat
*/
public final String mediaFormatAsString() {
return mediaFormat;
}
/**
* Returns the value of the Media property for this object.
*
* @return The value of the Media property for this object.
*/
public final Media media() {
return media;
}
/**
*
* The name of the Amazon S3 bucket where you want your medical transcription output stored. Do not include the
* S3:// prefix of the specified bucket.
*
*
* If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey
* parameter; OutputBucketName only accepts the name of a bucket.
*
*
* For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set
* OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in
* S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to
* DOC-EXAMPLE-BUCKET and OutputKey to test-files/.
*
*
* Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3
* permissions using the Amazon Web Services Management Console. See
* also Permissions Required for IAM User Roles.
*
*
* If you don't specify OutputBucketName, your transcript is placed in a service-managed Amazon S3
* bucket and you are provided with a URI to access your transcript.
*
*
* @return The name of the Amazon S3 bucket where you want your medical transcription output stored. Do not include
* the S3:// prefix of the specified bucket.
*
* If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey
* parameter; OutputBucketName only accepts the name of a bucket.
*
*
* For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set
* OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored
* in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to
* DOC-EXAMPLE-BUCKET and OutputKey to test-files/.
*
*
* Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3
* permissions using the Amazon Web Services Management
* Console. See also Permissions Required for IAM User Roles.
*
*
* If you don't specify OutputBucketName, your transcript is placed in a service-managed Amazon
* S3 bucket and you are provided with a URI to access your transcript.
*/
public final String outputBucketName() {
return outputBucketName;
}
/**
*
* Use in combination with OutputBucketName to specify the output location of your transcript and,
* optionally, a unique name for your output file. The default name for your transcription output is the same as the
* name you specified for your medical transcription job (MedicalTranscriptionJobName).
*
*
* Here are some examples of how you can use OutputKey:
*
*
* -
*
* If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the
* OutputKey, your transcription output path is s3://DOC-EXAMPLE-BUCKET/my-transcript.json
* .
*
*
* -
*
* If you specify 'my-first-transcription' as the MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as
* the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription output
* path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
*
*
* -
*
* If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json' as
* the OutputKey, your transcription output path is
* s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
*
*
* -
*
* If you specify 'my-first-transcription' as the MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET' as
* the OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your
* transcription output path is
* s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
*
*
*
*
* If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
*
*
* @return Use in combination with OutputBucketName to specify the output location of your transcript
* and, optionally, a unique name for your output file. The default name for your transcription output is
* the same as the name you specified for your medical transcription job (
* MedicalTranscriptionJobName).
*
* Here are some examples of how you can use OutputKey:
*
*
* -
*
* If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the
* OutputKey, your transcription output path is
* s3://DOC-EXAMPLE-BUCKET/my-transcript.json.
*
*
* -
*
* If you specify 'my-first-transcription' as the MedicalTranscriptionJobName,
* 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the
* OutputKey, your transcription output path is
* s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
*
*
* -
*
* If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and
* 'test-files/my-transcript.json' as the OutputKey, your transcription output path is
* s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
*
*
* -
*
* If you specify 'my-first-transcription' as the MedicalTranscriptionJobName,
* 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript' as the
* OutputKey, your transcription output path is
* s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
*
*
*
*
* If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
*/
public final String outputKey() {
return outputKey;
}
/**
*
* The KMS key you want to use to encrypt your medical transcription output.
*
*
* If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of
* four ways:
*
*
* -
*
* Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
*
*
* -
*
* Use an alias for the KMS key ID. For example, alias/ExampleAlias.
*
*
* -
*
* Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
* arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
*
*
* -
*
* Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
*
*
*
*
* If using a key located in a different Amazon Web Services account than the current Amazon Web Services
* account, you can specify your KMS key in one of two ways:
*
*
* -
*
* Use the ARN for the KMS key ID. For example,
* arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
*
*
* -
*
* Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias.
*
*
*
*
* If you don't specify an encryption key, your output 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 using the
* OutputLocation parameter.
*
*
* Note that the user making the request must have permission to use the specified KMS key.
*
*
* @return The KMS key you want to use to encrypt your medical transcription output.
*
* If using a key located in the current Amazon Web Services account, you can specify your KMS key in
* one of four ways:
*
*
* -
*
* Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
*
*
* -
*
* Use an alias for the KMS key ID. For example, alias/ExampleAlias.
*
*
* -
*
* Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
* arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
*
*
* -
*
* Use the ARN for the KMS key alias. For example,
* arn:aws:kms:region:account-ID:alias/ExampleAlias.
*
*
*
*
* If using a key located in a different Amazon Web Services account than the current Amazon Web
* Services account, you can specify your KMS key in one of two ways:
*
*
* -
*
* Use the ARN for the KMS key ID. For example,
* arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
*
*
* -
*
* Use the ARN for the KMS key alias. For example,
* arn:aws:kms:region:account-ID:alias/ExampleAlias.
*
*
*
*
* If you don't specify an encryption key, your output 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 using the
* OutputLocation parameter.
*
*
* Note that the user making the request must have permission to use the specified KMS key.
*/
public final String outputEncryptionKMSKeyId() {
return outputEncryptionKMSKeyId;
}
/**
* 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 {@code 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.
*/
public final boolean hasKmsEncryptionContext() {
return kmsEncryptionContext != null && !(kmsEncryptionContext instanceof SdkAutoConstructMap);
}
/**
*
* 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. For more information, see KMS encryption
* context and Asymmetric
* keys in KMS.
*
*
* 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 {@link #hasKmsEncryptionContext} method.
*
*
* @return 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. For more information, see KMS encryption
* context and Asymmetric keys in
* KMS.
*/
public final Map kmsEncryptionContext() {
return kmsEncryptionContext;
}
/**
*
* Specify additional optional settings in your request, including channel identification, alternative
* transcriptions, and speaker labeling; allows you to apply custom vocabularies to your transcription job.
*
*
* @return Specify additional optional settings in your request, including channel identification, alternative
* transcriptions, and speaker labeling; allows you to apply custom vocabularies to your transcription job.
*/
public final MedicalTranscriptionSetting settings() {
return settings;
}
/**
*
* 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,
* {@link #contentIdentificationType} will return {@link MedicalContentIdentificationType#UNKNOWN_TO_SDK_VERSION}.
* The raw value returned by the service is available from {@link #contentIdentificationTypeAsString}.
*
*
* @return Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health
* information (PHI) in a transcription.
* @see MedicalContentIdentificationType
*/
public final MedicalContentIdentificationType contentIdentificationType() {
return MedicalContentIdentificationType.fromValue(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,
* {@link #contentIdentificationType} will return {@link MedicalContentIdentificationType#UNKNOWN_TO_SDK_VERSION}.
* The raw value returned by the service is available from {@link #contentIdentificationTypeAsString}.
*
*
* @return Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health
* information (PHI) in a transcription.
* @see MedicalContentIdentificationType
*/
public final String contentIdentificationTypeAsString() {
return contentIdentificationType;
}
/**
*
* Specify the predominant medical specialty represented in your media. For batch transcriptions,
* PRIMARYCARE is the only valid value. If you require additional specialties, refer to .
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #specialty} will
* return {@link Specialty#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #specialtyAsString}.
*
*
* @return Specify the predominant medical specialty represented in your media. For batch transcriptions,
* PRIMARYCARE is the only valid value. If you require additional specialties, refer to .
* @see Specialty
*/
public final Specialty specialty() {
return Specialty.fromValue(specialty);
}
/**
*
* Specify the predominant medical specialty represented in your media. For batch transcriptions,
* PRIMARYCARE is the only valid value. If you require additional specialties, refer to .
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #specialty} will
* return {@link Specialty#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #specialtyAsString}.
*
*
* @return Specify the predominant medical specialty represented in your media. For batch transcriptions,
* PRIMARYCARE is the only valid value. If you require additional specialties, refer to .
* @see Specialty
*/
public final String specialtyAsString() {
return specialty;
}
/**
*
* Specify whether your input media contains only one person (DICTATION) or contains a conversation
* between two people (CONVERSATION).
*
*
* For example, DICTATION could be used for a medical professional wanting to transcribe voice memos;
* CONVERSATION could be used for transcribing the doctor-patient dialogue during the patient's office
* visit.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link Type#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return Specify whether your input media contains only one person (DICTATION) or contains a
* conversation between two people (CONVERSATION).
*
* For example, DICTATION could be used for a medical professional wanting to transcribe voice
* memos; CONVERSATION could be used for transcribing the doctor-patient dialogue during the
* patient's office visit.
* @see Type
*/
public final Type type() {
return Type.fromValue(type);
}
/**
*
* Specify whether your input media contains only one person (DICTATION) or contains a conversation
* between two people (CONVERSATION).
*
*
* For example, DICTATION could be used for a medical professional wanting to transcribe voice memos;
* CONVERSATION could be used for transcribing the doctor-patient dialogue during the patient's office
* visit.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link Type#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return Specify whether your input media contains only one person (DICTATION) or contains a
* conversation between two people (CONVERSATION).
*
* For example, DICTATION could be used for a medical professional wanting to transcribe voice
* memos; CONVERSATION could be used for transcribing the doctor-patient dialogue during the
* patient's office visit.
* @see Type
*/
public final String typeAsString() {
return type;
}
/**
* 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 {@code 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.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the
* time you start this new job.
*
*
* To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
*
*
* 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 {@link #hasTags} method.
*
*
* @return Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at
* the time you start this new job.
*
* To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
*/
public final List tags() {
return tags;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(medicalTranscriptionJobName());
hashCode = 31 * hashCode + Objects.hashCode(languageCodeAsString());
hashCode = 31 * hashCode + Objects.hashCode(mediaSampleRateHertz());
hashCode = 31 * hashCode + Objects.hashCode(mediaFormatAsString());
hashCode = 31 * hashCode + Objects.hashCode(media());
hashCode = 31 * hashCode + Objects.hashCode(outputBucketName());
hashCode = 31 * hashCode + Objects.hashCode(outputKey());
hashCode = 31 * hashCode + Objects.hashCode(outputEncryptionKMSKeyId());
hashCode = 31 * hashCode + Objects.hashCode(hasKmsEncryptionContext() ? kmsEncryptionContext() : null);
hashCode = 31 * hashCode + Objects.hashCode(settings());
hashCode = 31 * hashCode + Objects.hashCode(contentIdentificationTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(specialtyAsString());
hashCode = 31 * hashCode + Objects.hashCode(typeAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof StartMedicalTranscriptionJobRequest)) {
return false;
}
StartMedicalTranscriptionJobRequest other = (StartMedicalTranscriptionJobRequest) obj;
return Objects.equals(medicalTranscriptionJobName(), other.medicalTranscriptionJobName())
&& Objects.equals(languageCodeAsString(), other.languageCodeAsString())
&& Objects.equals(mediaSampleRateHertz(), other.mediaSampleRateHertz())
&& Objects.equals(mediaFormatAsString(), other.mediaFormatAsString()) && Objects.equals(media(), other.media())
&& Objects.equals(outputBucketName(), other.outputBucketName()) && Objects.equals(outputKey(), other.outputKey())
&& Objects.equals(outputEncryptionKMSKeyId(), other.outputEncryptionKMSKeyId())
&& hasKmsEncryptionContext() == other.hasKmsEncryptionContext()
&& Objects.equals(kmsEncryptionContext(), other.kmsEncryptionContext())
&& Objects.equals(settings(), other.settings())
&& Objects.equals(contentIdentificationTypeAsString(), other.contentIdentificationTypeAsString())
&& Objects.equals(specialtyAsString(), other.specialtyAsString())
&& Objects.equals(typeAsString(), other.typeAsString()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("StartMedicalTranscriptionJobRequest")
.add("MedicalTranscriptionJobName", medicalTranscriptionJobName()).add("LanguageCode", languageCodeAsString())
.add("MediaSampleRateHertz", mediaSampleRateHertz()).add("MediaFormat", mediaFormatAsString())
.add("Media", media()).add("OutputBucketName", outputBucketName()).add("OutputKey", outputKey())
.add("OutputEncryptionKMSKeyId", outputEncryptionKMSKeyId())
.add("KMSEncryptionContext", hasKmsEncryptionContext() ? kmsEncryptionContext() : null)
.add("Settings", settings()).add("ContentIdentificationType", contentIdentificationTypeAsString())
.add("Specialty", specialtyAsString()).add("Type", typeAsString()).add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "MedicalTranscriptionJobName":
return Optional.ofNullable(clazz.cast(medicalTranscriptionJobName()));
case "LanguageCode":
return Optional.ofNullable(clazz.cast(languageCodeAsString()));
case "MediaSampleRateHertz":
return Optional.ofNullable(clazz.cast(mediaSampleRateHertz()));
case "MediaFormat":
return Optional.ofNullable(clazz.cast(mediaFormatAsString()));
case "Media":
return Optional.ofNullable(clazz.cast(media()));
case "OutputBucketName":
return Optional.ofNullable(clazz.cast(outputBucketName()));
case "OutputKey":
return Optional.ofNullable(clazz.cast(outputKey()));
case "OutputEncryptionKMSKeyId":
return Optional.ofNullable(clazz.cast(outputEncryptionKMSKeyId()));
case "KMSEncryptionContext":
return Optional.ofNullable(clazz.cast(kmsEncryptionContext()));
case "Settings":
return Optional.ofNullable(clazz.cast(settings()));
case "ContentIdentificationType":
return Optional.ofNullable(clazz.cast(contentIdentificationTypeAsString()));
case "Specialty":
return Optional.ofNullable(clazz.cast(specialtyAsString()));
case "Type":
return Optional.ofNullable(clazz.cast(typeAsString()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((StartMedicalTranscriptionJobRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends TranscribeRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* A unique name, chosen by you, for your medical transcription job. The name you specify is also used as the
* default name of your transcription output file. If you want to specify a different name for your
* transcription output, use the OutputKey parameter.
*
*
* This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.
* If you try to create a new job with the same name as an existing job, you get a
* ConflictException error.
*
*
* @param medicalTranscriptionJobName
* A unique name, chosen by you, for your medical transcription job. The name you specify is also used as
* the default name of your transcription output file. If you want to specify a different name for your
* transcription output, use the OutputKey parameter.
*
* This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services
* account. If you try to create a new job with the same name as an existing job, you get a
* ConflictException error.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder medicalTranscriptionJobName(String medicalTranscriptionJobName);
/**
*
* The language code that represents the language spoken in the input media file. US English (en-US
* ) is the only valid value for medical transcription jobs. Any other value you enter for language code results
* in a BadRequestException error.
*
*
* @param languageCode
* The language code that represents the language spoken in the input media file. US English (
* en-US) is the only valid value for medical transcription jobs. Any other value you enter
* for language code results in a BadRequestException error.
* @see LanguageCode
* @return Returns a reference to this object so that method calls can be chained together.
* @see LanguageCode
*/
Builder languageCode(String languageCode);
/**
*
* The language code that represents the language spoken in the input media file. US English (en-US
* ) is the only valid value for medical transcription jobs. Any other value you enter for language code results
* in a BadRequestException error.
*
*
* @param languageCode
* The language code that represents the language spoken in the input media file. US English (
* en-US) is the only valid value for medical transcription jobs. Any other value you enter
* for language code results in a BadRequestException error.
* @see LanguageCode
* @return Returns a reference to this object so that method calls can be chained together.
* @see LanguageCode
*/
Builder languageCode(LanguageCode languageCode);
/**
*
* The sample rate, in Hertz, of the audio track in your input media file.
*
*
* If you don't specify the media sample rate, Amazon Transcribe Medical determines it for you. If you specify
* the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between
* the value you specify and the value detected, your job fails. Therefore, in most cases, it's advised to omit
* MediaSampleRateHertz and let Amazon Transcribe Medical determine the sample rate.
*
*
* @param mediaSampleRateHertz
* The sample rate, in Hertz, of the audio track in your input media file.
*
* If you don't specify the media sample rate, Amazon Transcribe Medical determines it for you. If you
* specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a
* mismatch between the value you specify and the value detected, your job fails. Therefore, in most
* cases, it's advised to omit MediaSampleRateHertz and let Amazon Transcribe Medical
* determine the sample rate.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder mediaSampleRateHertz(Integer mediaSampleRateHertz);
/**
*
* Specify the format of your input media file.
*
*
* @param mediaFormat
* Specify the format of your input media file.
* @see MediaFormat
* @return Returns a reference to this object so that method calls can be chained together.
* @see MediaFormat
*/
Builder mediaFormat(String mediaFormat);
/**
*
* Specify the format of your input media file.
*
*
* @param mediaFormat
* Specify the format of your input media file.
* @see MediaFormat
* @return Returns a reference to this object so that method calls can be chained together.
* @see MediaFormat
*/
Builder mediaFormat(MediaFormat mediaFormat);
/**
* Sets the value of the Media property for this object.
*
* @param media
* The new value for the Media property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder media(Media media);
/**
* Sets the value of the Media property for this object.
*
* This is a convenience method that creates an instance of the {@link Media.Builder} avoiding the need to
* create one manually via {@link Media#builder()}.
*
* When the {@link Consumer} completes, {@link Media.Builder#build()} is called immediately and its result is
* passed to {@link #media(Media)}.
*
* @param media
* a consumer that will call methods on {@link Media.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #media(Media)
*/
default Builder media(Consumer media) {
return media(Media.builder().applyMutation(media).build());
}
/**
*
* The name of the Amazon S3 bucket where you want your medical transcription output stored. Do not include the
* S3:// prefix of the specified bucket.
*
*
* If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey
* parameter; OutputBucketName only accepts the name of a bucket.
*
*
* For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set
* OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in
* S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to
* DOC-EXAMPLE-BUCKET and OutputKey to test-files/.
*
*
* Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3
* permissions using the Amazon Web Services Management Console.
* See also Permissions Required for IAM User Roles.
*
*
* If you don't specify OutputBucketName, your transcript is placed in a service-managed Amazon S3
* bucket and you are provided with a URI to access your transcript.
*
*
* @param outputBucketName
* The name of the Amazon S3 bucket where you want your medical transcription output stored. Do not
* include the S3:// prefix of the specified bucket.
*
* If you want your output to go to a sub-folder of this bucket, specify it using the
* OutputKey parameter; OutputBucketName only accepts the name of a bucket.
*
*
* For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set
* OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output
* stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to
* DOC-EXAMPLE-BUCKET and OutputKey to test-files/.
*
*
* Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon
* S3 permissions using the Amazon Web Services Management
* Console. See also Permissions Required for IAM User Roles.
*
*
* If you don't specify OutputBucketName, your transcript is placed in a service-managed
* Amazon S3 bucket and you are provided with a URI to access your transcript.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder outputBucketName(String outputBucketName);
/**
*
* Use in combination with OutputBucketName to specify the output location of your transcript and,
* optionally, a unique name for your output file. The default name for your transcription output is the same as
* the name you specified for your medical transcription job (MedicalTranscriptionJobName).
*
*
* Here are some examples of how you can use OutputKey:
*
*
* -
*
* If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as the
* OutputKey, your transcription output path is
* s3://DOC-EXAMPLE-BUCKET/my-transcript.json.
*
*
* -
*
* If you specify 'my-first-transcription' as the MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET'
* as the OutputBucketName, and 'my-transcript' as the OutputKey, your transcription
* output path is s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
*
*
* -
*
* If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'test-files/my-transcript.json'
* as the OutputKey, your transcription output path is
* s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
*
*
* -
*
* If you specify 'my-first-transcription' as the MedicalTranscriptionJobName, 'DOC-EXAMPLE-BUCKET'
* as the OutputBucketName, and 'test-files/my-transcript' as the OutputKey, your
* transcription output path is
* s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
*
*
*
*
* If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
*
*
* @param outputKey
* Use in combination with OutputBucketName to specify the output location of your
* transcript and, optionally, a unique name for your output file. The default name for your
* transcription output is the same as the name you specified for your medical transcription job (
* MedicalTranscriptionJobName).
*
* Here are some examples of how you can use OutputKey:
*
*
* -
*
* If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and 'my-transcript.json' as
* the OutputKey, your transcription output path is
* s3://DOC-EXAMPLE-BUCKET/my-transcript.json.
*
*
* -
*
* If you specify 'my-first-transcription' as the MedicalTranscriptionJobName,
* 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'my-transcript' as the
* OutputKey, your transcription output path is
* s3://DOC-EXAMPLE-BUCKET/my-transcript/my-first-transcription.json.
*
*
* -
*
* If you specify 'DOC-EXAMPLE-BUCKET' as the OutputBucketName and
* 'test-files/my-transcript.json' as the OutputKey, your transcription output path is
* s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript.json.
*
*
* -
*
* If you specify 'my-first-transcription' as the MedicalTranscriptionJobName,
* 'DOC-EXAMPLE-BUCKET' as the OutputBucketName, and 'test-files/my-transcript' as the
* OutputKey, your transcription output path is
* s3://DOC-EXAMPLE-BUCKET/test-files/my-transcript/my-first-transcription.json.
*
*
*
*
* If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist, one is created for you.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder outputKey(String outputKey);
/**
*
* The KMS key you want to use to encrypt your medical transcription output.
*
*
* If using a key located in the current Amazon Web Services account, you can specify your KMS key in one
* of four ways:
*
*
* -
*
* Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
*
*
* -
*
* Use an alias for the KMS key ID. For example, alias/ExampleAlias.
*
*
* -
*
* Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
* arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
*
*
* -
*
* Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias
* .
*
*
*
*
* If using a key located in a different Amazon Web Services account than the current Amazon Web Services
* account, you can specify your KMS key in one of two ways:
*
*
* -
*
* Use the ARN for the KMS key ID. For example,
* arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
*
*
* -
*
* Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias
* .
*
*
*
*
* If you don't specify an encryption key, your output 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 using the
* OutputLocation parameter.
*
*
* Note that the user making the request must have permission to use the specified KMS key.
*
*
* @param outputEncryptionKMSKeyId
* The KMS key you want to use to encrypt your medical transcription output.
*
* If using a key located in the current Amazon Web Services account, you can specify your KMS key
* in one of four ways:
*
*
* -
*
* Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
*
*
* -
*
* Use an alias for the KMS key ID. For example, alias/ExampleAlias.
*
*
* -
*
* Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
* arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
*
*
* -
*
* Use the ARN for the KMS key alias. For example,
* arn:aws:kms:region:account-ID:alias/ExampleAlias.
*
*
*
*
* If using a key located in a different Amazon Web Services account than the current Amazon Web
* Services account, you can specify your KMS key in one of two ways:
*
*
* -
*
* Use the ARN for the KMS key ID. For example,
* arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab.
*
*
* -
*
* Use the ARN for the KMS key alias. For example,
* arn:aws:kms:region:account-ID:alias/ExampleAlias.
*
*
*
*
* If you don't specify an encryption key, your output 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 using the
* OutputLocation parameter.
*
*
* Note that the user making the request must have permission to use the specified KMS key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder outputEncryptionKMSKeyId(String outputEncryptionKMSKeyId);
/**
*
* 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. For more information, see KMS encryption
* context and Asymmetric keys in KMS.
*
*
* @param 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. For more information, see KMS encryption
* context and Asymmetric keys in
* KMS.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder kmsEncryptionContext(Map kmsEncryptionContext);
/**
*
* Specify additional optional settings in your request, including channel identification, alternative
* transcriptions, and speaker labeling; allows you to apply custom vocabularies to your transcription job.
*
*
* @param settings
* Specify additional optional settings in your request, including channel identification, alternative
* transcriptions, and speaker labeling; allows you to apply custom vocabularies to your transcription
* job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder settings(MedicalTranscriptionSetting settings);
/**
*
* Specify additional optional settings in your request, including channel identification, alternative
* transcriptions, and speaker labeling; allows you to apply custom vocabularies to your transcription job.
*
* This is a convenience method that creates an instance of the {@link MedicalTranscriptionSetting.Builder}
* avoiding the need to create one manually via {@link MedicalTranscriptionSetting#builder()}.
*
* When the {@link Consumer} completes, {@link MedicalTranscriptionSetting.Builder#build()} is called
* immediately and its result is passed to {@link #settings(MedicalTranscriptionSetting)}.
*
* @param settings
* a consumer that will call methods on {@link MedicalTranscriptionSetting.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #settings(MedicalTranscriptionSetting)
*/
default Builder settings(Consumer settings) {
return settings(MedicalTranscriptionSetting.builder().applyMutation(settings).build());
}
/**
*
* Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information
* (PHI) in a transcription.
*
*
* @param contentIdentificationType
* Labels all personal health information (PHI) identified in your transcript. For more information, see
* Identifying personal health
* information (PHI) in a transcription.
* @see MedicalContentIdentificationType
* @return Returns a reference to this object so that method calls can be chained together.
* @see MedicalContentIdentificationType
*/
Builder contentIdentificationType(String contentIdentificationType);
/**
*
* Labels all personal health information (PHI) identified in your transcript. For more information, see Identifying personal health information
* (PHI) in a transcription.
*
*
* @param contentIdentificationType
* Labels all personal health information (PHI) identified in your transcript. For more information, see
* Identifying personal health
* information (PHI) in a transcription.
* @see MedicalContentIdentificationType
* @return Returns a reference to this object so that method calls can be chained together.
* @see MedicalContentIdentificationType
*/
Builder contentIdentificationType(MedicalContentIdentificationType contentIdentificationType);
/**
*
* Specify the predominant medical specialty represented in your media. For batch transcriptions,
* PRIMARYCARE is the only valid value. If you require additional specialties, refer to .
*
*
* @param specialty
* Specify the predominant medical specialty represented in your media. For batch transcriptions,
* PRIMARYCARE is the only valid value. If you require additional specialties, refer to .
* @see Specialty
* @return Returns a reference to this object so that method calls can be chained together.
* @see Specialty
*/
Builder specialty(String specialty);
/**
*
* Specify the predominant medical specialty represented in your media. For batch transcriptions,
* PRIMARYCARE is the only valid value. If you require additional specialties, refer to .
*
*
* @param specialty
* Specify the predominant medical specialty represented in your media. For batch transcriptions,
* PRIMARYCARE is the only valid value. If you require additional specialties, refer to .
* @see Specialty
* @return Returns a reference to this object so that method calls can be chained together.
* @see Specialty
*/
Builder specialty(Specialty specialty);
/**
*
* Specify whether your input media contains only one person (DICTATION) or contains a conversation
* between two people (CONVERSATION).
*
*
* For example, DICTATION could be used for a medical professional wanting to transcribe voice
* memos; CONVERSATION could be used for transcribing the doctor-patient dialogue during the
* patient's office visit.
*
*
* @param type
* Specify whether your input media contains only one person (DICTATION) or contains a
* conversation between two people (CONVERSATION).
*
* For example, DICTATION could be used for a medical professional wanting to transcribe
* voice memos; CONVERSATION could be used for transcribing the doctor-patient dialogue
* during the patient's office visit.
* @see Type
* @return Returns a reference to this object so that method calls can be chained together.
* @see Type
*/
Builder type(String type);
/**
*
* Specify whether your input media contains only one person (DICTATION) or contains a conversation
* between two people (CONVERSATION).
*
*
* For example, DICTATION could be used for a medical professional wanting to transcribe voice
* memos; CONVERSATION could be used for transcribing the doctor-patient dialogue during the
* patient's office visit.
*
*
* @param type
* Specify whether your input media contains only one person (DICTATION) or contains a
* conversation between two people (CONVERSATION).
*
* For example, DICTATION could be used for a medical professional wanting to transcribe
* voice memos; CONVERSATION could be used for transcribing the doctor-patient dialogue
* during the patient's office visit.
* @see Type
* @return Returns a reference to this object so that method calls can be chained together.
* @see Type
*/
Builder type(Type type);
/**
*
* Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the
* time you start this new job.
*
*
* To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
*
*
* @param tags
* Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job
* at the time you start this new job.
*
* To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the
* time you start this new job.
*
*
* To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
*
*
* @param tags
* Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job
* at the time you start this new job.
*
* To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* Adds one or more custom tags, each in the form of a key:value pair, to a new medical transcription job at the
* time you start this new job.
*
*
* To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
*
* This is a convenience method that creates an instance of the {@link List.Builder} avoiding the need to
* create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result
* is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(List)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends TranscribeRequest.BuilderImpl implements Builder {
private String medicalTranscriptionJobName;
private String languageCode;
private Integer mediaSampleRateHertz;
private String mediaFormat;
private Media media;
private String outputBucketName;
private String outputKey;
private String outputEncryptionKMSKeyId;
private Map kmsEncryptionContext = DefaultSdkAutoConstructMap.getInstance();
private MedicalTranscriptionSetting settings;
private String contentIdentificationType;
private String specialty;
private String type;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(StartMedicalTranscriptionJobRequest model) {
super(model);
medicalTranscriptionJobName(model.medicalTranscriptionJobName);
languageCode(model.languageCode);
mediaSampleRateHertz(model.mediaSampleRateHertz);
mediaFormat(model.mediaFormat);
media(model.media);
outputBucketName(model.outputBucketName);
outputKey(model.outputKey);
outputEncryptionKMSKeyId(model.outputEncryptionKMSKeyId);
kmsEncryptionContext(model.kmsEncryptionContext);
settings(model.settings);
contentIdentificationType(model.contentIdentificationType);
specialty(model.specialty);
type(model.type);
tags(model.tags);
}
public final String getMedicalTranscriptionJobName() {
return medicalTranscriptionJobName;
}
public final void setMedicalTranscriptionJobName(String medicalTranscriptionJobName) {
this.medicalTranscriptionJobName = medicalTranscriptionJobName;
}
@Override
public final Builder medicalTranscriptionJobName(String medicalTranscriptionJobName) {
this.medicalTranscriptionJobName = medicalTranscriptionJobName;
return this;
}
public final String getLanguageCode() {
return languageCode;
}
public final void setLanguageCode(String languageCode) {
this.languageCode = languageCode;
}
@Override
public final Builder languageCode(String languageCode) {
this.languageCode = languageCode;
return this;
}
@Override
public final Builder languageCode(LanguageCode languageCode) {
this.languageCode(languageCode == null ? null : languageCode.toString());
return this;
}
public final Integer getMediaSampleRateHertz() {
return mediaSampleRateHertz;
}
public final void setMediaSampleRateHertz(Integer mediaSampleRateHertz) {
this.mediaSampleRateHertz = mediaSampleRateHertz;
}
@Override
public final Builder mediaSampleRateHertz(Integer mediaSampleRateHertz) {
this.mediaSampleRateHertz = mediaSampleRateHertz;
return this;
}
public final String getMediaFormat() {
return mediaFormat;
}
public final void setMediaFormat(String mediaFormat) {
this.mediaFormat = mediaFormat;
}
@Override
public final Builder mediaFormat(String mediaFormat) {
this.mediaFormat = mediaFormat;
return this;
}
@Override
public final Builder mediaFormat(MediaFormat mediaFormat) {
this.mediaFormat(mediaFormat == null ? null : mediaFormat.toString());
return this;
}
public final Media.Builder getMedia() {
return media != null ? media.toBuilder() : null;
}
public final void setMedia(Media.BuilderImpl media) {
this.media = media != null ? media.build() : null;
}
@Override
public final Builder media(Media media) {
this.media = media;
return this;
}
public final String getOutputBucketName() {
return outputBucketName;
}
public final void setOutputBucketName(String outputBucketName) {
this.outputBucketName = outputBucketName;
}
@Override
public final Builder outputBucketName(String outputBucketName) {
this.outputBucketName = outputBucketName;
return this;
}
public final String getOutputKey() {
return outputKey;
}
public final void setOutputKey(String outputKey) {
this.outputKey = outputKey;
}
@Override
public final Builder outputKey(String outputKey) {
this.outputKey = outputKey;
return this;
}
public final String getOutputEncryptionKMSKeyId() {
return outputEncryptionKMSKeyId;
}
public final void setOutputEncryptionKMSKeyId(String outputEncryptionKMSKeyId) {
this.outputEncryptionKMSKeyId = outputEncryptionKMSKeyId;
}
@Override
public final Builder outputEncryptionKMSKeyId(String outputEncryptionKMSKeyId) {
this.outputEncryptionKMSKeyId = outputEncryptionKMSKeyId;
return this;
}
public final Map getKmsEncryptionContext() {
if (kmsEncryptionContext instanceof SdkAutoConstructMap) {
return null;
}
return kmsEncryptionContext;
}
public final void setKmsEncryptionContext(Map kmsEncryptionContext) {
this.kmsEncryptionContext = KMSEncryptionContextMapCopier.copy(kmsEncryptionContext);
}
@Override
public final Builder kmsEncryptionContext(Map kmsEncryptionContext) {
this.kmsEncryptionContext = KMSEncryptionContextMapCopier.copy(kmsEncryptionContext);
return this;
}
public final MedicalTranscriptionSetting.Builder getSettings() {
return settings != null ? settings.toBuilder() : null;
}
public final void setSettings(MedicalTranscriptionSetting.BuilderImpl settings) {
this.settings = settings != null ? settings.build() : null;
}
@Override
@Transient
public final Builder settings(MedicalTranscriptionSetting settings) {
this.settings = settings;
return this;
}
public final String getContentIdentificationType() {
return contentIdentificationType;
}
public final void setContentIdentificationType(String contentIdentificationType) {
this.contentIdentificationType = contentIdentificationType;
}
@Override
public final Builder contentIdentificationType(String contentIdentificationType) {
this.contentIdentificationType = contentIdentificationType;
return this;
}
@Override
public final Builder contentIdentificationType(MedicalContentIdentificationType contentIdentificationType) {
this.contentIdentificationType(contentIdentificationType == null ? null : contentIdentificationType.toString());
return this;
}
public final String getSpecialty() {
return specialty;
}
public final void setSpecialty(String specialty) {
this.specialty = specialty;
}
@Override
public final Builder specialty(String specialty) {
this.specialty = specialty;
return this;
}
@Override
public final Builder specialty(Specialty specialty) {
this.specialty(specialty == null ? null : specialty.toString());
return this;
}
public final String getType() {
return type;
}
public final void setType(String type) {
this.type = type;
}
@Override
public final Builder type(String type) {
this.type = type;
return this;
}
@Override
public final Builder type(Type type) {
this.type(type == null ? null : type.toString());
return this;
}
public final List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public StartMedicalTranscriptionJobRequest build() {
return new StartMedicalTranscriptionJobRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}