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

Interface MedicalScribeConfigurationEvent.Builder

All Superinterfaces:

Buildable, CopyableBuilder<MedicalScribeConfigurationEvent.Builder,MedicalScribeConfigurationEvent>, SdkBuilder<MedicalScribeConfigurationEvent.Builder,MedicalScribeConfigurationEvent>, SdkPojo

All Known Subinterfaces:

DefaultConfigurationEvent.Builder

All Known Implementing Classes:

MedicalScribeConfigurationEvent.BuilderImpl

Enclosing class:

MedicalScribeConfigurationEvent

@Mutable
@NotThreadSafe
public static interface MedicalScribeConfigurationEvent.Builder
extends SdkPojo, CopyableBuilder<MedicalScribeConfigurationEvent.Builder,MedicalScribeConfigurationEvent>

Method Summary

Modifier and Type	Method	Description
MedicalScribeConfigurationEvent.Builder	channelDefinitions(Collection<MedicalScribeChannelDefinition> channelDefinitions)	Specify which speaker is on which audio channel.
MedicalScribeConfigurationEvent.Builder	channelDefinitions(Consumer<MedicalScribeChannelDefinition.Builder>... channelDefinitions)	Specify which speaker is on which audio channel.
MedicalScribeConfigurationEvent.Builder	channelDefinitions(MedicalScribeChannelDefinition... channelDefinitions)	Specify which speaker is on which audio channel.
default MedicalScribeConfigurationEvent.Builder	encryptionSettings(Consumer<MedicalScribeEncryptionSettings.Builder> encryptionSettings)	Specify the encryption settings for your streaming session.
MedicalScribeConfigurationEvent.Builder	encryptionSettings(MedicalScribeEncryptionSettings encryptionSettings)	Specify the encryption settings for your streaming session.
default MedicalScribeConfigurationEvent.Builder	medicalScribeContext(Consumer<MedicalScribeContext.Builder> medicalScribeContext)	The MedicalScribeContext object that contains contextual information used to generate customized clinical notes.
MedicalScribeConfigurationEvent.Builder	medicalScribeContext(MedicalScribeContext medicalScribeContext)	The MedicalScribeContext object that contains contextual information used to generate customized clinical notes.
default MedicalScribeConfigurationEvent.Builder	postStreamAnalyticsSettings(Consumer<MedicalScribePostStreamAnalyticsSettings.Builder> postStreamAnalyticsSettings)	Specify settings for post-stream analytics.
MedicalScribeConfigurationEvent.Builder	postStreamAnalyticsSettings(MedicalScribePostStreamAnalyticsSettings postStreamAnalyticsSettings)	Specify settings for post-stream analytics.
MedicalScribeConfigurationEvent.Builder	resourceAccessRoleArn(String resourceAccessRoleArn)	The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 output bucket you specified, and use your KMS key if supplied.
MedicalScribeConfigurationEvent.Builder	vocabularyFilterMethod(String vocabularyFilterMethod)	Specify how you want your custom vocabulary filter applied to the streaming session.
MedicalScribeConfigurationEvent.Builder	vocabularyFilterMethod(MedicalScribeVocabularyFilterMethod vocabularyFilterMethod)	Specify how you want your custom vocabulary filter applied to the streaming session.
MedicalScribeConfigurationEvent.Builder	vocabularyFilterName(String vocabularyFilterName)	Specify the name of the custom vocabulary filter you want to include in your streaming session.
MedicalScribeConfigurationEvent.Builder	vocabularyName(String vocabularyName)	Specify the name of the custom vocabulary you want to use for your streaming session.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

vocabularyName

MedicalScribeConfigurationEvent.Builder vocabularyName(String vocabularyName)

Specify the name of the custom vocabulary you want to use for your streaming session. Custom vocabulary names are case-sensitive.

Parameters:

vocabularyName - Specify the name of the custom vocabulary you want to use for your streaming session. Custom vocabulary names are case-sensitive.

Returns:

Returns a reference to this object so that method calls can be chained together.

vocabularyFilterName

MedicalScribeConfigurationEvent.Builder vocabularyFilterName(String vocabularyFilterName)

Specify the name of the custom vocabulary filter you want to include in your streaming session. Custom vocabulary filter names are case-sensitive.

If you include VocabularyFilterName in the MedicalScribeConfigurationEvent, you must also include VocabularyFilterMethod.

Parameters:

vocabularyFilterName - Specify the name of the custom vocabulary filter you want to include in your streaming session. Custom vocabulary filter names are case-sensitive.

If you include VocabularyFilterName in the MedicalScribeConfigurationEvent, you must also include VocabularyFilterMethod.

Returns:

Returns a reference to this object so that method calls can be chained together.

vocabularyFilterMethod

MedicalScribeConfigurationEvent.Builder vocabularyFilterMethod(String vocabularyFilterMethod)

Specify how you want your custom vocabulary filter applied to the streaming session.

To replace words with ***, specify mask.

To delete words, specify remove.

To flag words without changing them, specify tag.

Parameters:

vocabularyFilterMethod - Specify how you want your custom vocabulary filter applied to the streaming session.

To replace words with ***, specify mask.

To delete words, specify remove.

To flag words without changing them, specify tag.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• MedicalScribeVocabularyFilterMethod
• MedicalScribeVocabularyFilterMethod

vocabularyFilterMethod

