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()
final Integer	channelId()	Specify the audio channel you want to define.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final MedicalScribeParticipantRole	participantRole()	Specify the participant that you want to flag.
final String	participantRoleAsString()	Specify the participant that you want to flag.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends MedicalScribeChannelDefinition.Builder>	serializableBuilderClass()
MedicalScribeChannelDefinition.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<MedicalScribeChannelDefinition.Builder,MedicalScribeChannelDefinition>

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.