Package software.amazon.awssdk.services.personalizeevents.model

Class User

java.lang.Object

software.amazon.awssdk.services.personalizeevents.model.User

All Implemented Interfaces:

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

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

Represents user metadata added to a Users dataset using the PutUsers API. For more information see Importing users individually.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	User.Builder

Method Summary

Modifier and Type	Method	Description
static User.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	properties()	A string map of user-specific metadata.
List<SdkField<?>>	sdkFields()
static Class<? extends User.Builder>	serializableBuilderClass()
User.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userId()	The ID associated with the user.

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

userId

public final String userId()

The ID associated with the user.

Returns:

The ID associated with the user.

properties

public final String properties()

A string map of user-specific metadata. Each element in the map consists of a key-value pair. For example, {"numberOfVideosWatched": "45"}.

The keys use camel case names that match the fields in the schema for the Users dataset. In the previous example, the numberOfVideosWatched matches the 'NUMBER_OF_VIDEOS_WATCHED' field defined in the Users schema. For categorical string data, to include multiple categories for a single user, separate each category with a pipe separator (|). For example, \"Member|Frequent shopper\".

Returns:

A string map of user-specific metadata. Each element in the map consists of a key-value pair. For example, {"numberOfVideosWatched": "45"}.

The keys use camel case names that match the fields in the schema for the Users dataset. In the previous example, the numberOfVideosWatched matches the 'NUMBER_OF_VIDEOS_WATCHED' field defined in the Users schema. For categorical string data, to include multiple categories for a single user, separate each category with a pipe separator (|). For example, \"Member|Frequent shopper\".

toBuilder

public User.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<User.Builder,User>

builder

public static User.Builder builder()

serializableBuilderClass

public static Class<? extends User.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