Class SensitiveDataConfiguration
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<SensitiveDataConfiguration.Builder,SensitiveDataConfiguration>
Controls detection and redaction of sensitive data, such as personally identifiable information (PII), in the output.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()The detection mode.final StringThe detection mode.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final PIIEntitiesConfigurationThe configuration that specifies which PII entity types to detect and how to mask them.static Class<? extends SensitiveDataConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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,
detectionModewill returnSensitiveDataDetectionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdetectionModeAsString().- 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
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,
detectionModewill returnSensitiveDataDetectionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdetectionModeAsString().- 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
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 withENTITY_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 withENTITY_TYPE.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<SensitiveDataConfiguration.Builder,SensitiveDataConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-