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

Interface MedicalScribeStreamDetails.Builder

All Superinterfaces:

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

Enclosing class:

MedicalScribeStreamDetails

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

Method Summary

Modifier and Type	Method	Description
MedicalScribeStreamDetails.Builder	channelDefinitions(Collection<MedicalScribeChannelDefinition> channelDefinitions)	The Channel Definitions of the HealthScribe streaming session.
MedicalScribeStreamDetails.Builder	channelDefinitions(Consumer<MedicalScribeChannelDefinition.Builder>... channelDefinitions)	The Channel Definitions of the HealthScribe streaming session.
MedicalScribeStreamDetails.Builder	channelDefinitions(MedicalScribeChannelDefinition... channelDefinitions)	The Channel Definitions of the HealthScribe streaming session.
default MedicalScribeStreamDetails.Builder	encryptionSettings(Consumer<MedicalScribeEncryptionSettings.Builder> encryptionSettings)	The Encryption Settings of the HealthScribe streaming session.
MedicalScribeStreamDetails.Builder	encryptionSettings(MedicalScribeEncryptionSettings encryptionSettings)	The Encryption Settings of the HealthScribe streaming session.
MedicalScribeStreamDetails.Builder	languageCode(String languageCode)	The Language Code of the HealthScribe streaming session.
MedicalScribeStreamDetails.Builder	languageCode(MedicalScribeLanguageCode languageCode)	The Language Code of the HealthScribe streaming session.
MedicalScribeStreamDetails.Builder	mediaEncoding(String mediaEncoding)	The Media Encoding of the HealthScribe streaming session.
MedicalScribeStreamDetails.Builder	mediaEncoding(MedicalScribeMediaEncoding mediaEncoding)	The Media Encoding of the HealthScribe streaming session.
MedicalScribeStreamDetails.Builder	mediaSampleRateHertz(Integer mediaSampleRateHertz)	The sample rate (in hertz) of the HealthScribe streaming session.
MedicalScribeStreamDetails.Builder	medicalScribeContextProvided(Boolean medicalScribeContextProvided)	Indicates whether the MedicalScribeContext object was provided when the stream was started.
default MedicalScribeStreamDetails.Builder	postStreamAnalyticsResult(Consumer<MedicalScribePostStreamAnalyticsResult.Builder> postStreamAnalyticsResult)	The result of post-stream analytics for the HealthScribe streaming session.
MedicalScribeStreamDetails.Builder	postStreamAnalyticsResult(MedicalScribePostStreamAnalyticsResult postStreamAnalyticsResult)	The result of post-stream analytics for the HealthScribe streaming session.
default MedicalScribeStreamDetails.Builder	postStreamAnalyticsSettings(Consumer<MedicalScribePostStreamAnalyticsSettings.Builder> postStreamAnalyticsSettings)	The post-stream analytics settings of the HealthScribe streaming session.
MedicalScribeStreamDetails.Builder	postStreamAnalyticsSettings(MedicalScribePostStreamAnalyticsSettings postStreamAnalyticsSettings)	The post-stream analytics settings of the HealthScribe streaming session.
MedicalScribeStreamDetails.Builder	resourceAccessRoleArn(String resourceAccessRoleArn)	The Amazon Resource Name (ARN) of the role used in the HealthScribe streaming session.
MedicalScribeStreamDetails.Builder	sessionId(String sessionId)	The identifier of the HealthScribe streaming session.
MedicalScribeStreamDetails.Builder	streamCreatedAt(Instant streamCreatedAt)	The date and time when the HealthScribe streaming session was created.
MedicalScribeStreamDetails.Builder	streamEndedAt(Instant streamEndedAt)	The date and time when the HealthScribe streaming session was ended.
MedicalScribeStreamDetails.Builder	streamStatus(String streamStatus)	The streaming status of the HealthScribe streaming session.
MedicalScribeStreamDetails.Builder	streamStatus(MedicalScribeStreamStatus streamStatus)	The streaming status of the HealthScribe streaming session.
MedicalScribeStreamDetails.Builder	vocabularyFilterMethod(String vocabularyFilterMethod)	The method of the vocabulary filter for the HealthScribe streaming session.
MedicalScribeStreamDetails.Builder	vocabularyFilterMethod(MedicalScribeVocabularyFilterMethod vocabularyFilterMethod)	The method of the vocabulary filter for the HealthScribe streaming session.
MedicalScribeStreamDetails.Builder	vocabularyFilterName(String vocabularyFilterName)	The name of the vocabulary filter used for the HealthScribe streaming session .
MedicalScribeStreamDetails.Builder	vocabularyName(String vocabularyName)	The vocabulary name of the HealthScribe 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

sessionId

