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.
`String`	`getProperties()` A string map of event-specific data that you might choose to record.
`Date`	`getSentAt()` The timestamp 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.
`void`	`setProperties(String properties)` A string map of event-specific data that you might choose to record.
`void`	`setSentAt(Date sentAt)` The timestamp 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.
`Event`	`withProperties(String properties)` A string map of event-specific data that you might choose to record.
`Event`	`withSentAt(Date sentAt)` The timestamp 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. This property corresponds to the EVENT_TYPE field of the Interactions schema.
    
    Parameters:
    
    eventType - The type of event. This property corresponds to the EVENT_TYPE field of the Interactions schema.
  - getEventType
```
public String getEventType()
```
    The type of event. This property corresponds to the EVENT_TYPE field of the Interactions schema.
    
    Returns:
    
    The type of event. This property corresponds to the EVENT_TYPE field of the Interactions schema.
  - withEventType
```
public Event withEventType(String eventType)
```
    The type of event. This property corresponds to the EVENT_TYPE field of the Interactions schema.
    
    Parameters:
    
    eventType - The type of event. This property corresponds to the EVENT_TYPE 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, you might send the movie ID and rating, and the number of movie ratings made by the user.
    
    Each item in the map consists of a key-value pair. For example,
    
    {"itemId": "movie1"}
    
    {"itemId": "movie2", "eventValue": "4.5"}
    
    {"itemId": "movie3", "eventValue": "3", "numberOfRatings": "12"}
    
    The keys use camel case names that match the fields in the Interactions schema. The itemId and eventValue keys correspond to the ITEM_ID and EVENT_VALUE fields. In the above example, the eventType might be 'MovieRating' with eventValue being the rating. 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, you might send the movie ID and rating, and the number of movie ratings made by the user.
    
    Each item in the map consists of a key-value pair. For example,
    
    {"itemId": "movie1"}
    
    {"itemId": "movie2", "eventValue": "4.5"}
    
    {"itemId": "movie3", "eventValue": "3", "numberOfRatings": "12"}
    
    The keys use camel case names that match the fields in the Interactions schema. The itemId and eventValue keys correspond to the ITEM_ID and EVENT_VALUE fields. In the above example, the eventType might be 'MovieRating' with eventValue being the rating. 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, you might send the movie ID and rating, and the number of movie ratings made by the user.
    
    Each item in the map consists of a key-value pair. For example,
    
    {"itemId": "movie1"}
    
    {"itemId": "movie2", "eventValue": "4.5"}
    
    {"itemId": "movie3", "eventValue": "3", "numberOfRatings": "12"}
    
    The keys use camel case names that match the fields in the Interactions schema. The itemId and eventValue keys correspond to the ITEM_ID and EVENT_VALUE fields. In the above example, the eventType might be 'MovieRating' with eventValue being the rating. 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, you might send the movie ID and rating, and the number of movie ratings made by the user.
    
    Each item in the map consists of a key-value pair. For example,
    
    {"itemId": "movie1"}
    
    {"itemId": "movie2", "eventValue": "4.5"}
    
    {"itemId": "movie3", "eventValue": "3", "numberOfRatings": "12"}
    
    The keys use camel case names that match the fields in the Interactions schema. The itemId and eventValue keys correspond to the ITEM_ID and EVENT_VALUE fields. In the above example, the eventType might be 'MovieRating' with eventValue being the rating. 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, you might send the movie ID and rating, and the number of movie ratings made by the user.
    
    Each item in the map consists of a key-value pair. For example,
    
    {"itemId": "movie1"}
    
    {"itemId": "movie2", "eventValue": "4.5"}
    
    {"itemId": "movie3", "eventValue": "3", "numberOfRatings": "12"}
    
    The keys use camel case names that match the fields in the Interactions schema. The itemId and eventValue keys correspond to the ITEM_ID and EVENT_VALUE fields. In the above example, the eventType might be 'MovieRating' with eventValue being the rating. 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, you might send the movie ID and rating, and the number of movie ratings made by the user.
    
    Each item in the map consists of a key-value pair. For example,
    
    {"itemId": "movie1"}
    
    {"itemId": "movie2", "eventValue": "4.5"}
    
    {"itemId": "movie3", "eventValue": "3", "numberOfRatings": "12"}
    
    The keys use camel case names that match the fields in the Interactions schema. The itemId and eventValue keys correspond to the ITEM_ID and EVENT_VALUE fields. In the above example, the eventType might be 'MovieRating' with eventValue being the rating. 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 on the client side when the event occurred.
    
    Parameters:
    
    sentAt - The timestamp on the client side when the event occurred.
  - getSentAt
```
public Date getSentAt()
```
    The timestamp on the client side when the event occurred.
    
    Returns:
    
    The timestamp on the client side when the event occurred.
  - withSentAt
```
public Event withSentAt(Date sentAt)
```
    The timestamp on the client side when the event occurred.
    
    Parameters:
    
    sentAt - The timestamp on the client side when the event occurred.
    
    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

setProperties

getProperties

withProperties

setSentAt

getSentAt

withSentAt

toString

equals

hashCode

clone

marshall