Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
ObjectTypeKey' | |
|
Instances
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, 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.
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, 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.