MedicalScribeStreamDetails.Builder sessionId(String sessionId)

The identifier of the HealthScribe streaming session.

Parameters:

sessionId - The identifier of the HealthScribe streaming session.

Returns:

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

streamCreatedAt

MedicalScribeStreamDetails.Builder streamCreatedAt(Instant streamCreatedAt)

The date and time when the HealthScribe streaming session was created.

Parameters:

streamCreatedAt - The date and time when the HealthScribe streaming session was created.

Returns:

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

streamEndedAt

MedicalScribeStreamDetails.Builder streamEndedAt(Instant streamEndedAt)

The date and time when the HealthScribe streaming session was ended.

Parameters:

streamEndedAt - The date and time when the HealthScribe streaming session was ended.

Returns:

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

languageCode

MedicalScribeStreamDetails.Builder languageCode(String languageCode)

The Language Code of the HealthScribe streaming session.

Parameters:

languageCode - The Language Code of the HealthScribe streaming session.

Returns:

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

See Also:

• MedicalScribeLanguageCode
• MedicalScribeLanguageCode

languageCode

MedicalScribeStreamDetails.Builder languageCode(MedicalScribeLanguageCode languageCode)

The Language Code of the HealthScribe streaming session.

Parameters:

languageCode - The Language Code of the HealthScribe streaming session.

Returns:

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

See Also:

• MedicalScribeLanguageCode
• MedicalScribeLanguageCode

mediaSampleRateHertz

MedicalScribeStreamDetails.Builder mediaSampleRateHertz(Integer mediaSampleRateHertz)

The sample rate (in hertz) of the HealthScribe streaming session.

Parameters:

mediaSampleRateHertz - The sample rate (in hertz) of the HealthScribe streaming session.

Returns:

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

mediaEncoding

MedicalScribeStreamDetails.Builder mediaEncoding(String mediaEncoding)

The Media Encoding of the HealthScribe streaming session.

Parameters:

mediaEncoding - The Media Encoding of the HealthScribe streaming session.

Returns:

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

See Also:

• MedicalScribeMediaEncoding
• MedicalScribeMediaEncoding

mediaEncoding

MedicalScribeStreamDetails.Builder mediaEncoding(MedicalScribeMediaEncoding mediaEncoding)

The Media Encoding of the HealthScribe streaming session.

Parameters:

mediaEncoding - The Media Encoding of the HealthScribe streaming session.

Returns:

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

See Also:

• MedicalScribeMediaEncoding
• MedicalScribeMediaEncoding

vocabularyName

MedicalScribeStreamDetails.Builder vocabularyName(String vocabularyName)

The vocabulary name of the HealthScribe streaming session.

Parameters:

vocabularyName - The vocabulary name of the HealthScribe streaming session.

Returns:

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

vocabularyFilterName

MedicalScribeStreamDetails.Builder vocabularyFilterName(String vocabularyFilterName)

The name of the vocabulary filter used for the HealthScribe streaming session .

Parameters:

vocabularyFilterName - The name of the vocabulary filter used for the HealthScribe streaming session .

Returns:

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

vocabularyFilterMethod

MedicalScribeStreamDetails.Builder vocabularyFilterMethod(String vocabularyFilterMethod)

The method of the vocabulary filter for the HealthScribe streaming session.

Parameters:

vocabularyFilterMethod - The method of the vocabulary filter for the HealthScribe streaming session.

Returns:

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

See Also:

• MedicalScribeVocabularyFilterMethod
• MedicalScribeVocabularyFilterMethod

vocabularyFilterMethod

MedicalScribeStreamDetails.Builder vocabularyFilterMethod(MedicalScribeVocabularyFilterMethod vocabularyFilterMethod)

The method of the vocabulary filter for the HealthScribe streaming session.

Parameters:

vocabularyFilterMethod - The method of the vocabulary filter for the HealthScribe streaming session.

Returns:

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

See Also:

• MedicalScribeVocabularyFilterMethod
• MedicalScribeVocabularyFilterMethod

resourceAccessRoleArn

MedicalScribeStreamDetails.Builder resourceAccessRoleArn(String resourceAccessRoleArn)

The Amazon Resource Name (ARN) of the role used in the HealthScribe streaming session.

Parameters:

resourceAccessRoleArn - The Amazon Resource Name (ARN) of the role used in the HealthScribe streaming session.

Returns:

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

channelDefinitions

MedicalScribeStreamDetails.Builder channelDefinitions(Collection<MedicalScribeChannelDefinition> channelDefinitions)

The Channel Definitions of the HealthScribe streaming session.

Parameters:

channelDefinitions - The Channel Definitions of the HealthScribe streaming session.

Returns:

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

