Package software.amazon.awssdk.services.transcribestreaming.model

Class StartMedicalScribeStreamRequest

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.StartMedicalScribeStreamRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartMedicalScribeStreamRequest.Builder,StartMedicalScribeStreamRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartMedicalScribeStreamRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartMedicalScribeStreamRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
MedicalScribeLanguageCode	languageCode()	Specify the language code for your HealthScribe streaming session.
String	languageCodeAsString()	Specify the language code for your HealthScribe streaming session.
MedicalScribeMediaEncoding	mediaEncoding()	Specify the encoding used for the input audio.
String	mediaEncodingAsString()	Specify the encoding used for the input audio.
Integer	mediaSampleRateHertz()	Specify the sample rate of the input audio (in hertz).
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StartMedicalScribeStreamRequest.Builder>	serializableBuilderClass()
String	sessionId()	Specify an identifier for your streaming session (in UUID format).
StartMedicalScribeStreamRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

sessionId

public final String sessionId()

Specify an identifier for your streaming session (in UUID format). If you don't include a SessionId in your request, Amazon Web Services HealthScribe generates an ID and returns it in the response.

Returns:

Specify an identifier for your streaming session (in UUID format). If you don't include a SessionId in your request, Amazon Web Services HealthScribe generates an ID and returns it in the response.

languageCode

public final MedicalScribeLanguageCode languageCode()

Specify the language code for your HealthScribe streaming session.

If the service returns an enum value that is not available in the current SDK version, languageCode will return MedicalScribeLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

Specify the language code for your HealthScribe streaming session.

See Also:

MedicalScribeLanguageCode

languageCodeAsString

public final String languageCodeAsString()

Specify the language code for your HealthScribe streaming session.

If the service returns an enum value that is not available in the current SDK version, languageCode will return MedicalScribeLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

Specify the language code for your HealthScribe streaming session.

See Also:

MedicalScribeLanguageCode

mediaSampleRateHertz

public final Integer mediaSampleRateHertz()

Specify the sample rate of the input audio (in hertz). Amazon Web Services HealthScribe supports a range from 16,000 Hz to 48,000 Hz. The sample rate you specify must match that of your audio.

Returns:

Specify the sample rate of the input audio (in hertz). Amazon Web Services HealthScribe supports a range from 16,000 Hz to 48,000 Hz. The sample rate you specify must match that of your audio.

mediaEncoding

public final MedicalScribeMediaEncoding mediaEncoding()

Specify the encoding used for the input audio.

Supported formats are:

• FLAC

• OPUS-encoded audio in an Ogg container

• PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

For more information, see Media formats.

If the service returns an enum value that is not available in the current SDK version, mediaEncoding will return MedicalScribeMediaEncoding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaEncodingAsString().

Returns:

Specify the encoding used for the input audio.

Supported formats are:

• FLAC

• OPUS-encoded audio in an Ogg container

• PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

For more information, see Media formats.

See Also:

MedicalScribeMediaEncoding

mediaEncodingAsString

public final String mediaEncodingAsString()

Specify the encoding used for the input audio.

Supported formats are:

• FLAC

• OPUS-encoded audio in an Ogg container

• PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

For more information, see Media formats.

If the service returns an enum value that is not available in the current SDK version, mediaEncoding will return MedicalScribeMediaEncoding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mediaEncodingAsString().

Returns:

Specify the encoding used for the input audio.

Supported formats are:

• FLAC

• OPUS-encoded audio in an Ogg container

• PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

For more information, see Media formats.

See Also:

MedicalScribeMediaEncoding

toBuilder

public StartMedicalScribeStreamRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartMedicalScribeStreamRequest.Builder,StartMedicalScribeStreamRequest>

Specified by:

toBuilder in class TranscribeStreamingRequest

builder

public static StartMedicalScribeStreamRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartMedicalScribeStreamRequest.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo