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

Class MedicalScribeConfigurationEvent

    • Method Detail

      • vocabularyName

        public final String vocabularyName()

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

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

      • vocabularyFilterName

        public final 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.

        Returns:
        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.

      • vocabularyFilterMethod

        public final 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.

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

        Returns:
        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.

        See Also:
        MedicalScribeVocabularyFilterMethod

      • vocabularyFilterMethodAsString

        public final String vocabularyFilterMethodAsString()

        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.

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

        Returns:
        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.

        See Also:
        MedicalScribeVocabularyFilterMethod

      • resourceAccessRoleArn

        public final 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.

        Returns:
        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.

      • 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 the isEmpty() 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

        public final List<MedicalScribeChannelDefinition> channelDefinitions()

        Specify which speaker is on which audio channel.

        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:
        Specify which speaker is on which audio channel.

      • encryptionSettings

        public final MedicalScribeEncryptionSettings encryptionSettings()

        Specify the encryption settings for your streaming session.

        Returns:
        Specify the encryption settings for your streaming session.

      • postStreamAnalyticsSettings

        public final MedicalScribePostStreamAnalyticsSettings postStreamAnalyticsSettings()

        Specify settings for post-stream analytics.

        Returns:
        Specify settings for post-stream analytics.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

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