com.amazonaws.services.comprehend.model

Class RedactionConfig

java.lang.Object

com.amazonaws.services.comprehend.model.RedactionConfig

All Implemented Interfaces:

java.io.Serializable

public class RedactionConfig
extends java.lang.Object
implements java.io.Serializable

Provides configuration parameters for PII entity redaction.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RedactionConfig()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getMaskCharacter() A character that replaces each character in the redacted PII entity.
java.lang.String	getMaskMode() Specifies whether the PII entity is redacted with the mask character or the entity type.
java.util.List<java.lang.String>	getPiiEntityTypes() An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.
int	hashCode()
void	setMaskCharacter(java.lang.String maskCharacter) A character that replaces each character in the redacted PII entity.
void	setMaskMode(PiiEntitiesDetectionMaskMode maskMode) Specifies whether the PII entity is redacted with the mask character or the entity type.
void	setMaskMode(java.lang.String maskMode) Specifies whether the PII entity is redacted with the mask character or the entity type.
void	setPiiEntityTypes(java.util.Collection<java.lang.String> piiEntityTypes) An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
RedactionConfig	withMaskCharacter(java.lang.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(java.lang.String maskMode) Specifies whether the PII entity is redacted with the mask character or the entity type.
RedactionConfig	withPiiEntityTypes(java.util.Collection<java.lang.String> piiEntityTypes) An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.
RedactionConfig	withPiiEntityTypes(java.lang.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 java.util.List<java.lang.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.

setPiiEntityTypes

public void setPiiEntityTypes(java.util.Collection<java.lang.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.

withPiiEntityTypes

public RedactionConfig withPiiEntityTypes(java.lang.String... piiEntityTypes)

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

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

Parameters:

piiEntityTypes -

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

Returns:

A reference to this updated object so that method calls can be chained together.

withPiiEntityTypes

public RedactionConfig withPiiEntityTypes(java.util.Collection<java.lang.String> piiEntityTypes)

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

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

Parameters:

piiEntityTypes -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getMaskMode

public java.lang.String getMaskMode()

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

Constraints:
Allowed Values: MASK, REPLACE_WITH_PII_ENTITY_TYPE

Returns:

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

See Also:

PiiEntitiesDetectionMaskMode

setMaskMode

public void setMaskMode(java.lang.String maskMode)

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

Constraints:
Allowed Values: MASK, REPLACE_WITH_PII_ENTITY_TYPE

Parameters:

maskMode -

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

See Also:

PiiEntitiesDetectionMaskMode

withMaskMode

public RedactionConfig withMaskMode(java.lang.String maskMode)

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

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

Constraints:
Allowed Values: MASK, REPLACE_WITH_PII_ENTITY_TYPE

Parameters:

maskMode -

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

PiiEntitiesDetectionMaskMode

setMaskMode

public void setMaskMode(PiiEntitiesDetectionMaskMode maskMode)

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

Constraints:
Allowed Values: MASK, REPLACE_WITH_PII_ENTITY_TYPE

Parameters:

maskMode -

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

See Also:

PiiEntitiesDetectionMaskMode

withMaskMode

public RedactionConfig withMaskMode(PiiEntitiesDetectionMaskMode maskMode)

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

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

Constraints:
Allowed Values: MASK, REPLACE_WITH_PII_ENTITY_TYPE

Parameters:

maskMode -

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

PiiEntitiesDetectionMaskMode

getMaskCharacter

public java.lang.String getMaskCharacter()

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

Constraints:
Length: 1 - 1
Pattern: [!@#$%&*]

Returns:

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

setMaskCharacter

public void setMaskCharacter(java.lang.String maskCharacter)

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

Constraints:
Length: 1 - 1
Pattern: [!@#$%&*]

Parameters:

maskCharacter -

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

withMaskCharacter

public RedactionConfig withMaskCharacter(java.lang.String maskCharacter)

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

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

Constraints:
Length: 1 - 1
Pattern: [!@#$%&*]

Parameters:

maskCharacter -

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object