/* * Copyright 2018-2023 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 interaction event information sent using the PutEvents API. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class Event implements Serializable, Cloneable, StructuredPojo { /** *

* An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the * event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinquish * unique events. Any subsequent events after the first with the same event ID are not used in model training. *

*/ private String eventId; /** *

* The type of event, such as click or download. This property corresponds to the EVENT_TYPE field of * your Interactions schema and depends on the types of events you are tracking. *

*/ private String eventType; /** *

* The event value that corresponds to the EVENT_VALUE field of the Interactions schema. *

*/ private Float eventValue; /** *

* The item ID key that corresponds to the ITEM_ID field of the Interactions schema. *

*/ private String itemId; /** *

* A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your * site, other than movie ID (itemId) and rating (eventValue) , you might also send the * number of movie ratings made by the user. *

*

* Each item in the map consists of a key-value pair. For example, *

*

* {"numberOfRatings": "12"} *

*

* The keys use camel case names that match the fields in the Interactions schema. In the above example, the * numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema. *

*/ private String properties; /** *

* The timestamp (in Unix time) on the client side when the event occurred. *

*/ private java.util.Date sentAt; /** *

* The ID of the list of recommendations that contains the item the user interacted with. Provide a * recommendationId to have Amazon Personalize implicitly record the recommendations you show your user * as impressions data. Or provide a recommendationId if you use a metric attribution to measure the * impact of recommendations. *

*

* For more information on recording impressions data, see Recording impressions data. For more information on creating a metric attribution see Measuring impact of * recommendations. *

*/ private String recommendationId; /** *

* A list of item IDs that represents the sequence of items you have shown the user. For example, * ["itemId1", "itemId2", "itemId3"]. Provide a list of items to manually record impressions data for * an event. For more information on recording impressions data, see Recording impressions data. *

*/ private java.util.List impression; /** *

* Contains information about the metric attribution associated with an event. For more information about metric * attributions, see Measuring impact of * recommendations. *

*/ private MetricAttribution metricAttribution; /** *

* An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the * event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinquish * unique events. Any subsequent events after the first with the same event ID are not used in model training. *

* * @param eventId * An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID * for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to * distinquish unique events. Any subsequent events after the first with the same event ID are not used in * model training. */ public void setEventId(String eventId) { this.eventId = eventId; } /** *

* An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the * event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinquish * unique events. Any subsequent events after the first with the same event ID are not used in model training. *

* * @return An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID * for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to * distinquish unique events. Any subsequent events after the first with the same event ID are not used in * model training. */ public String getEventId() { return this.eventId; } /** *

* An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the * event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinquish * unique events. Any subsequent events after the first with the same event ID are not used in model training. *

* * @param eventId * An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID * for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to * distinquish unique events. Any subsequent events after the first with the same event ID are not used in * model training. * @return Returns a reference to this object so that method calls can be chained together. */ public Event withEventId(String eventId) { setEventId(eventId); return this; } /** *

* The type of event, such as click or download. This property corresponds to the EVENT_TYPE field of * your Interactions schema and depends on the types of events you are tracking. *

* * @param eventType * The type of event, such as click or download. This property corresponds to the EVENT_TYPE * field of your Interactions schema and depends on the types of events you are tracking. */ public void setEventType(String eventType) { this.eventType = eventType; } /** *

* The type of event, such as click or download. This property corresponds to the EVENT_TYPE field of * your Interactions schema and depends on the types of events you are tracking. *

* * @return The type of event, such as click or download. This property corresponds to the EVENT_TYPE * field of your Interactions schema and depends on the types of events you are tracking. */ public String getEventType() { return this.eventType; } /** *

* The type of event, such as click or download. This property corresponds to the EVENT_TYPE field of * your Interactions schema and depends on the types of events you are tracking. *

* * @param eventType * The type of event, such as click or download. This property corresponds to the EVENT_TYPE * field of your Interactions schema and depends on the types of events you are tracking. * @return Returns a reference to this object so that method calls can be chained together. */ public Event withEventType(String eventType) { setEventType(eventType); return this; } /** *

* The event value that corresponds to the EVENT_VALUE field of the Interactions schema. *

* * @param eventValue * The event value that corresponds to the EVENT_VALUE field of the Interactions schema. */ public void setEventValue(Float eventValue) { this.eventValue = eventValue; } /** *

* The event value that corresponds to the EVENT_VALUE field of the Interactions schema. *

* * @return The event value that corresponds to the EVENT_VALUE field of the Interactions schema. */ public Float getEventValue() { return this.eventValue; } /** *

* The event value that corresponds to the EVENT_VALUE field of the Interactions schema. *

* * @param eventValue * The event value that corresponds to the EVENT_VALUE field of the Interactions schema. * @return Returns a reference to this object so that method calls can be chained together. */ public Event withEventValue(Float eventValue) { setEventValue(eventValue); return this; } /** *

* The item ID key that corresponds to the ITEM_ID field of the Interactions schema. *

* * @param itemId * The item ID key that corresponds to the ITEM_ID field of the Interactions schema. */ public void setItemId(String itemId) { this.itemId = itemId; } /** *

* The item ID key that corresponds to the ITEM_ID field of the Interactions schema. *

* * @return The item ID key that corresponds to the ITEM_ID field of the Interactions schema. */ public String getItemId() { return this.itemId; } /** *

* The item ID key that corresponds to the ITEM_ID field of the Interactions schema. *

* * @param itemId * The item ID key that corresponds to the ITEM_ID field of the Interactions schema. * @return Returns a reference to this object so that method calls can be chained together. */ public Event withItemId(String itemId) { setItemId(itemId); return this; } /** *

* A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your * site, other than movie ID (itemId) and rating (eventValue) , you might also send the * number of movie ratings made by the user. *

*

* Each item in the map consists of a key-value pair. For example, *

*

* {"numberOfRatings": "12"} *

*

* The keys use camel case names that match the fields in the Interactions schema. In the above example, the * numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema. *

*

* 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 event-specific data that you might choose to record. For example, if a user rates a movie * on your site, other than movie ID (itemId) and rating (eventValue) , you might * also send the number of movie ratings made by the user.

*

* Each item in the map consists of a key-value pair. For example, *

*

* {"numberOfRatings": "12"} *

*

* The keys use camel case names that match the fields in the Interactions schema. In the above example, the * numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema. */ public void setProperties(String properties) { this.properties = properties; } /** *

* A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your * site, other than movie ID (itemId) and rating (eventValue) , you might also send the * number of movie ratings made by the user. *

*

* Each item in the map consists of a key-value pair. For example, *

*

* {"numberOfRatings": "12"} *

*

* The keys use camel case names that match the fields in the Interactions schema. In the above example, the * numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema. *

*

* 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 event-specific data that you might choose to record. For example, if a user rates a movie * on your site, other than movie ID (itemId) and rating (eventValue) , you might * also send the number of movie ratings made by the user.

*

* Each item in the map consists of a key-value pair. For example, *

*

* {"numberOfRatings": "12"} *

*

* The keys use camel case names that match the fields in the Interactions schema. In the above example, the * numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Interactions * schema. */ public String getProperties() { return this.properties; } /** *

* A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your * site, other than movie ID (itemId) and rating (eventValue) , you might also send the * number of movie ratings made by the user. *

*

* Each item in the map consists of a key-value pair. For example, *

*

* {"numberOfRatings": "12"} *

*

* The keys use camel case names that match the fields in the Interactions schema. In the above example, the * numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema. *

*

* 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 event-specific data that you might choose to record. For example, if a user rates a movie * on your site, other than movie ID (itemId) and rating (eventValue) , you might * also send the number of movie ratings made by the user.

*

* Each item in the map consists of a key-value pair. For example, *

*

* {"numberOfRatings": "12"} *

*

* The keys use camel case names that match the fields in the Interactions schema. In the above example, the * numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema. * @return Returns a reference to this object so that method calls can be chained together. */ public Event withProperties(String properties) { setProperties(properties); return this; } /** *

* The timestamp (in Unix time) on the client side when the event occurred. *

* * @param sentAt * The timestamp (in Unix time) on the client side when the event occurred. */ public void setSentAt(java.util.Date sentAt) { this.sentAt = sentAt; } /** *

* The timestamp (in Unix time) on the client side when the event occurred. *

* * @return The timestamp (in Unix time) on the client side when the event occurred. */ public java.util.Date getSentAt() { return this.sentAt; } /** *

* The timestamp (in Unix time) on the client side when the event occurred. *

* * @param sentAt * The timestamp (in Unix time) on the client side when the event occurred. * @return Returns a reference to this object so that method calls can be chained together. */ public Event withSentAt(java.util.Date sentAt) { setSentAt(sentAt); return this; } /** *

* The ID of the list of recommendations that contains the item the user interacted with. Provide a * recommendationId to have Amazon Personalize implicitly record the recommendations you show your user * as impressions data. Or provide a recommendationId if you use a metric attribution to measure the * impact of recommendations. *

*

* For more information on recording impressions data, see Recording impressions data. For more information on creating a metric attribution see Measuring impact of * recommendations. *

* * @param recommendationId * The ID of the list of recommendations that contains the item the user interacted with. Provide a * recommendationId to have Amazon Personalize implicitly record the recommendations you show * your user as impressions data. Or provide a recommendationId if you use a metric attribution * to measure the impact of recommendations.

*

* For more information on recording impressions data, see Recording impressions data. For more information on creating a metric attribution see Measuring * impact of recommendations. */ public void setRecommendationId(String recommendationId) { this.recommendationId = recommendationId; } /** *

* The ID of the list of recommendations that contains the item the user interacted with. Provide a * recommendationId to have Amazon Personalize implicitly record the recommendations you show your user * as impressions data. Or provide a recommendationId if you use a metric attribution to measure the * impact of recommendations. *

*

* For more information on recording impressions data, see Recording impressions data. For more information on creating a metric attribution see Measuring impact of * recommendations. *

* * @return The ID of the list of recommendations that contains the item the user interacted with. Provide a * recommendationId to have Amazon Personalize implicitly record the recommendations you show * your user as impressions data. Or provide a recommendationId if you use a metric attribution * to measure the impact of recommendations.

*

* For more information on recording impressions data, see Recording impressions data. For more information on creating a metric attribution see Measuring * impact of recommendations. */ public String getRecommendationId() { return this.recommendationId; } /** *

* The ID of the list of recommendations that contains the item the user interacted with. Provide a * recommendationId to have Amazon Personalize implicitly record the recommendations you show your user * as impressions data. Or provide a recommendationId if you use a metric attribution to measure the * impact of recommendations. *

*

* For more information on recording impressions data, see Recording impressions data. For more information on creating a metric attribution see Measuring impact of * recommendations. *

* * @param recommendationId * The ID of the list of recommendations that contains the item the user interacted with. Provide a * recommendationId to have Amazon Personalize implicitly record the recommendations you show * your user as impressions data. Or provide a recommendationId if you use a metric attribution * to measure the impact of recommendations.

*

* For more information on recording impressions data, see Recording impressions data. For more information on creating a metric attribution see Measuring * impact of recommendations. * @return Returns a reference to this object so that method calls can be chained together. */ public Event withRecommendationId(String recommendationId) { setRecommendationId(recommendationId); return this; } /** *

* A list of item IDs that represents the sequence of items you have shown the user. For example, * ["itemId1", "itemId2", "itemId3"]. Provide a list of items to manually record impressions data for * an event. For more information on recording impressions data, see Recording impressions data. *

* * @return A list of item IDs that represents the sequence of items you have shown the user. For example, * ["itemId1", "itemId2", "itemId3"]. Provide a list of items to manually record impressions * data for an event. For more information on recording impressions data, see Recording impressions data. */ public java.util.List getImpression() { return impression; } /** *

* A list of item IDs that represents the sequence of items you have shown the user. For example, * ["itemId1", "itemId2", "itemId3"]. Provide a list of items to manually record impressions data for * an event. For more information on recording impressions data, see Recording impressions data. *

* * @param impression * A list of item IDs that represents the sequence of items you have shown the user. For example, * ["itemId1", "itemId2", "itemId3"]. Provide a list of items to manually record impressions * data for an event. For more information on recording impressions data, see Recording impressions data. */ public void setImpression(java.util.Collection impression) { if (impression == null) { this.impression = null; return; } this.impression = new java.util.ArrayList(impression); } /** *

* A list of item IDs that represents the sequence of items you have shown the user. For example, * ["itemId1", "itemId2", "itemId3"]. Provide a list of items to manually record impressions data for * an event. For more information on recording impressions data, see Recording impressions data. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setImpression(java.util.Collection)} or {@link #withImpression(java.util.Collection)} if you want to * override the existing values. *

* * @param impression * A list of item IDs that represents the sequence of items you have shown the user. For example, * ["itemId1", "itemId2", "itemId3"]. Provide a list of items to manually record impressions * data for an event. For more information on recording impressions data, see Recording impressions data. * @return Returns a reference to this object so that method calls can be chained together. */ public Event withImpression(String... impression) { if (this.impression == null) { setImpression(new java.util.ArrayList(impression.length)); } for (String ele : impression) { this.impression.add(ele); } return this; } /** *

* A list of item IDs that represents the sequence of items you have shown the user. For example, * ["itemId1", "itemId2", "itemId3"]. Provide a list of items to manually record impressions data for * an event. For more information on recording impressions data, see Recording impressions data. *

* * @param impression * A list of item IDs that represents the sequence of items you have shown the user. For example, * ["itemId1", "itemId2", "itemId3"]. Provide a list of items to manually record impressions * data for an event. For more information on recording impressions data, see Recording impressions data. * @return Returns a reference to this object so that method calls can be chained together. */ public Event withImpression(java.util.Collection impression) { setImpression(impression); return this; } /** *

* Contains information about the metric attribution associated with an event. For more information about metric * attributions, see Measuring impact of * recommendations. *

* * @param metricAttribution * Contains information about the metric attribution associated with an event. For more information about * metric attributions, see Measuring * impact of recommendations. */ public void setMetricAttribution(MetricAttribution metricAttribution) { this.metricAttribution = metricAttribution; } /** *

* Contains information about the metric attribution associated with an event. For more information about metric * attributions, see Measuring impact of * recommendations. *

* * @return Contains information about the metric attribution associated with an event. For more information about * metric attributions, see Measuring * impact of recommendations. */ public MetricAttribution getMetricAttribution() { return this.metricAttribution; } /** *

* Contains information about the metric attribution associated with an event. For more information about metric * attributions, see Measuring impact of * recommendations. *

* * @param metricAttribution * Contains information about the metric attribution associated with an event. For more information about * metric attributions, see Measuring * impact of recommendations. * @return Returns a reference to this object so that method calls can be chained together. */ public Event withMetricAttribution(MetricAttribution metricAttribution) { setMetricAttribution(metricAttribution); 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 (getEventId() != null) sb.append("EventId: ").append(getEventId()).append(","); if (getEventType() != null) sb.append("EventType: ").append(getEventType()).append(","); if (getEventValue() != null) sb.append("EventValue: ").append(getEventValue()).append(","); if (getItemId() != null) sb.append("ItemId: ").append("***Sensitive Data Redacted***").append(","); if (getProperties() != null) sb.append("Properties: ").append("***Sensitive Data Redacted***").append(","); if (getSentAt() != null) sb.append("SentAt: ").append(getSentAt()).append(","); if (getRecommendationId() != null) sb.append("RecommendationId: ").append(getRecommendationId()).append(","); if (getImpression() != null) sb.append("Impression: ").append("***Sensitive Data Redacted***").append(","); if (getMetricAttribution() != null) sb.append("MetricAttribution: ").append(getMetricAttribution()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof Event == false) return false; Event other = (Event) obj; if (other.getEventId() == null ^ this.getEventId() == null) return false; if (other.getEventId() != null && other.getEventId().equals(this.getEventId()) == false) return false; if (other.getEventType() == null ^ this.getEventType() == null) return false; if (other.getEventType() != null && other.getEventType().equals(this.getEventType()) == false) return false; if (other.getEventValue() == null ^ this.getEventValue() == null) return false; if (other.getEventValue() != null && other.getEventValue().equals(this.getEventValue()) == false) return false; if (other.getItemId() == null ^ this.getItemId() == null) return false; if (other.getItemId() != null && other.getItemId().equals(this.getItemId()) == false) return false; if (other.getProperties() == null ^ this.getProperties() == null) return false; if (other.getProperties() != null && other.getProperties().equals(this.getProperties()) == false) return false; if (other.getSentAt() == null ^ this.getSentAt() == null) return false; if (other.getSentAt() != null && other.getSentAt().equals(this.getSentAt()) == false) return false; if (other.getRecommendationId() == null ^ this.getRecommendationId() == null) return false; if (other.getRecommendationId() != null && other.getRecommendationId().equals(this.getRecommendationId()) == false) return false; if (other.getImpression() == null ^ this.getImpression() == null) return false; if (other.getImpression() != null && other.getImpression().equals(this.getImpression()) == false) return false; if (other.getMetricAttribution() == null ^ this.getMetricAttribution() == null) return false; if (other.getMetricAttribution() != null && other.getMetricAttribution().equals(this.getMetricAttribution()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getEventId() == null) ? 0 : getEventId().hashCode()); hashCode = prime * hashCode + ((getEventType() == null) ? 0 : getEventType().hashCode()); hashCode = prime * hashCode + ((getEventValue() == null) ? 0 : getEventValue().hashCode()); hashCode = prime * hashCode + ((getItemId() == null) ? 0 : getItemId().hashCode()); hashCode = prime * hashCode + ((getProperties() == null) ? 0 : getProperties().hashCode()); hashCode = prime * hashCode + ((getSentAt() == null) ? 0 : getSentAt().hashCode()); hashCode = prime * hashCode + ((getRecommendationId() == null) ? 0 : getRecommendationId().hashCode()); hashCode = prime * hashCode + ((getImpression() == null) ? 0 : getImpression().hashCode()); hashCode = prime * hashCode + ((getMetricAttribution() == null) ? 0 : getMetricAttribution().hashCode()); return hashCode; } @Override public Event clone() { try { return (Event) 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.EventMarshaller.getInstance().marshall(this, protocolMarshaller); } }