MedicalScribeConfigurationEvent.Builder vocabularyFilterMethod(MedicalScribeVocabularyFilterMethod vocabularyFilterMethod)

Specify how you want your custom vocabulary filter applied to the streaming session.

To replace words with ***, specify mask.

To delete words, specify remove.

To flag words without changing them, specify tag.

Parameters:

vocabularyFilterMethod - Specify how you want your custom vocabulary filter applied to the streaming session.

To replace words with ***, specify mask.

To delete words, specify remove.

To flag words without changing them, specify tag.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• MedicalScribeVocabularyFilterMethod
• MedicalScribeVocabularyFilterMethod

resourceAccessRoleArn

MedicalScribeConfigurationEvent.Builder resourceAccessRoleArn(String resourceAccessRoleArn)

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 output bucket you specified, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions, your request fails.

IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

For more information, see Amazon Web Services HealthScribe.

Parameters:

resourceAccessRoleArn - The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 output bucket you specified, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions, your request fails.

IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

For more information, see Amazon Web Services HealthScribe.

Returns:

Returns a reference to this object so that method calls can be chained together.

channelDefinitions

MedicalScribeConfigurationEvent.Builder channelDefinitions(Collection<MedicalScribeChannelDefinition> channelDefinitions)

Specify which speaker is on which audio channel.

Parameters:

channelDefinitions - Specify which speaker is on which audio channel.

Returns:

Returns a reference to this object so that method calls can be chained together.

channelDefinitions

MedicalScribeConfigurationEvent.Builder channelDefinitions(MedicalScribeChannelDefinition... channelDefinitions)

Specify which speaker is on which audio channel.

Parameters:

channelDefinitions - Specify which speaker is on which audio channel.

Returns:

Returns a reference to this object so that method calls can be chained together.

channelDefinitions

MedicalScribeConfigurationEvent.Builder channelDefinitions(Consumer<MedicalScribeChannelDefinition.Builder>... channelDefinitions)

Specify which speaker is on which audio channel.

This is a convenience method that creates an instance of the MedicalScribeChannelDefinition.Builder avoiding the need to create one manually via MedicalScribeChannelDefinition.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to channelDefinitions(List<MedicalScribeChannelDefinition>).

Parameters:

channelDefinitions - a consumer that will call methods on MedicalScribeChannelDefinition.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• channelDefinitions(java.util.Collection<MedicalScribeChannelDefinition>)

encryptionSettings

MedicalScribeConfigurationEvent.Builder encryptionSettings(MedicalScribeEncryptionSettings encryptionSettings)

Specify the encryption settings for your streaming session.

Parameters:

encryptionSettings - Specify the encryption settings for your streaming session.

Returns:

Returns a reference to this object so that method calls can be chained together.

encryptionSettings

default MedicalScribeConfigurationEvent.Builder encryptionSettings(Consumer<MedicalScribeEncryptionSettings.Builder> encryptionSettings)

Specify the encryption settings for your streaming session.

This is a convenience method that creates an instance of the MedicalScribeEncryptionSettings.Builder avoiding the need to create one manually via MedicalScribeEncryptionSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionSettings(MedicalScribeEncryptionSettings).

Parameters:

encryptionSettings - a consumer that will call methods on MedicalScribeEncryptionSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• encryptionSettings(MedicalScribeEncryptionSettings)

postStreamAnalyticsSettings

MedicalScribeConfigurationEvent.Builder postStreamAnalyticsSettings(MedicalScribePostStreamAnalyticsSettings postStreamAnalyticsSettings)

Specify settings for post-stream analytics.

Parameters:

postStreamAnalyticsSettings - Specify settings for post-stream analytics.

Returns:

Returns a reference to this object so that method calls can be chained together.

postStreamAnalyticsSettings

default MedicalScribeConfigurationEvent.Builder postStreamAnalyticsSettings(Consumer<MedicalScribePostStreamAnalyticsSettings.Builder> postStreamAnalyticsSettings)

Specify settings for post-stream analytics.

This is a convenience method that creates an instance of the MedicalScribePostStreamAnalyticsSettings.Builder avoiding the need to create one manually via MedicalScribePostStreamAnalyticsSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to postStreamAnalyticsSettings(MedicalScribePostStreamAnalyticsSettings).

Parameters:

postStreamAnalyticsSettings - a consumer that will call methods on MedicalScribePostStreamAnalyticsSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• postStreamAnalyticsSettings(MedicalScribePostStreamAnalyticsSettings)

medicalScribeContext

MedicalScribeConfigurationEvent.Builder medicalScribeContext(MedicalScribeContext medicalScribeContext)

The MedicalScribeContext object that contains contextual information used to generate customized clinical notes.

Parameters:

medicalScribeContext - The MedicalScribeContext object that contains contextual information used to generate customized clinical notes.

Returns:

Returns a reference to this object so that method calls can be chained together.

medicalScribeContext

default MedicalScribeConfigurationEvent.Builder medicalScribeContext(Consumer<MedicalScribeContext.Builder> medicalScribeContext)

The MedicalScribeContext object that contains contextual information used to generate customized clinical notes.

This is a convenience method that creates an instance of the MedicalScribeContext.Builder avoiding the need to create one manually via MedicalScribeContext.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to medicalScribeContext(MedicalScribeContext).

Parameters:

medicalScribeContext - a consumer that will call methods on MedicalScribeContext.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• medicalScribeContext(MedicalScribeContext)