Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CustomerProfiles.Types.ObjectTypeKey

Description

Synopsis

Documentation

data ObjectTypeKey Source #

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.

See: newObjectTypeKey smart constructor.

Constructors

ObjectTypeKey'

Fields

fieldNames :: Maybe [Text]
The reference for the key name of the fields map.
standardIdentifiers :: Maybe [StandardIdentifier]
The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE, ASSET or CASE means that this key can be used to tie an object to a PROFILE, ASSET or CASE 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.

Instances

Instances details

Eq ObjectTypeKey Source #
Instance details Defined in Amazonka.CustomerProfiles.Types.ObjectTypeKey Methods (==) :: ObjectTypeKey -> ObjectTypeKey -> Bool # (/=) :: ObjectTypeKey -> ObjectTypeKey -> Bool #
Read ObjectTypeKey Source #
Instance details Defined in Amazonka.CustomerProfiles.Types.ObjectTypeKey Methods readsPrec :: Int -> ReadS ObjectTypeKey # readList :: ReadS [ObjectTypeKey] # readPrec :: ReadPrec ObjectTypeKey # readListPrec :: ReadPrec [ObjectTypeKey] #
Show ObjectTypeKey Source #
Instance details Defined in Amazonka.CustomerProfiles.Types.ObjectTypeKey Methods showsPrec :: Int -> ObjectTypeKey -> ShowS # show :: ObjectTypeKey -> String # showList :: [ObjectTypeKey] -> ShowS #
Generic ObjectTypeKey Source #
Instance details Defined in Amazonka.CustomerProfiles.Types.ObjectTypeKey Associated Types type Rep ObjectTypeKey :: Type -> Type # Methods from :: ObjectTypeKey -> Rep ObjectTypeKey x # to :: Rep ObjectTypeKey x -> ObjectTypeKey #
NFData ObjectTypeKey Source #
Instance details Defined in Amazonka.CustomerProfiles.Types.ObjectTypeKey Methods rnf :: ObjectTypeKey -> () #
Hashable ObjectTypeKey Source #
Instance details Defined in Amazonka.CustomerProfiles.Types.ObjectTypeKey Methods hashWithSalt :: Int -> ObjectTypeKey -> Int # hash :: ObjectTypeKey -> Int #
ToJSON ObjectTypeKey Source #
Instance details Defined in Amazonka.CustomerProfiles.Types.ObjectTypeKey Methods toJSON :: ObjectTypeKey -> Value # toEncoding :: ObjectTypeKey -> Encoding # toJSONList :: [ObjectTypeKey] -> Value # toEncodingList :: [ObjectTypeKey] -> Encoding #
FromJSON ObjectTypeKey Source #
Instance details Defined in Amazonka.CustomerProfiles.Types.ObjectTypeKey Methods parseJSON :: Value -> Parser ObjectTypeKey # parseJSONList :: Value -> Parser [ObjectTypeKey] #
type Rep ObjectTypeKey Source #
Instance details Defined in Amazonka.CustomerProfiles.Types.ObjectTypeKey type Rep ObjectTypeKey = D1 ('MetaData "ObjectTypeKey" "Amazonka.CustomerProfiles.Types.ObjectTypeKey" "libZSservicesZSamazonka-customer-profilesZSamazonka-customer-profiles" 'False) (C1 ('MetaCons "ObjectTypeKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fieldNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "standardIdentifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StandardIdentifier]))))

newObjectTypeKey :: ObjectTypeKey Source #

Create a value of ObjectTypeKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fieldNames:ObjectTypeKey', objectTypeKey_fieldNames - The reference for the key name of the fields map.

$sel:standardIdentifiers:ObjectTypeKey', objectTypeKey_standardIdentifiers - The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE, ASSET or CASE means that this key can be used to tie an object to a PROFILE, ASSET or CASE 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.

objectTypeKey_fieldNames :: Lens' ObjectTypeKey (Maybe [Text]) Source #

The reference for the key name of the fields map.

objectTypeKey_standardIdentifiers :: Lens' ObjectTypeKey (Maybe [StandardIdentifier]) Source #

The types of keys that a ProfileObject can have. Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE, ASSET or CASE means that this key can be used to tie an object to a PROFILE, ASSET or CASE 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.