StartMedicalStreamTranscriptionRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.transcribestreaming.model.TranscribeStreamingRequest
    - - software.amazon.awssdk.services.transcribestreaming.model.StartMedicalStreamTranscriptionRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StartMedicalStreamTranscriptionRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static StartMedicalStreamTranscriptionRequest.Builder`	`builder()`
`MedicalContentIdentificationType`	`contentIdentificationType()` Set this field to `PHI` to identify personal health information in the transcription output.
`String`	`contentIdentificationTypeAsString()` Set this field to `PHI` to identify personal health information in the transcription output.
`Boolean`	`enableChannelIdentification()` When `true`, instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`LanguageCode`	`languageCode()` Indicates the source language used in the input audio stream.
`String`	`languageCodeAsString()` Indicates the source language used in the input audio stream.
`MediaEncoding`	`mediaEncoding()` The encoding used for the input audio.
`String`	`mediaEncodingAsString()` The encoding used for the input audio.
`Integer`	`mediaSampleRateHertz()` The sample rate of the input audio (in Hertz).
`Integer`	`numberOfChannels()` The number of channels that are in your audio stream.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StartMedicalStreamTranscriptionRequest.Builder>`	`serializableBuilderClass()`
`String`	`sessionId()` Optional.
`Boolean`	`showSpeakerLabel()` When `true`, enables speaker identification in your real-time stream.
`Specialty`	`specialty()` The medical specialty of the clinician or provider.
`String`	`specialtyAsString()` The medical specialty of the clinician or provider.
`StartMedicalStreamTranscriptionRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Type`	`type()` The type of input audio.
`String`	`typeAsString()` The type of input audio.
`String`	`vocabularyName()` The name of the medical custom vocabulary to use when processing the real-time stream.

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
  - languageCode
```
public final LanguageCode languageCode()
```
    Indicates the source language used in the input audio stream. For Amazon Transcribe Medical, this is US English (en-US).
    
    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:
    
    Indicates the source language used in the input audio stream. For Amazon Transcribe Medical, this is US English (en-US).
    
    See Also:
    
    LanguageCode
  - languageCodeAsString
```
public final String languageCodeAsString()
```
    Indicates the source language used in the input audio stream. For Amazon Transcribe Medical, this is US English (en-US).
    
    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:
    
    Indicates the source language used in the input audio stream. For Amazon Transcribe Medical, this is US English (en-US).
    
    See Also:
    
    LanguageCode
  - mediaSampleRateHertz
```
public final Integer mediaSampleRateHertz()
```
    The sample rate of the input audio (in Hertz). Amazon Transcribe medical supports a range from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.
    
    Returns:
    
    The sample rate of the input audio (in Hertz). Amazon Transcribe medical supports a range from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.
  - mediaEncoding
```
public final MediaEncoding mediaEncoding()
```
    The encoding used for the input audio.
    
    If the service returns an enum value that is not available in the current SDK version, mediaEncoding will return MediaEncoding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaEncodingAsString().
    
    Returns:
    
    The encoding used for the input audio.
    
    See Also:
    
    MediaEncoding
  - mediaEncodingAsString
```
public final String mediaEncodingAsString()
```
    The encoding used for the input audio.
    
    If the service returns an enum value that is not available in the current SDK version, mediaEncoding will return MediaEncoding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaEncodingAsString().
    
    Returns:
    
    The encoding used for the input audio.
    
    See Also:
    
    MediaEncoding
  - vocabularyName
```
public final String vocabularyName()
```
    The name of the medical custom vocabulary to use when processing the real-time stream.
    
    Returns:
    
    The name of the medical custom vocabulary to use when processing the real-time stream.
  - specialty
```
public final Specialty specialty()
```
    The medical specialty of the clinician or provider.
    
    If the service returns an enum value that is not available in the current SDK version, specialty will return Specialty.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from specialtyAsString().
    
    Returns:
    
    The medical specialty of the clinician or provider.
    
    See Also:
    
    Specialty
  - specialtyAsString
```
public final String specialtyAsString()
```
    The medical specialty of the clinician or provider.
    
    If the service returns an enum value that is not available in the current SDK version, specialty will return Specialty.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from specialtyAsString().
    
    Returns:
    
    The medical specialty of the clinician or provider.
    
    See Also:
    
    Specialty
  - type
```
public final Type type()
```
    The type of input audio. Choose DICTATION for a provider dictating patient notes. Choose CONVERSATION for a dialogue between a patient and one or more medical professionanls.
    
    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 input audio. Choose DICTATION for a provider dictating patient notes. Choose CONVERSATION for a dialogue between a patient and one or more medical professionanls.
    
    See Also:
    
    Type
  - typeAsString
```
public final String typeAsString()
```
    The type of input audio. Choose DICTATION for a provider dictating patient notes. Choose CONVERSATION for a dialogue between a patient and one or more medical professionanls.
    
    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 input audio. Choose DICTATION for a provider dictating patient notes. Choose CONVERSATION for a dialogue between a patient and one or more medical professionanls.
    
    See Also:
    
    Type
  - showSpeakerLabel
```
public final Boolean showSpeakerLabel()
```
    When true, enables speaker identification in your real-time stream.
    
    Returns:
    
    When true, enables speaker identification in your real-time stream.
  - sessionId
```
public final String sessionId()
```
    Optional. An identifier for the transcription session. If you don't provide a session ID, Amazon Transcribe generates one for you and returns it in the response.
    
    Returns:
    
    Optional. An identifier for the transcription session. If you don't provide a session ID, Amazon Transcribe generates one for you and returns it in the response.
  - enableChannelIdentification
```
public final Boolean enableChannelIdentification()
```
    When true, instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
    
    Amazon Transcribe Medical also produces a transcription of each item. An item includes the start time, end time, and any alternative transcriptions.
    
    You can't set both ShowSpeakerLabel and EnableChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
    
    Returns:
    
    When true, instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription.
    
    Amazon Transcribe Medical also produces a transcription of each item. An item includes the start time, end time, and any alternative transcriptions.
    
    You can't set both ShowSpeakerLabel and EnableChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
  - numberOfChannels
```
public final Integer numberOfChannels()
```
    The number of channels that are in your audio stream.
    
    Returns:
    
    The number of channels that are in your audio stream.
  - contentIdentificationType
```
public final MedicalContentIdentificationType contentIdentificationType()
```
    Set this field to PHI to identify personal health information 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:
    
    Set this field to PHI to identify personal health information in the transcription output.
    
    See Also:
    
    MedicalContentIdentificationType
  - contentIdentificationTypeAsString
```
public final String contentIdentificationTypeAsString()
```
    Set this field to PHI to identify personal health information 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:
    
    Set this field to PHI to identify personal health information in the transcription output.
    
    See Also:
    
    MedicalContentIdentificationType
  - toBuilder
```
public StartMedicalStreamTranscriptionRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartMedicalStreamTranscriptionRequest.Builder,StartMedicalStreamTranscriptionRequest>
    
    Specified by:
    
    toBuilder in class TranscribeStreamingRequest
  - builder
```
public static StartMedicalStreamTranscriptionRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StartMedicalStreamTranscriptionRequest.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 StartMedicalStreamTranscriptionRequest

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

languageCode

languageCodeAsString

mediaSampleRateHertz

mediaEncoding

mediaEncodingAsString

vocabularyName

specialty

specialtyAsString

type

typeAsString

showSpeakerLabel

sessionId

enableChannelIdentification

numberOfChannels

contentIdentificationType

contentIdentificationTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields