Class SensitiveDataConfiguration

java.lang.Object
software.amazon.awssdk.services.textract.model.SensitiveDataConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SensitiveDataConfiguration.Builder,SensitiveDataConfiguration>

@Generated("software.amazon.awssdk:codegen") public final class SensitiveDataConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SensitiveDataConfiguration.Builder,SensitiveDataConfiguration>

Controls detection and redaction of sensitive data, such as personally identifiable information (PII), in the output.

See Also:
  • Method Details

    • detectionMode

      public final SensitiveDataDetectionMode detectionMode()

      The detection mode. Valid values:

      • DETECTION - Only detects sensitive data.

      • DETECTION_AND_REDACTION - Detects and redacts sensitive data in the output.

      • DISABLED - Does not detect sensitive data.

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

      Returns:
      The detection mode. Valid values:

      • DETECTION - Only detects sensitive data.

      • DETECTION_AND_REDACTION - Detects and redacts sensitive data in the output.

      • DISABLED - Does not detect sensitive data.

      See Also:
    • detectionModeAsString

      public final String detectionModeAsString()

      The detection mode. Valid values:

      • DETECTION - Only detects sensitive data.

      • DETECTION_AND_REDACTION - Detects and redacts sensitive data in the output.

      • DISABLED - Does not detect sensitive data.

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

      Returns:
      The detection mode. Valid values:

      • DETECTION - Only detects sensitive data.

      • DETECTION_AND_REDACTION - Detects and redacts sensitive data in the output.

      • DISABLED - Does not detect sensitive data.

      See Also:
    • piiEntitiesConfiguration

      public final PIIEntitiesConfiguration piiEntitiesConfiguration()

      The configuration that specifies which PII entity types to detect and how to mask them. If you omit it, Amazon Textract detects all PII entity types (ALL) and masks them with ENTITY_TYPE.

      Returns:
      The configuration that specifies which PII entity types to detect and how to mask them. If you omit it, Amazon Textract detects all PII entity types (ALL) and masks them with ENTITY_TYPE.
    • 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<SensitiveDataConfiguration.Builder,SensitiveDataConfiguration>
      Returns:
      a builder for type T
    • builder

      public static SensitiveDataConfiguration.Builder builder()
    • serializableBuilderClass

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