@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ObjectTypeKey extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
ObjectTypeKey() |
Modifier and Type | Method and Description |
---|---|
ObjectTypeKey |
clone() |
boolean |
equals(Object obj) |
List<String> |
getFieldNames()
The reference for the key name of the fields map.
|
List<String> |
getStandardIdentifiers()
The types of keys that a ProfileObject can have.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setFieldNames(Collection<String> fieldNames)
The reference for the key name of the fields map.
|
void |
setStandardIdentifiers(Collection<String> standardIdentifiers)
The types of keys that a ProfileObject can have.
|
String |
toString()
Returns a string representation of this object.
|
ObjectTypeKey |
withFieldNames(Collection<String> fieldNames)
The reference for the key name of the fields map.
|
ObjectTypeKey |
withFieldNames(String... fieldNames)
The reference for the key name of the fields map.
|
ObjectTypeKey |
withStandardIdentifiers(Collection<String> standardIdentifiers)
The types of keys that a ProfileObject can have.
|
ObjectTypeKey |
withStandardIdentifiers(StandardIdentifier... standardIdentifiers)
The types of keys that a ProfileObject can have.
|
ObjectTypeKey |
withStandardIdentifiers(String... standardIdentifiers)
The types of keys that a ProfileObject can have.
|
public List<String> getStandardIdentifiers()
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.
StandardIdentifier
public void setStandardIdentifiers(Collection<String> 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.
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.StandardIdentifier
public ObjectTypeKey withStandardIdentifiers(String... 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.
NOTE: This method appends the values to the existing list (if any). Use
setStandardIdentifiers(java.util.Collection)
or withStandardIdentifiers(java.util.Collection)
if you want to override the existing values.
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.StandardIdentifier
public ObjectTypeKey withStandardIdentifiers(Collection<String> 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.
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.StandardIdentifier
public ObjectTypeKey withStandardIdentifiers(StandardIdentifier... 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.
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.StandardIdentifier
public List<String> getFieldNames()
The reference for the key name of the fields map.
public void setFieldNames(Collection<String> fieldNames)
The reference for the key name of the fields map.
fieldNames
- The reference for the key name of the fields map.public ObjectTypeKey withFieldNames(String... fieldNames)
The reference for the key name of the fields map.
NOTE: This method appends the values to the existing list (if any). Use
setFieldNames(java.util.Collection)
or withFieldNames(java.util.Collection)
if you want to
override the existing values.
fieldNames
- The reference for the key name of the fields map.public ObjectTypeKey withFieldNames(Collection<String> fieldNames)
The reference for the key name of the fields map.
fieldNames
- The reference for the key name of the fields map.public String toString()
toString
in class Object
Object.toString()
public ObjectTypeKey clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.