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() For responses, this returns true if the service returned a value for the UserAttributes property.
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 final boolean hasUserAttributes()

For responses, this returns true if the service returned a value for the UserAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

userAttributes

public final 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. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. 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 restriction doesn't apply to attribute values.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUserAttributes() method.

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. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. 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 restriction doesn't apply to attribute values.

userId

public final 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 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