Event (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.personalizeevents.model.Event

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Event
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Represents user interaction event information sent using the PutEvents API.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Event()

Constructors
Constructor and Description
`Event()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Event`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getEventId()` An ID associated with the event.
`String`	`getEventType()` The type of event, such as click or download.
`Float`	`getEventValue()` The event value that corresponds to the `EVENT_VALUE` field of the Interactions schema.
`List<String>`	`getImpression()` A list of item IDs that represents the sequence of items you have shown the user.
`String`	`getItemId()` The item ID key that corresponds to the `ITEM_ID` field of the Interactions schema.
`MetricAttribution`	`getMetricAttribution()` Contains information about the metric attribution associated with an event.
`String`	`getProperties()` A string map of event-specific data that you might choose to record.
`String`	`getRecommendationId()` The ID of the list of recommendations that contains the item the user interacted with.
`Date`	`getSentAt()` The timestamp (in Unix time) on the client side when the event occurred.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setEventId(String eventId)` An ID associated with the event.
`void`	`setEventType(String eventType)` The type of event, such as click or download.
`void`	`setEventValue(Float eventValue)` The event value that corresponds to the `EVENT_VALUE` field of the Interactions schema.
`void`	`setImpression(Collection<String> impression)` A list of item IDs that represents the sequence of items you have shown the user.
`void`	`setItemId(String itemId)` The item ID key that corresponds to the `ITEM_ID` field of the Interactions schema.
`void`	`setMetricAttribution(MetricAttribution metricAttribution)` Contains information about the metric attribution associated with an event.
`void`	`setProperties(String properties)` A string map of event-specific data that you might choose to record.
`void`	`setRecommendationId(String recommendationId)` The ID of the list of recommendations that contains the item the user interacted with.
`void`	`setSentAt(Date sentAt)` The timestamp (in Unix time) on the client side when the event occurred.
`String`	`toString()` Returns a string representation of this object.
`Event`	`withEventId(String eventId)` An ID associated with the event.
`Event`	`withEventType(String eventType)` The type of event, such as click or download.
`Event`	`withEventValue(Float eventValue)` The event value that corresponds to the `EVENT_VALUE` field of the Interactions schema.
`Event`	`withImpression(Collection<String> impression)` A list of item IDs that represents the sequence of items you have shown the user.
`Event`	`withImpression(String... impression)` A list of item IDs that represents the sequence of items you have shown the user.
`Event`	`withItemId(String itemId)` The item ID key that corresponds to the `ITEM_ID` field of the Interactions schema.
`Event`	`withMetricAttribution(MetricAttribution metricAttribution)` Contains information about the metric attribution associated with an event.
`Event`	`withProperties(String properties)` A string map of event-specific data that you might choose to record.
`Event`	`withRecommendationId(String recommendationId)` The ID of the list of recommendations that contains the item the user interacted with.
`Event`	`withSentAt(Date sentAt)` The timestamp (in Unix time) on the client side when the event occurred.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Event
```
public Event()
```
- Method Detail
  - setEventId
```
public void setEventId(String 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.
    
    Parameters:
    
    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.
  - getEventId
```
public String getEventId()
```
    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.
    
    Returns:
    
    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.
  - withEventId
```
public Event withEventId(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEventType
```
public void setEventType(String 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.
    
    Parameters:
    
    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.
  - getEventType
```
public String getEventType()
```
    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.
    
    Returns:
    
    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.
  - withEventType
```
public Event withEventType(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEventValue
```
public void setEventValue(Float eventValue)
```
    The event value that corresponds to the EVENT_VALUE field of the Interactions schema.
    
    Parameters:
    
    eventValue - The event value that corresponds to the EVENT_VALUE field of the Interactions schema.
  - getEventValue
```
public Float getEventValue()
```
    The event value that corresponds to the EVENT_VALUE field of the Interactions schema.
    
    Returns:
    
    The event value that corresponds to the EVENT_VALUE field of the Interactions schema.
  - withEventValue
```
public Event withEventValue(Float eventValue)
```
    The event value that corresponds to the EVENT_VALUE field of the Interactions schema.
    
    Parameters:
    
    eventValue - The event value that corresponds to the EVENT_VALUE field of the Interactions schema.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setItemId
```
public void setItemId(String itemId)
```
    The item ID key that corresponds to the ITEM_ID field of the Interactions schema.
    
    Parameters:
    
    itemId - The item ID key that corresponds to the ITEM_ID field of the Interactions schema.
  - getItemId
```
public String getItemId()
```
    The item ID key that corresponds to the ITEM_ID field of the Interactions schema.
    
    Returns:
    
    The item ID key that corresponds to the ITEM_ID field of the Interactions schema.
  - withItemId
```
public Event withItemId(String itemId)
```
    The item ID key that corresponds to the ITEM_ID field of the Interactions schema.
    
    Parameters:
    
    itemId - The item ID key that corresponds to the ITEM_ID field of the Interactions schema.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProperties
```
public void setProperties(String 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.
    
    Parameters:
    
    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.
  - getProperties
```
public String getProperties()
```
    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"}'.
    
    Returns:
    
    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.
  - withProperties
```
public Event withProperties(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSentAt
```
public void setSentAt(Date sentAt)
```
    The timestamp (in Unix time) on the client side when the event occurred.
    
    Parameters:
    
    sentAt - The timestamp (in Unix time) on the client side when the event occurred.
  - getSentAt
```
public Date getSentAt()
```
    The timestamp (in Unix time) on the client side when the event occurred.
    
    Returns:
    
    The timestamp (in Unix time) on the client side when the event occurred.
  - withSentAt
```
public Event withSentAt(Date sentAt)
```
    The timestamp (in Unix time) on the client side when the event occurred.
    
    Parameters:
    
    sentAt - The timestamp (in Unix time) on the client side when the event occurred.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRecommendationId
```
public void setRecommendationId(String 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.
    
    Parameters:
    
    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.
  - getRecommendationId
```
public String getRecommendationId()
```
    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.
    
    Returns:
    
    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.
  - withRecommendationId
```
public Event withRecommendationId(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getImpression
```
public List<String> getImpression()
```
    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.
    
    Returns:
    
    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.
  - setImpression
```
public void setImpression(Collection<String> 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.
    
    Parameters:
    
    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.
  - withImpression
```
public Event withImpression(String... 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 setImpression(java.util.Collection) or withImpression(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withImpression
```
public Event withImpression(Collection<String> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetricAttribution
```
public void setMetricAttribution(MetricAttribution metricAttribution)
```
    Contains information about the metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.
    
    Parameters:
    
    metricAttribution - Contains information about the metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.
  - getMetricAttribution
```
public MetricAttribution getMetricAttribution()
```
    Contains information about the metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.
    
    Returns:
    
    Contains information about the metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.
  - withMetricAttribution
```
public Event withMetricAttribution(MetricAttribution metricAttribution)
```
    Contains information about the metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.
    
    Parameters:
    
    metricAttribution - Contains information about the metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Event clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Event

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Event

Method Detail

setEventId

getEventId

withEventId

setEventType

getEventType

withEventType

setEventValue

getEventValue

withEventValue

setItemId

getItemId

withItemId

setProperties

getProperties

withProperties

setSentAt

getSentAt

withSentAt

setRecommendationId

getRecommendationId

withRecommendationId

getImpression

setImpression

withImpression

withImpression

setMetricAttribution

getMetricAttribution

withMetricAttribution

toString

equals

hashCode

clone

marshall