Package software.amazon.awssdk.services.databrew.model

Class EntityDetectorConfiguration

java.lang.Object

software.amazon.awssdk.services.databrew.model.EntityDetectorConfiguration

All Implemented Interfaces:

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

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

Configuration of entity detection for a profile job. When undefined, entity detection is disabled.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EntityDetectorConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
List<AllowedStatistics>	allowedStatistics()	Configuration of statistics that are allowed to be run on columns that contain detected entities.
static EntityDetectorConfiguration.Builder	builder()
List<String>	entityTypes()	Entity types to detect.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAllowedStatistics()	For responses, this returns true if the service returned a value for the AllowedStatistics property.
boolean	hasEntityTypes()	For responses, this returns true if the service returned a value for the EntityTypes property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends EntityDetectorConfiguration.Builder>	serializableBuilderClass()
EntityDetectorConfiguration.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

hasEntityTypes

public final boolean hasEntityTypes()

For responses, this returns true if the service returned a value for the EntityTypes 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.

entityTypes

public final List<String> entityTypes()

Entity types to detect. Can be any of the following:

• USA_SSN

• EMAIL

• USA_ITIN

• USA_PASSPORT_NUMBER

• PHONE_NUMBER

• USA_DRIVING_LICENSE

• BANK_ACCOUNT

• CREDIT_CARD

• IP_ADDRESS

• MAC_ADDRESS

• USA_DEA_NUMBER

• USA_HCPCS_CODE

• USA_NATIONAL_PROVIDER_IDENTIFIER

• USA_NATIONAL_DRUG_CODE

• USA_HEALTH_INSURANCE_CLAIM_NUMBER

• USA_MEDICARE_BENEFICIARY_IDENTIFIER

• USA_CPT_CODE

• PERSON_NAME

• DATE

The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.

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

Returns:

Entity types to detect. Can be any of the following:

• USA_SSN

• EMAIL

• USA_ITIN

• USA_PASSPORT_NUMBER

• PHONE_NUMBER

• USA_DRIVING_LICENSE

• BANK_ACCOUNT

• CREDIT_CARD

• IP_ADDRESS

• MAC_ADDRESS

• USA_DEA_NUMBER

• USA_HCPCS_CODE

• USA_NATIONAL_PROVIDER_IDENTIFIER

• USA_NATIONAL_DRUG_CODE

• USA_HEALTH_INSURANCE_CLAIM_NUMBER

• USA_MEDICARE_BENEFICIARY_IDENTIFIER

• USA_CPT_CODE

• PERSON_NAME

• DATE

The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.

hasAllowedStatistics

public final boolean hasAllowedStatistics()

For responses, this returns true if the service returned a value for the AllowedStatistics 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.

allowedStatistics

public final List<AllowedStatistics> allowedStatistics()

Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.

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

Returns:

Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.

toBuilder

public EntityDetectorConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EntityDetectorConfiguration.Builder,EntityDetectorConfiguration>

builder

public static EntityDetectorConfiguration.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo