com.amazonaws.services.personalizeevents.model.User Maven / Gradle / Ivy
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.personalizeevents.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Represents user metadata added to a Users dataset using the PutUsers API. For more information see Importing users individually.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class User implements Serializable, Cloneable, StructuredPojo {
/**
*
* The ID associated with the user.
*
*/
private String userId;
/**
*
* 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\".
*
*/
private String properties;
/**
*
* The ID associated with the user.
*
*
* @param userId
* The ID associated with the user.
*/
public void setUserId(String userId) {
this.userId = userId;
}
/**
*
* The ID associated with the user.
*
*
* @return The ID associated with the user.
*/
public String getUserId() {
return this.userId;
}
/**
*
* The ID associated with the user.
*
*
* @param userId
* The ID associated with the user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public User withUserId(String userId) {
setUserId(userId);
return this;
}
/**
*
* 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\".
*
*
* This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For
* example: '{"key": "value"}'.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* @param 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\".
*/
public void setProperties(String properties) {
this.properties = 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\".
*
*
* This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For
* example: '{"key": "value"}'.
*
*
* @return 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\".
*/
public String getProperties() {
return this.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\".
*
*
* This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For
* example: '{"key": "value"}'.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* @param 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\".
* @return Returns a reference to this object so that method calls can be chained together.
*/
public User withProperties(String properties) {
setProperties(properties);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getUserId() != null)
sb.append("UserId: ").append(getUserId()).append(",");
if (getProperties() != null)
sb.append("Properties: ").append("***Sensitive Data Redacted***");
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof User == false)
return false;
User other = (User) obj;
if (other.getUserId() == null ^ this.getUserId() == null)
return false;
if (other.getUserId() != null && other.getUserId().equals(this.getUserId()) == false)
return false;
if (other.getProperties() == null ^ this.getProperties() == null)
return false;
if (other.getProperties() != null && other.getProperties().equals(this.getProperties()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getUserId() == null) ? 0 : getUserId().hashCode());
hashCode = prime * hashCode + ((getProperties() == null) ? 0 : getProperties().hashCode());
return hashCode;
}
@Override
public User clone() {
try {
return (User) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.personalizeevents.model.transform.UserMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}