Class MedicalScribeConfigurationEvent

java.lang.Object
software.amazon.awssdk.services.transcribestreaming.model.MedicalScribeConfigurationEvent
All Implemented Interfaces:
Serializable, SdkPojo, MedicalScribeInputStream, ToCopyableBuilder<MedicalScribeConfigurationEvent.Builder,MedicalScribeConfigurationEvent>
Direct Known Subclasses:
DefaultConfigurationEvent
@Generated("software.amazon.awssdk:codegen") public class MedicalScribeConfigurationEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MedicalScribeConfigurationEvent.Builder,MedicalScribeConfigurationEvent>, MedicalScribeInputStream

Specify details to configure the streaming session, including channel definitions, encryption settings, post-stream analytics settings, resource access role ARN and vocabulary settings.

Whether you are starting a new session or resuming an existing session, your first event must be a MedicalScribeConfigurationEvent. If you are resuming a session, then this event must have the same configurations that you provided to start the session.

See Also:

  • Method Details

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

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

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

    • toBuilder

      public MedicalScribeConfigurationEvent.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<MedicalScribeConfigurationEvent.Builder,MedicalScribeConfigurationEvent>
      Returns:
      a builder for type T

    • builder

      public static MedicalScribeConfigurationEvent.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MedicalScribeConfigurationEvent.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)

    • copy

      public final MedicalScribeConfigurationEvent copy(Consumer<? super MedicalScribeConfigurationEvent.Builder> modifier)
      Description copied from interface: ToCopyableBuilder
      A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build(). This is useful for making small modifications to the existing object.
      Specified by:
      copy in interface ToCopyableBuilder<MedicalScribeConfigurationEvent.Builder,MedicalScribeConfigurationEvent>
      Parameters:
      modifier - A function that mutates this immutable object using the provided builder.
      Returns:
      A new copy of this object with the requested modifications.

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