Class: Aws::CustomerProfiles::Types::ObjectTypeKey

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb

Overview

Note:

When making an API call, you may pass ObjectTypeKey data as a hash:

{
  standard_identifiers: ["PROFILE"], # accepts PROFILE, ASSET, CASE, UNIQUE, SECONDARY, LOOKUP_ONLY, NEW_ONLY, ORDER
  field_names: ["name"],
}

An object that defines the Key element of a ProfileObject. A Key is a special element that can be used to search for a customer profile.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#field_namesArray<String>

The reference for the key name of the fields map.

Returns:

  • (Array<String>)


3685
3686
3687
3688
3689
3690
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 3685

class ObjectTypeKey < Struct.new(
  :standard_identifiers,
  :field_names)
  SENSITIVE = []
  include Aws::Structure
end

#standard_identifiersArray<String>

The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE, ASSET, CASE, or ORDER means that this key can be used to tie an object to a PROFILE, ASSET, CASE, or ORDER respectively. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.

Returns:

  • (Array<String>)


3685
3686
3687
3688
3689
3690
# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 3685

class ObjectTypeKey < Struct.new(
  :standard_identifiers,
  :field_names)
  SENSITIVE = []
  include Aws::Structure
end