Package software.amazon.awssdk.services.glue.model

Class PIIDetection

    • Method Detail

      • name

        public final String name()

        The name of the transform node.

        Returns:
        The name of the transform node.

      • hasInputs

        public final boolean hasInputs()
        For responses, this returns true if the service returned a value for the Inputs 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.

      • inputs

        public final List<String> inputs()

        The node ID inputs to the transform.

        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 hasInputs() method.

        Returns:
        The node ID inputs to the transform.

      • piiType

        public final PiiType piiType()

        Indicates the type of PIIDetection transform.

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

        Returns:
        Indicates the type of PIIDetection transform.
        See Also:
        PiiType

      • piiTypeAsString

        public final String piiTypeAsString()

        Indicates the type of PIIDetection transform.

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

        Returns:
        Indicates the type of PIIDetection transform.
        See Also:
        PiiType

      • hasEntityTypesToDetect

        public final boolean hasEntityTypesToDetect()
        For responses, this returns true if the service returned a value for the EntityTypesToDetect 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.

      • entityTypesToDetect

        public final List<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

        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 hasEntityTypesToDetect() method.

        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

      • outputColumnName

        public final String outputColumnName()

        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.

      • sampleFraction

        public final Double sampleFraction()

        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.

      • thresholdFraction

        public final Double thresholdFraction()

        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.

      • maskValue

        public final String maskValue()

        Indicates the value that will replace the detected entity.

        Returns:
        Indicates the value that will replace the detected entity.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)