software.amazon.awssdk.services.customerprofiles.model

Class ObjectTypeKey

java.lang.Object

software.amazon.awssdk.services.customerprofiles.model.ObjectTypeKey

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ObjectTypeKey.Builder,ObjectTypeKey>

@Generated(value="software.amazon.awssdk:codegen")
public final class ObjectTypeKey
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ObjectTypeKey.Builder,ObjectTypeKey>

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 Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ObjectTypeKey.Builder

Method Summary

Modifier and Type	Method and Description
static ObjectTypeKey.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	fieldNames() The reference for the key name of the fields map.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFieldNames() Returns true if the FieldNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasStandardIdentifiers() Returns true if the StandardIdentifiers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<SdkField<?>>	sdkFields()
static Class<? extends ObjectTypeKey.Builder>	serializableBuilderClass()
List<StandardIdentifier>	standardIdentifiers() The types of keys that a ProfileObject can have.
List<String>	standardIdentifiersAsStrings() The types of keys that a ProfileObject can have.
ObjectTypeKey.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

standardIdentifiers

public final List<StandardIdentifier> standardIdentifiers()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasStandardIdentifiers() to see if a value was sent in this field.

Returns:

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

hasStandardIdentifiers

public final boolean hasStandardIdentifiers()

Returns true if the StandardIdentifiers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

standardIdentifiersAsStrings

public final List<String> standardIdentifiersAsStrings()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasStandardIdentifiers() to see if a value was sent in this field.

Returns:

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

hasFieldNames

public final boolean hasFieldNames()

Returns true if the FieldNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

fieldNames

public final List<String> fieldNames()

The reference for the key name of the fields map.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasFieldNames() to see if a value was sent in this field.

Returns:

The reference for the key name of the fields map.

toBuilder

public ObjectTypeKey.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ObjectTypeKey.Builder,ObjectTypeKey>

builder

public static ObjectTypeKey.Builder builder()

serializableBuilderClass

public static Class<? extends ObjectTypeKey.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo