Class User
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic User.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
A string map of user-specific metadata.static Class
<? extends User.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
userId()
The ID associated with the user.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
userId
The ID associated with the user.
- Returns:
- The ID associated with the user.
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<User.Builder,
User> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-