PIIDetection (AWS Java SDK for AWS Glue 1.12.558 API)

java.lang.Object
- com.amazonaws.services.glue.model.PIIDetection

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PIIDetection
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies a transform that identifies, removes or masks PII data.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PIIDetection()

Constructors
Constructor and Description
`PIIDetection()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PIIDetection`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getEntityTypesToDetect()` Indicates the types of entities the PIIDetection transform will identify as PII data.
`List<String>`	`getInputs()` The node ID inputs to the transform.
`String`	`getMaskValue()` Indicates the value that will replace the detected entity.
`String`	`getName()` The name of the transform node.
`String`	`getOutputColumnName()` Indicates the output column name that will contain any entity type detected in that row.
`String`	`getPiiType()` Indicates the type of PIIDetection transform.
`Double`	`getSampleFraction()` Indicates the fraction of the data to sample when scanning for PII entities.
`Double`	`getThresholdFraction()` Indicates the fraction of the data that must be met in order for a column to be identified as PII data.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setEntityTypesToDetect(Collection<String> entityTypesToDetect)` Indicates the types of entities the PIIDetection transform will identify as PII data.
`void`	`setInputs(Collection<String> inputs)` The node ID inputs to the transform.
`void`	`setMaskValue(String maskValue)` Indicates the value that will replace the detected entity.
`void`	`setName(String name)` The name of the transform node.
`void`	`setOutputColumnName(String outputColumnName)` Indicates the output column name that will contain any entity type detected in that row.
`void`	`setPiiType(String piiType)` Indicates the type of PIIDetection transform.
`void`	`setSampleFraction(Double sampleFraction)` Indicates the fraction of the data to sample when scanning for PII entities.
`void`	`setThresholdFraction(Double thresholdFraction)` Indicates the fraction of the data that must be met in order for a column to be identified as PII data.
`String`	`toString()` Returns a string representation of this object.
`PIIDetection`	`withEntityTypesToDetect(Collection<String> entityTypesToDetect)` Indicates the types of entities the PIIDetection transform will identify as PII data.
`PIIDetection`	`withEntityTypesToDetect(String... entityTypesToDetect)` Indicates the types of entities the PIIDetection transform will identify as PII data.
`PIIDetection`	`withInputs(Collection<String> inputs)` The node ID inputs to the transform.
`PIIDetection`	`withInputs(String... inputs)` The node ID inputs to the transform.
`PIIDetection`	`withMaskValue(String maskValue)` Indicates the value that will replace the detected entity.
`PIIDetection`	`withName(String name)` The name of the transform node.
`PIIDetection`	`withOutputColumnName(String outputColumnName)` Indicates the output column name that will contain any entity type detected in that row.
`PIIDetection`	`withPiiType(PiiType piiType)` Indicates the type of PIIDetection transform.
`PIIDetection`	`withPiiType(String piiType)` Indicates the type of PIIDetection transform.
`PIIDetection`	`withSampleFraction(Double sampleFraction)` Indicates the fraction of the data to sample when scanning for PII entities.
`PIIDetection`	`withThresholdFraction(Double thresholdFraction)` Indicates the fraction of the data that must be met in order for a column to be identified as PII data.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PIIDetection
```
public PIIDetection()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the transform node.
    
    Parameters:
    
    name - The name of the transform node.
  - getName
```
public String getName()
```
    The name of the transform node.
    
    Returns:
    
    The name of the transform node.
  - withName
```
public PIIDetection withName(String name)
```
    The name of the transform node.
    
    Parameters:
    
    name - The name of the transform node.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInputs
```
public List<String> getInputs()
```
    The node ID inputs to the transform.
    
    Returns:
    
    The node ID inputs to the transform.
  - setInputs
```
public void setInputs(Collection<String> inputs)
```
    The node ID inputs to the transform.
    
    Parameters:
    
    inputs - The node ID inputs to the transform.
  - withInputs
```
public PIIDetection withInputs(String... inputs)
```
    The node ID inputs to the transform.
    
    NOTE: This method appends the values to the existing list (if any). Use setInputs(java.util.Collection) or withInputs(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    inputs - The node ID inputs to the transform.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInputs
```
public PIIDetection withInputs(Collection<String> inputs)
```
    The node ID inputs to the transform.
    
    Parameters:
    
    inputs - The node ID inputs to the transform.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPiiType
```
public void setPiiType(String piiType)
```
    Indicates the type of PIIDetection transform.
    
    Parameters:
    
    piiType - Indicates the type of PIIDetection transform.
    
    See Also:
    
    PiiType
  - getPiiType
```
public String getPiiType()
```
    Indicates the type of PIIDetection transform.
    
    Returns:
    
    Indicates the type of PIIDetection transform.
    
    See Also:
    
    PiiType
  - withPiiType
```
public PIIDetection withPiiType(String piiType)
```
    Indicates the type of PIIDetection transform.
    
    Parameters:
    
    piiType - Indicates the type of PIIDetection transform.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PiiType
  - withPiiType
```
public PIIDetection withPiiType(PiiType piiType)
```
    Indicates the type of PIIDetection transform.
    
    Parameters:
    
    piiType - Indicates the type of PIIDetection transform.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PiiType
  - getEntityTypesToDetect
```
public List<String> getEntityTypesToDetect()
```
    Indicates the types of entities the PIIDetection transform will identify as PII data.
    
    PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE
    
    Returns:
    
    Indicates the types of entities the PIIDetection transform will identify as PII data.
    
    PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD ,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE
  - setEntityTypesToDetect
```
public void setEntityTypesToDetect(Collection<String> entityTypesToDetect)
```
    Indicates the types of entities the PIIDetection transform will identify as PII data.
    
    PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE
    
    Parameters:
    
    entityTypesToDetect - Indicates the types of entities the PIIDetection transform will identify as PII data.
    
    PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER ,USA_DEA_NUMBER,USA_DRIVING_LICENSE
  - withEntityTypesToDetect
```
public PIIDetection withEntityTypesToDetect(String... entityTypesToDetect)
```
    Indicates the types of entities the PIIDetection transform will identify as PII data.
    
    PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE
    
    NOTE: This method appends the values to the existing list (if any). Use setEntityTypesToDetect(java.util.Collection) or withEntityTypesToDetect(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    entityTypesToDetect - Indicates the types of entities the PIIDetection transform will identify as PII data.
    
    PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER ,USA_DEA_NUMBER,USA_DRIVING_LICENSE
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEntityTypesToDetect
```
public PIIDetection withEntityTypesToDetect(Collection<String> entityTypesToDetect)
```
    Indicates the types of entities the PIIDetection transform will identify as PII data.
    
    PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE
    
    Parameters:
    
    entityTypesToDetect - Indicates the types of entities the PIIDetection transform will identify as PII data.
    
    PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER ,USA_DEA_NUMBER,USA_DRIVING_LICENSE
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputColumnName
```
public void setOutputColumnName(String outputColumnName)
```
    Indicates the output column name that will contain any entity type detected in that row.
    
    Parameters:
    
    outputColumnName - Indicates the output column name that will contain any entity type detected in that row.
  - getOutputColumnName
```
public String getOutputColumnName()
```
    Indicates the output column name that will contain any entity type detected in that row.
    
    Returns:
    
    Indicates the output column name that will contain any entity type detected in that row.
  - withOutputColumnName
```
public PIIDetection withOutputColumnName(String outputColumnName)
```
    Indicates the output column name that will contain any entity type detected in that row.
    
    Parameters:
    
    outputColumnName - Indicates the output column name that will contain any entity type detected in that row.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSampleFraction
```
public void setSampleFraction(Double sampleFraction)
```
    Indicates the fraction of the data to sample when scanning for PII entities.
    
    Parameters:
    
    sampleFraction - Indicates the fraction of the data to sample when scanning for PII entities.
  - getSampleFraction
```
public Double getSampleFraction()
```
    Indicates the fraction of the data to sample when scanning for PII entities.
    
    Returns:
    
    Indicates the fraction of the data to sample when scanning for PII entities.
  - withSampleFraction
```
public PIIDetection withSampleFraction(Double sampleFraction)
```
    Indicates the fraction of the data to sample when scanning for PII entities.
    
    Parameters:
    
    sampleFraction - Indicates the fraction of the data to sample when scanning for PII entities.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setThresholdFraction
```
public void setThresholdFraction(Double thresholdFraction)
```
    Indicates the fraction of the data that must be met in order for a column to be identified as PII data.
    
    Parameters:
    
    thresholdFraction - Indicates the fraction of the data that must be met in order for a column to be identified as PII data.
  - getThresholdFraction
```
public Double getThresholdFraction()
```
    Indicates the fraction of the data that must be met in order for a column to be identified as PII data.
    
    Returns:
    
    Indicates the fraction of the data that must be met in order for a column to be identified as PII data.
  - withThresholdFraction
```
public PIIDetection withThresholdFraction(Double thresholdFraction)
```
    Indicates the fraction of the data that must be met in order for a column to be identified as PII data.
    
    Parameters:
    
    thresholdFraction - Indicates the fraction of the data that must be met in order for a column to be identified as PII data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaskValue
```
public void setMaskValue(String maskValue)
```
    Indicates the value that will replace the detected entity.
    
    Parameters:
    
    maskValue - Indicates the value that will replace the detected entity.
  - getMaskValue
```
public String getMaskValue()
```
    Indicates the value that will replace the detected entity.
    
    Returns:
    
    Indicates the value that will replace the detected entity.
  - withMaskValue
```
public PIIDetection withMaskValue(String maskValue)
```
    Indicates the value that will replace the detected entity.
    
    Parameters:
    
    maskValue - Indicates the value that will replace the detected 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 PIIDetection clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class PIIDetection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PIIDetection

Method Detail

setName

getName

withName

getInputs

setInputs

withInputs

withInputs

setPiiType

getPiiType

withPiiType

withPiiType

getEntityTypesToDetect

setEntityTypesToDetect

withEntityTypesToDetect

withEntityTypesToDetect

setOutputColumnName

getOutputColumnName

withOutputColumnName

setSampleFraction

getSampleFraction

withSampleFraction

setThresholdFraction

getThresholdFraction

withThresholdFraction

setMaskValue

getMaskValue

withMaskValue

toString

equals

hashCode

clone

marshall