Class PIIEntitiesConfiguration
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<PIIEntitiesConfiguration.Builder,PIIEntitiesConfiguration>
Specifies which personally identifiable information (PII) entity types to detect and how to mask them.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()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 booleanFor responses, this returns true if the service returned a value for the PiiEntityTypes property.final List<PIIEntityType> The list of PII entity types to detect.The list of PII entity types to detect.final PIIRedactionMaskModeHow detected PII is masked in the redacted output.final StringHow detected PII is masked in the redacted output.static Class<? extends PIIEntitiesConfiguration.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
-
piiEntityTypes
The list of PII entity types to detect. Each type can appear only once.
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
hasPiiEntityTypes()method.- Returns:
- The list of PII entity types to detect. Each type can appear only once.
-
hasPiiEntityTypes
public final boolean hasPiiEntityTypes()For responses, this returns true if the service returned a value for the PiiEntityTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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. -
piiEntityTypesAsStrings
The list of PII entity types to detect. Each type can appear only once.
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
hasPiiEntityTypes()method.- Returns:
- The list of PII entity types to detect. Each type can appear only once.
-
redactionMaskMode
How detected PII is masked in the redacted output.
If the service returns an enum value that is not available in the current SDK version,
redactionMaskModewill returnPIIRedactionMaskMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromredactionMaskModeAsString().- Returns:
- How detected PII is masked in the redacted output.
- See Also:
-
redactionMaskModeAsString
How detected PII is masked in the redacted output.
If the service returns an enum value that is not available in the current SDK version,
redactionMaskModewill returnPIIRedactionMaskMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromredactionMaskModeAsString().- Returns:
- How detected PII is masked in the redacted output.
- See Also:
-
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<PIIEntitiesConfiguration.Builder,PIIEntitiesConfiguration> - 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.
-