Event (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pinpoint.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
```
Model for creating or updating events.

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`	`addAttributesEntry(String key, String value)`
`Event`	`addMetricsEntry(String key, Double value)`
`Event`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`Event`	`clearMetricsEntries()` Removes all the entries added into Metrics.
`Event`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getAttributes()` Custom attributes that are associated with the event you're adding or updating.
`String`	`getClientSdkVersion()` The version of the SDK that's running on the client device.
`String`	`getEventType()` The name of the custom event that you're recording.
`Map<String,Double>`	`getMetrics()` Event metrics
`Session`	`getSession()` The session
`String`	`getTimestamp()` The date and time when the event occurred, in ISO 8601 format.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAttributes(Map<String,String> attributes)` Custom attributes that are associated with the event you're adding or updating.
`void`	`setClientSdkVersion(String clientSdkVersion)` The version of the SDK that's running on the client device.
`void`	`setEventType(String eventType)` The name of the custom event that you're recording.
`void`	`setMetrics(Map<String,Double> metrics)` Event metrics
`void`	`setSession(Session session)` The session
`void`	`setTimestamp(String timestamp)` The date and time when the event occurred, in ISO 8601 format.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Event`	`withAttributes(Map<String,String> attributes)` Custom attributes that are associated with the event you're adding or updating.
`Event`	`withClientSdkVersion(String clientSdkVersion)` The version of the SDK that's running on the client device.
`Event`	`withEventType(String eventType)` The name of the custom event that you're recording.
`Event`	`withMetrics(Map<String,Double> metrics)` Event metrics
`Event`	`withSession(Session session)` The session
`Event`	`withTimestamp(String timestamp)` The date and time when the event occurred, in ISO 8601 format.

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

- Constructor Detail
  - Event
```
public Event()
```
- Method Detail
  - getAttributes
```
public Map<String,String> getAttributes()
```
    Custom attributes that are associated with the event you're adding or updating.
    
    Returns:
    
    Custom attributes that are associated with the event you're adding or updating.
  - setAttributes
```
public void setAttributes(Map<String,String> attributes)
```
    Custom attributes that are associated with the event you're adding or updating.
    
    Parameters:
    
    attributes - Custom attributes that are associated with the event you're adding or updating.
  - withAttributes
```
public Event withAttributes(Map<String,String> attributes)
```
    Custom attributes that are associated with the event you're adding or updating.
    
    Parameters:
    
    attributes - Custom attributes that are associated with the event you're adding or updating.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAttributesEntry
```
public Event addAttributesEntry(String key,
                                String value)
```
  - clearAttributesEntries
```
public Event clearAttributesEntries()
```
    Removes all the entries added into Attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientSdkVersion
```
public void setClientSdkVersion(String clientSdkVersion)
```
    The version of the SDK that's running on the client device.
    
    Parameters:
    
    clientSdkVersion - The version of the SDK that's running on the client device.
  - getClientSdkVersion
```
public String getClientSdkVersion()
```
    The version of the SDK that's running on the client device.
    
    Returns:
    
    The version of the SDK that's running on the client device.
  - withClientSdkVersion
```
public Event withClientSdkVersion(String clientSdkVersion)
```
    The version of the SDK that's running on the client device.
    
    Parameters:
    
    clientSdkVersion - The version of the SDK that's running on the client device.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEventType
```
public void setEventType(String eventType)
```
    The name of the custom event that you're recording.
    
    Parameters:
    
    eventType - The name of the custom event that you're recording.
  - getEventType
```
public String getEventType()
```
    The name of the custom event that you're recording.
    
    Returns:
    
    The name of the custom event that you're recording.
  - withEventType
```
public Event withEventType(String eventType)
```
    The name of the custom event that you're recording.
    
    Parameters:
    
    eventType - The name of the custom event that you're recording.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getMetrics
```
public Map<String,Double> getMetrics()
```
    Event metrics
    
    Returns:
    
    Event metrics
  - setMetrics
```
public void setMetrics(Map<String,Double> metrics)
```
    Event metrics
    
    Parameters:
    
    metrics - Event metrics
  - withMetrics
```
public Event withMetrics(Map<String,Double> metrics)
```
    Event metrics
    
    Parameters:
    
    metrics - Event metrics
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addMetricsEntry
```
public Event addMetricsEntry(String key,
                             Double value)
```
  - clearMetricsEntries
```
public Event clearMetricsEntries()
```
    Removes all the entries added into Metrics.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSession
```
public void setSession(Session session)
```
    The session
    
    Parameters:
    
    session - The session
  - getSession
```
public Session getSession()
```
    The session
    
    Returns:
    
    The session
  - withSession
```
public Event withSession(Session session)
```
    The session
    
    Parameters:
    
    session - The session
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimestamp
```
public void setTimestamp(String timestamp)
```
    The date and time when the event occurred, in ISO 8601 format.
    
    Parameters:
    
    timestamp - The date and time when the event occurred, in ISO 8601 format.
  - getTimestamp
```
public String getTimestamp()
```
    The date and time when the event occurred, in ISO 8601 format.
    
    Returns:
    
    The date and time when the event occurred, in ISO 8601 format.
  - withTimestamp
```
public Event withTimestamp(String timestamp)
```
    The date and time when the event occurred, in ISO 8601 format.
    
    Parameters:
    
    timestamp - The date and time when the event occurred, in ISO 8601 format.
    
    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; useful for testing and debugging.
    
    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

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

setClientSdkVersion

getClientSdkVersion

withClientSdkVersion

setEventType

getEventType

withEventType

getMetrics

setMetrics

withMetrics

addMetricsEntry

clearMetricsEntries

setSession

getSession

withSession

setTimestamp

getTimestamp

withTimestamp

toString

equals

hashCode

clone

marshall