Class MedicalScribeStreamDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MedicalScribeStreamDetails.Builder,
MedicalScribeStreamDetails>
Contains details about a Amazon Web Services HealthScribe streaming session.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The Channel Definitions of the HealthScribe streaming session.The Encryption Settings of the HealthScribe streaming session.final boolean
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 boolean
For responses, this returns true if the service returned a value for the ChannelDefinitions property.final int
hashCode()
The Language Code of the HealthScribe streaming session.final String
The Language Code of the HealthScribe streaming session.The Media Encoding of the HealthScribe streaming session.final String
The Media Encoding of the HealthScribe streaming session.final Integer
The sample rate (in hertz) of the HealthScribe streaming session.The result of post-stream analytics for the HealthScribe streaming session.The post-stream analytics settings of the HealthScribe streaming session.final String
The Amazon Resource Name (ARN) of the role used in the HealthScribe streaming session.static Class
<? extends MedicalScribeStreamDetails.Builder> final String
The identifier of the HealthScribe streaming session.final Instant
The date and time when the HealthScribe streaming session was created.final Instant
The date and time when the HealthScribe streaming session was ended.The streaming status of the HealthScribe streaming session.final String
The streaming status of the HealthScribe streaming session.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.The method of the vocabulary filter for the HealthScribe streaming session.final String
The method of the vocabulary filter for the HealthScribe streaming session.final String
The name of the vocabulary filter used for the HealthScribe streaming session .final String
The vocabulary name of the HealthScribe streaming session.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
sessionId
The identifier of the HealthScribe streaming session.
- Returns:
- The identifier of the HealthScribe streaming session.
-
streamCreatedAt
The date and time when the HealthScribe streaming session was created.
- Returns:
- The date and time when the HealthScribe streaming session was created.
-
streamEndedAt
The date and time when the HealthScribe streaming session was ended.
- Returns:
- The date and time when the HealthScribe streaming session was ended.
-
languageCode
The Language Code of the HealthScribe streaming session.
If the service returns an enum value that is not available in the current SDK version,
languageCode
will returnMedicalScribeLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- Returns:
- The Language Code of the HealthScribe streaming session.
- See Also:
-
languageCodeAsString
The Language Code of the HealthScribe streaming session.
If the service returns an enum value that is not available in the current SDK version,
languageCode
will returnMedicalScribeLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- Returns:
- The Language Code of the HealthScribe streaming session.
- See Also:
-
mediaSampleRateHertz
The sample rate (in hertz) of the HealthScribe streaming session.
- Returns:
- The sample rate (in hertz) of the HealthScribe streaming session.
-
mediaEncoding
The Media Encoding of the HealthScribe streaming session.
If the service returns an enum value that is not available in the current SDK version,
mediaEncoding
will returnMedicalScribeMediaEncoding.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommediaEncodingAsString()
.- Returns:
- The Media Encoding of the HealthScribe streaming session.
- See Also:
-
mediaEncodingAsString
The Media Encoding of the HealthScribe streaming session.
If the service returns an enum value that is not available in the current SDK version,
mediaEncoding
will returnMedicalScribeMediaEncoding.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommediaEncodingAsString()
.- Returns:
- The Media Encoding of the HealthScribe streaming session.
- See Also:
-
vocabularyName
The vocabulary name of the HealthScribe streaming session.
- Returns:
- The vocabulary name of the HealthScribe streaming session.
-
vocabularyFilterName
The name of the vocabulary filter used for the HealthScribe streaming session .
- Returns:
- The name of the vocabulary filter used for the HealthScribe streaming session .
-
vocabularyFilterMethod
The method of the vocabulary filter for the HealthScribe streaming session.
If the service returns an enum value that is not available in the current SDK version,
vocabularyFilterMethod
will returnMedicalScribeVocabularyFilterMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvocabularyFilterMethodAsString()
.- Returns:
- The method of the vocabulary filter for the HealthScribe streaming session.
- See Also:
-
vocabularyFilterMethodAsString
The method of the vocabulary filter for the HealthScribe streaming session.
If the service returns an enum value that is not available in the current SDK version,
vocabularyFilterMethod
will returnMedicalScribeVocabularyFilterMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvocabularyFilterMethodAsString()
.- Returns:
- The method of the vocabulary filter for the HealthScribe streaming session.
- See Also:
-
resourceAccessRoleArn
The Amazon Resource Name (ARN) of the role used in the HealthScribe streaming session.
- Returns:
- The Amazon Resource Name (ARN) of the role used in the HealthScribe streaming session.
-
hasChannelDefinitions
public final boolean hasChannelDefinitions()For responses, this returns true if the service returned a value for the ChannelDefinitions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
channelDefinitions
The Channel Definitions of the HealthScribe streaming session.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasChannelDefinitions()
method.- Returns:
- The Channel Definitions of the HealthScribe streaming session.
-
encryptionSettings
The Encryption Settings of the HealthScribe streaming session.
- Returns:
- The Encryption Settings of the HealthScribe streaming session.
-
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 theStatus
field for the analytics result within theMedicalScribePostStreamAnalyticsResult
. For example, you can view the status of theClinicalNoteGenerationResult
.If the service returns an enum value that is not available in the current SDK version,
streamStatus
will returnMedicalScribeStreamStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstreamStatusAsString()
.- Returns:
- 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 theStatus
field for the analytics result within theMedicalScribePostStreamAnalyticsResult
. For example, you can view the status of theClinicalNoteGenerationResult
. -
- See Also:
-
-
streamStatusAsString
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 theStatus
field for the analytics result within theMedicalScribePostStreamAnalyticsResult
. For example, you can view the status of theClinicalNoteGenerationResult
.If the service returns an enum value that is not available in the current SDK version,
streamStatus
will returnMedicalScribeStreamStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstreamStatusAsString()
.- Returns:
- 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 theStatus
field for the analytics result within theMedicalScribePostStreamAnalyticsResult
. For example, you can view the status of theClinicalNoteGenerationResult
. -
- See Also:
-
-
postStreamAnalyticsSettings
The post-stream analytics settings of the HealthScribe streaming session.
- Returns:
- The post-stream analytics settings of the HealthScribe streaming session.
-
postStreamAnalyticsResult
The result of post-stream analytics for the HealthScribe streaming session.
- Returns:
- The result of post-stream analytics for the HealthScribe streaming session.
-
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 interfaceToCopyableBuilder<MedicalScribeStreamDetails.Builder,
MedicalScribeStreamDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-