com.amazonaws.services.comprehend.model

Class RedactionConfig

java.lang.Object

com.amazonaws.services.comprehend.model.RedactionConfig

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RedactionConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

Provides configuration parameters for PII entity redaction.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RedactionConfig()

Method Summary

Modifier and Type	Method and Description
RedactionConfig	clone()
boolean	equals(Object obj)
String	getMaskCharacter() A character that replaces each character in the redacted PII entity.
String	getMaskMode() Specifies whether the PII entity is redacted with the mask character or the entity type.
List<String>	getPiiEntityTypes() An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setMaskCharacter(String maskCharacter) A character that replaces each character in the redacted PII entity.
void	setMaskMode(String maskMode) Specifies whether the PII entity is redacted with the mask character or the entity type.
void	setPiiEntityTypes(Collection<String> piiEntityTypes) An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.
String	toString() Returns a string representation of this object.
RedactionConfig	withMaskCharacter(String maskCharacter) A character that replaces each character in the redacted PII entity.
RedactionConfig	withMaskMode(PiiEntitiesDetectionMaskMode maskMode) Specifies whether the PII entity is redacted with the mask character or the entity type.
RedactionConfig	withMaskMode(String maskMode) Specifies whether the PII entity is redacted with the mask character or the entity type.
RedactionConfig	withPiiEntityTypes(Collection<String> piiEntityTypes) An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.
RedactionConfig	withPiiEntityTypes(PiiEntityType... piiEntityTypes) An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.
RedactionConfig	withPiiEntityTypes(String... piiEntityTypes) An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RedactionConfig

public RedactionConfig()

Method Detail

getPiiEntityTypes

public List<String> getPiiEntityTypes()

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

Returns:

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

See Also:

PiiEntityType

setPiiEntityTypes

public void setPiiEntityTypes(Collection<String> piiEntityTypes)

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

Parameters:

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

See Also:

PiiEntityType

withPiiEntityTypes

public RedactionConfig withPiiEntityTypes(String... piiEntityTypes)

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

NOTE: This method appends the values to the existing list (if any). Use setPiiEntityTypes(java.util.Collection) or withPiiEntityTypes(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PiiEntityType

withPiiEntityTypes

public RedactionConfig withPiiEntityTypes(Collection<String> piiEntityTypes)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PiiEntityType

withPiiEntityTypes

public RedactionConfig withPiiEntityTypes(PiiEntityType... piiEntityTypes)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PiiEntityType

setMaskMode

public void setMaskMode(String maskMode)

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

Parameters:

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

See Also:

PiiEntitiesDetectionMaskMode

getMaskMode

public String getMaskMode()

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

Returns:

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

See Also:

PiiEntitiesDetectionMaskMode

withMaskMode

public RedactionConfig withMaskMode(String maskMode)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PiiEntitiesDetectionMaskMode

withMaskMode

public RedactionConfig withMaskMode(PiiEntitiesDetectionMaskMode maskMode)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PiiEntitiesDetectionMaskMode

setMaskCharacter

public void setMaskCharacter(String maskCharacter)

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

Parameters:

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

getMaskCharacter

public String getMaskCharacter()

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

Returns:

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

withMaskCharacter

public RedactionConfig withMaskCharacter(String maskCharacter)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RedactionConfig clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.