channelDefinitions

MedicalScribeStreamDetails.Builder channelDefinitions(MedicalScribeChannelDefinition... channelDefinitions)

The Channel Definitions of the HealthScribe streaming session.

Parameters:

channelDefinitions - The Channel Definitions of the HealthScribe streaming session.

Returns:

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

channelDefinitions

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

The Channel Definitions of the HealthScribe streaming session.

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

MedicalScribeStreamDetails.Builder encryptionSettings(MedicalScribeEncryptionSettings encryptionSettings)

The Encryption Settings of the HealthScribe streaming session.

Parameters:

encryptionSettings - The Encryption Settings of the HealthScribe streaming session.

Returns:

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

encryptionSettings

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

The Encryption Settings of the HealthScribe 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)

streamStatus

MedicalScribeStreamDetails.Builder streamStatus(String streamStatus)

The streaming status of the HealthScribe streaming session.

Possible Values:

• IN_PROGRESS

• PAUSED

• FAILED

• COMPLETED

This status is specific to real-time streaming. A COMPLETED status doesn't mean that the post-stream analytics is complete. To get status of an analytics result, check the Status field for the analytics result within the MedicalScribePostStreamAnalyticsResult. For example, you can view the status of the ClinicalNoteGenerationResult.

Parameters:

streamStatus - The streaming status of the HealthScribe streaming session.

Possible Values:

• IN_PROGRESS

• PAUSED

• FAILED

• COMPLETED

This status is specific to real-time streaming. A COMPLETED status doesn't mean that the post-stream analytics is complete. To get status of an analytics result, check the Status field for the analytics result within the MedicalScribePostStreamAnalyticsResult. For example, you can view the status of the ClinicalNoteGenerationResult.

Returns:

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

See Also:

• MedicalScribeStreamStatus
• MedicalScribeStreamStatus

streamStatus

MedicalScribeStreamDetails.Builder streamStatus(MedicalScribeStreamStatus streamStatus)

The streaming status of the HealthScribe streaming session.

Possible Values:

• IN_PROGRESS

• PAUSED

• FAILED

• COMPLETED

This status is specific to real-time streaming. A COMPLETED status doesn't mean that the post-stream analytics is complete. To get status of an analytics result, check the Status field for the analytics result within the MedicalScribePostStreamAnalyticsResult. For example, you can view the status of the ClinicalNoteGenerationResult.

Parameters:

streamStatus - The streaming status of the HealthScribe streaming session.

Possible Values:

• IN_PROGRESS

• PAUSED

• FAILED

• COMPLETED

This status is specific to real-time streaming. A COMPLETED status doesn't mean that the post-stream analytics is complete. To get status of an analytics result, check the Status field for the analytics result within the MedicalScribePostStreamAnalyticsResult. For example, you can view the status of the ClinicalNoteGenerationResult.

Returns:

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

See Also:

• MedicalScribeStreamStatus
• MedicalScribeStreamStatus

postStreamAnalyticsSettings

MedicalScribeStreamDetails.Builder postStreamAnalyticsSettings(MedicalScribePostStreamAnalyticsSettings postStreamAnalyticsSettings)

The post-stream analytics settings of the HealthScribe streaming session.

Parameters:

postStreamAnalyticsSettings - The post-stream analytics settings of the HealthScribe streaming session.

Returns:

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

postStreamAnalyticsSettings

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

The post-stream analytics settings of the HealthScribe streaming session.

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)

postStreamAnalyticsResult

MedicalScribeStreamDetails.Builder postStreamAnalyticsResult(MedicalScribePostStreamAnalyticsResult postStreamAnalyticsResult)

The result of post-stream analytics for the HealthScribe streaming session.

Parameters:

postStreamAnalyticsResult - The result of post-stream analytics for the HealthScribe streaming session.

Returns:

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

postStreamAnalyticsResult

default MedicalScribeStreamDetails.Builder postStreamAnalyticsResult(Consumer<MedicalScribePostStreamAnalyticsResult.Builder> postStreamAnalyticsResult)

The result of post-stream analytics for the HealthScribe streaming session.

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

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

Parameters:

postStreamAnalyticsResult - a consumer that will call methods on MedicalScribePostStreamAnalyticsResult.Builder

Returns:

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

See Also:

• postStreamAnalyticsResult(MedicalScribePostStreamAnalyticsResult)

medicalScribeContextProvided

MedicalScribeStreamDetails.Builder medicalScribeContextProvided(Boolean medicalScribeContextProvided)

Indicates whether the MedicalScribeContext object was provided when the stream was started.

Parameters:

medicalScribeContextProvided - Indicates whether the MedicalScribeContext object was provided when the stream was started.

Returns:

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