software.amazon.awssdk.services.pinpoint.model

Class EndpointUser

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.EndpointUser

All Implemented Interfaces:

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

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

Specifies data for one or more attributes that describe the user who's associated with an endpoint.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EndpointUser.Builder

Method Summary

Modifier and Type	Method and Description
static EndpointUser.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasUserAttributes() Returns true if the UserAttributes 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 EndpointUser.Builder>	serializableBuilderClass()
EndpointUser.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Map<String,List<String>>	userAttributes() One or more custom attributes that describe the user by associating a name with an array of values.
String	userId() The unique identifier for 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

hasUserAttributes

public boolean hasUserAttributes()

Returns true if the UserAttributes 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.

userAttributes

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

One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.

When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.

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

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

Returns:

One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["science", "music", "travel"]. You can use these attributes as filter criteria when you create segments.

When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.

userId

public String userId()

The unique identifier for the user.

Returns:

The unique identifier for the user.

toBuilder

public EndpointUser.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EndpointUser.Builder,EndpointUser>

builder

public static EndpointUser.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo