Class: Aws::EntityResolution::Types::SchemaInputAttribute

Inherits:

Struct

• Object
• Struct
• Aws::EntityResolution::Types::SchemaInputAttribute

Defined in:

gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/types.rb

Overview

A configuration object for defining input data fields in Entity Resolution. The SchemaInputAttribute specifies how individual fields in your input data should be processed and matched.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #field_name ⇒ String

  A string containing the field name.

• #group_name ⇒ String

  A string that instructs Entity Resolution to combine several columns into a unified column with the identical attribute type.

• #hashed ⇒ Boolean

  Indicates if the column values are hashed in the schema input.

• #match_key ⇒ String

  A key that allows grouping of multiple input attributes into a unified matching group.

• #sub_type ⇒ String

  The subtype of the attribute, selected from a list of values.

• #type ⇒ String

  The type of the attribute, selected from a list of values.

Instance Attribute Details

#field_name ⇒ String

A string containing the field name.

Returns:

• (String)

# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/types.rb', line 3122

class SchemaInputAttribute < Struct.new(
  :field_name,
  :type,
  :group_name,
  :match_key,
  :sub_type,
  :hashed)
  SENSITIVE = []
  include Aws::Structure
end

#group_name ⇒ String

A string that instructs Entity Resolution to combine several columns into a unified column with the identical attribute type.

For example, when working with columns such as NAME_FIRST, NAME_MIDDLE, and NAME_LAST, assigning them a common groupName will prompt Entity Resolution to concatenate them into a single value.

Returns:

• (String)

# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/types.rb', line 3122

class SchemaInputAttribute < Struct.new(
  :field_name,
  :type,
  :group_name,
  :match_key,
  :sub_type,
  :hashed)
  SENSITIVE = []
  include Aws::Structure
end

#hashed ⇒ Boolean

Indicates if the column values are hashed in the schema input.

If the value is set to TRUE, the column values are hashed.

If the value is set to FALSE, the column values are cleartext.

Returns:

• (Boolean)

# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/types.rb', line 3122

class SchemaInputAttribute < Struct.new(
  :field_name,
  :type,
  :group_name,
  :match_key,
  :sub_type,
  :hashed)
  SENSITIVE = []
  include Aws::Structure
end

#match_key ⇒ String

A key that allows grouping of multiple input attributes into a unified matching group.

For example, consider a scenario where the source table contains various addresses, such as business_address and shipping_address. By assigning a matchKey called address to both attributes, Entity Resolution will match records across these fields to create a consolidated matching group.

If no matchKey is specified for a column, it won't be utilized for matching purposes but will still be included in the output table.

Returns:

• (String)

# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/types.rb', line 3122

class SchemaInputAttribute < Struct.new(
  :field_name,
  :type,
  :group_name,
  :match_key,
  :sub_type,
  :hashed)
  SENSITIVE = []
  include Aws::Structure
end

#sub_type ⇒ String

The subtype of the attribute, selected from a list of values.

Returns:

• (String)

# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/types.rb', line 3122

class SchemaInputAttribute < Struct.new(
  :field_name,
  :type,
  :group_name,
  :match_key,
  :sub_type,
  :hashed)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of the attribute, selected from a list of values.

LiveRamp supports: NAME | NAME_FIRST | NAME_MIDDLE | NAME_LAST | ADDRESS | ADDRESS_STREET1 | ADDRESS_STREET2 | ADDRESS_STREET3 | ADDRESS_CITY | ADDRESS_STATE | ADDRESS_COUNTRY | ADDRESS_POSTALCODE | PHONE | PHONE_NUMBER | EMAIL_ADDRESS | UNIQUE_ID | PROVIDER_ID

TransUnion supports: NAME | NAME_FIRST | NAME_LAST | ADDRESS | ADDRESS_CITY | ADDRESS_STATE | ADDRESS_COUNTRY | ADDRESS_POSTALCODE | PHONE_NUMBER | EMAIL_ADDRESS | UNIQUE_ID | IPV4 | IPV6 | MAID

Unified ID 2.0 supports: PHONE_NUMBER | EMAIL_ADDRESS | UNIQUE_ID

Normalization is only supported for NAME, ADDRESS, PHONE, and EMAIL_ADDRESS.

If you want to normalize NAME_FIRST, NAME_MIDDLE, and NAME_LAST, you must group them by assigning them to the NAME groupName.

If you want to normalize ADDRESS_STREET1, ADDRESS_STREET2, ADDRESS_STREET3, ADDRESS_CITY, ADDRESS_STATE, ADDRESS_COUNTRY, and ADDRESS_POSTALCODE, you must group them by assigning them to the ADDRESS groupName.

If you want to normalize PHONE_NUMBER and PHONE_COUNTRYCODE, you must group them by assigning them to the PHONE groupName.

Returns:

• (String)

# File 'gems/aws-sdk-entityresolution/lib/aws-sdk-entityresolution/types.rb', line 3122

class SchemaInputAttribute < Struct.new(
  :field_name,
  :type,
  :group_name,
  :match_key,
  :sub_type,
  :hashed)
  SENSITIVE = []
  include Aws::Structure
end