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

Class MedicalScribeChannelDefinition

java.lang.Object

software.amazon.awssdk.services.transcribestreaming.model.MedicalScribeChannelDefinition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MedicalScribeChannelDefinition.Builder,MedicalScribeChannelDefinition>

@Generated("software.amazon.awssdk:codegen")
public final class MedicalScribeChannelDefinition
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MedicalScribeChannelDefinition.Builder,MedicalScribeChannelDefinition>

Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set the ChannelId of the first ChannelDefinition in the list to 0 (to indicate the first channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking).

If you don't specify a channel definition, HealthScribe will diarize the transcription and identify speaker roles for each speaker.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MedicalScribeChannelDefinition.Builder

Method Summary

Modifier and Type	Method	Description
static MedicalScribeChannelDefinition.Builder	builder()
Integer	channelId()	Specify the audio channel you want to define.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
MedicalScribeParticipantRole	participantRole()	Specify the participant that you want to flag.
String	participantRoleAsString()	Specify the participant that you want to flag.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends MedicalScribeChannelDefinition.Builder>	serializableBuilderClass()
MedicalScribeChannelDefinition.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

channelId

public final Integer channelId()

Specify the audio channel you want to define.

Returns:

Specify the audio channel you want to define.

participantRole

public final MedicalScribeParticipantRole participantRole()

Specify the participant that you want to flag. The allowed options are CLINICIAN and PATIENT.

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

Returns:

Specify the participant that you want to flag. The allowed options are CLINICIAN and PATIENT.

See Also:

MedicalScribeParticipantRole

participantRoleAsString

public final String participantRoleAsString()

Specify the participant that you want to flag. The allowed options are CLINICIAN and PATIENT.

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

Returns:

Specify the participant that you want to flag. The allowed options are CLINICIAN and PATIENT.

See Also:

MedicalScribeParticipantRole

toBuilder

public MedicalScribeChannelDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MedicalScribeChannelDefinition.Builder,MedicalScribeChannelDefinition>

builder

public static MedicalScribeChannelDefinition.Builder builder()

serializableBuilderClass

public static Class<? extends MedicalScribeChannelDefinition.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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