Class ContactLensRedactionConfiguration

java.lang.Object
software.amazon.awssdk.services.connect.model.ContactLensRedactionConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ContactLensRedactionConfiguration.Builder,ContactLensRedactionConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class ContactLensRedactionConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ContactLensRedactionConfiguration.Builder,ContactLensRedactionConfiguration>

The redaction configuration for conversational analytics transcripts.

See Also:

  • Method Details

    • behavior

      public final String behavior()

      Specifies whether redaction is enabled for sensitive data, such as personal information, in the conversational analytics output. Valid values:

      • Enable – Redaction is applied according to the other values in this object.

      • Disable – Redaction is not applied, and all other values in this object are ignored.

      Returns:
      Specifies whether redaction is enabled for sensitive data, such as personal information, in the conversational analytics output. Valid values:

      • Enable – Redaction is applied according to the other values in this object.

      • Disable – Redaction is not applied, and all other values in this object are ignored.

    • policy

      public final String policy()

      The redaction policy that determines which versions of the transcript are stored. Valid values:

      • None – No redaction is applied.

      • RedactedOnly – Only the redacted transcript is stored.

      • RedactedAndOriginal – Both the redacted and the original transcript are stored.

      Returns:
      The redaction policy that determines which versions of the transcript are stored. Valid values:

      • None – No redaction is applied.

      • RedactedOnly – Only the redacted transcript is stored.

      • RedactedAndOriginal – Both the redacted and the original transcript are stored.

    • hasEntities

      public final boolean hasEntities()
      For responses, this returns true if the service returned a value for the Entities 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.

    • entities

      public final List<String> entities()

      The entity types to redact from the transcript (for example, NAME, EMAIL, ADDRESS).

      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 hasEntities() method.

      Returns:
      The entity types to redact from the transcript (for example, NAME, EMAIL, ADDRESS).

    • maskMode

      public final String maskMode()

      How sensitive information is masked in the transcript. Valid values:

      • PII – All redacted entities are replaced with the [PII] string.

      • EntityType – All redacted entities are replaced with the label of the entity. For example, when the EMAIL entity is configured for redaction, emails in the transcript are replaced with the [EMAIL] string.

      Returns:
      How sensitive information is masked in the transcript. Valid values:

      • PII – All redacted entities are replaced with the [PII] string.

      • EntityType – All redacted entities are replaced with the label of the entity. For example, when the EMAIL entity is configured for redaction, emails in the transcript are replaced with the [EMAIL] string.

    • toBuilder

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

    • builder

      public static ContactLensRedactionConfiguration.Builder builder()

    • serializableBuilderClass

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

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