Package software.amazon.awssdk.services.comprehend.model

Class RedactionConfig

java.lang.Object

software.amazon.awssdk.services.comprehend.model.RedactionConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RedactionConfig.Builder,RedactionConfig>

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

Provides configuration parameters for PII entity redaction.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RedactionConfig.Builder

Method Summary

Modifier and Type	Method	Description
static RedactionConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPiiEntityTypes()	For responses, this returns true if the service returned a value for the PiiEntityTypes property.
String	maskCharacter()	A character that replaces each character in the redacted PII entity.
PiiEntitiesDetectionMaskMode	maskMode()	Specifies whether the PII entity is redacted with the mask character or the entity type.
String	maskModeAsString()	Specifies whether the PII entity is redacted with the mask character or the entity type.
List<PiiEntityType>	piiEntityTypes()	An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.
List<String>	piiEntityTypesAsStrings()	An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.
List<SdkField<?>>	sdkFields()
static Class<? extends RedactionConfig.Builder>	serializableBuilderClass()
RedactionConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

piiEntityTypes

public final List<PiiEntityType> piiEntityTypes()

An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.

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:

An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.

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

piiEntityTypesAsStrings

public final List<String> piiEntityTypesAsStrings()

An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.

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:

An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.

maskMode

public final PiiEntitiesDetectionMaskMode maskMode()

Specifies whether the PII entity is redacted with the mask character or the entity type.

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

Returns:

Specifies whether the PII entity is redacted with the mask character or the entity type.

See Also:

PiiEntitiesDetectionMaskMode

maskModeAsString

public final String maskModeAsString()

Specifies whether the PII entity is redacted with the mask character or the entity type.

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

Returns:

Specifies whether the PII entity is redacted with the mask character or the entity type.

See Also:

PiiEntitiesDetectionMaskMode

maskCharacter

public final String maskCharacter()

A character that replaces each character in the redacted PII entity.

Returns:

A character that replaces each character in the redacted PII entity.

toBuilder

public RedactionConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RedactionConfig.Builder,RedactionConfig>

builder

public static RedactionConfig.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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