Class RedactionConfiguration

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

The redaction configuration for conversational analytics.

See Also:

  • Method Details

    • behavior

      public final Behavior behavior()

      Controls whether redaction is applied to the analytics output. Valid values: Enable | Disable.

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

      Returns:
      Controls whether redaction is applied to the analytics output. Valid values: Enable | Disable.
      See Also:

    • behaviorAsString

      public final String behaviorAsString()

      Controls whether redaction is applied to the analytics output. Valid values: Enable | Disable.

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

      Returns:
      Controls whether redaction is applied to the analytics output. Valid values: Enable | Disable.
      See Also:

    • policy

      public final Policy policy()

      The redaction output policy that determines which versions of the transcript are stored. Valid values: None | RedactedOnly | RedactedAndOriginal.

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

      Returns:
      The redaction output policy that determines which versions of the transcript are stored. Valid values: None | RedactedOnly | RedactedAndOriginal.
      See Also:

    • policyAsString

      public final String policyAsString()

      The redaction output policy that determines which versions of the transcript are stored. Valid values: None | RedactedOnly | RedactedAndOriginal.

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

      Returns:
      The redaction output policy that determines which versions of the transcript are stored. Valid values: None | RedactedOnly | RedactedAndOriginal.
      See Also:

    • 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 list of PII entity types to redact from the transcript (for example, NAME, ADDRESS, CREDIT_DEBIT_NUMBER).

      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 list of PII entity types to redact from the transcript (for example, NAME, ADDRESS, CREDIT_DEBIT_NUMBER).

    • maskMode

      public final MaskMode maskMode()

      The masking mode that determines how redacted content is replaced in the output. Valid values: PII (replaces with the literal string [PII]) | EntityType (replaces with the entity type name, for example [NAME]).

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

      Returns:
      The masking mode that determines how redacted content is replaced in the output. Valid values: PII (replaces with the literal string [PII]) | EntityType (replaces with the entity type name, for example [NAME]).
      See Also:

    • maskModeAsString

      public final String maskModeAsString()

      The masking mode that determines how redacted content is replaced in the output. Valid values: PII (replaces with the literal string [PII]) | EntityType (replaces with the entity type name, for example [NAME]).

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

      Returns:
      The masking mode that determines how redacted content is replaced in the output. Valid values: PII (replaces with the literal string [PII]) | EntityType (replaces with the entity type name, for example [NAME]).
      See Also:

    • toBuilder

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

    • builder

      public static RedactionConfiguration.Builder builder()

    • serializableBuilderClass

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