com.amazonaws.services.pinpoint.model

Class EndpointUser

java.lang.Object

com.amazonaws.services.pinpoint.model.EndpointUser

All Implemented Interfaces:

Serializable

public class EndpointUser
extends Object
implements Serializable

Endpoint user specific custom userAttributes

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EndpointUser()

Method Summary

Modifier and Type	Method and Description
EndpointUser	addUserAttributesEntry(String key, List<String> value) Custom attributes that describe the user by associating a name with an array of values.
EndpointUser	clearUserAttributesEntries() Removes all the entries added into UserAttributes.
boolean	equals(Object obj)
Map<String,List<String>>	getUserAttributes() Custom attributes that describe the user by associating a name with an array of values.
String	getUserId() The unique ID of the user.
int	hashCode()
void	setUserAttributes(Map<String,List<String>> userAttributes) Custom attributes that describe the user by associating a name with an array of values.
void	setUserId(String userId) The unique ID of the user.
String	toString() Returns a string representation of this object; useful for testing and debugging.
EndpointUser	withUserAttributes(Map<String,List<String>> userAttributes) Custom attributes that describe the user by associating a name with an array of values.
EndpointUser	withUserId(String userId) The unique ID of the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointUser

public EndpointUser()

Method Detail

getUserAttributes

public Map<String,List<String>> getUserAttributes()

Custom attributes that describe the user by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.

Returns:

Custom attributes that describe the user by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.

setUserAttributes

public void setUserAttributes(Map<String,List<String>> userAttributes)

Custom attributes that describe the user by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.

Parameters:

userAttributes - Custom attributes that describe the user by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.

withUserAttributes

public EndpointUser withUserAttributes(Map<String,List<String>> userAttributes)

Custom attributes that describe the user by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.

Returns a reference to this object so that method calls can be chained together.

Parameters:

userAttributes - Custom attributes that describe the user by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.

Returns:

A reference to this updated object so that method calls can be chained together.

addUserAttributesEntry

public EndpointUser addUserAttributesEntry(String key,
                                           List<String> value)

Custom attributes that describe the user by associating a name with an array of values. For example, an attribute named "interests" might have the following values: ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can't display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.

The method adds a new key-value pair into UserAttributes parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into UserAttributes.

value - The corresponding value of the entry to be added into UserAttributes.

Returns:

A reference to this updated object so that method calls can be chained together.

clearUserAttributesEntries

public EndpointUser clearUserAttributesEntries()

Removes all the entries added into UserAttributes.

Returns a reference to this object so that method calls can be chained together.

getUserId

public String getUserId()

The unique ID of the user.

Returns:

The unique ID of the user.

setUserId

public void setUserId(String userId)

The unique ID of the user.

Parameters:

userId - The unique ID of the user.

withUserId

public EndpointUser withUserId(String userId)

The unique ID of the user.

Returns a reference to this object so that method calls can be chained together.

Parameters:

userId - The unique ID of the user.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object