Event (AWS SDK for Android

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

All Implemented Interfaces:

java.io.Serializable
```
public class Event
extends java.lang.Object
implements java.io.Serializable
```
Model for creating or updating events.

See Also:

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(java.lang.String key, java.lang.String value)` Custom attributes that are associated with the event you're adding or updating.
`Event`	`addMetricsEntry(java.lang.String key, java.lang.Double value)` Custom metrics related to the event.
`Event`	`clearAttributesEntries()` Removes all the entries added into Attributes.
`Event`	`clearMetricsEntries()` Removes all the entries added into Metrics.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getAppPackageName()` The package name associated with the app that's recording the event.
`java.lang.String`	`getAppTitle()` The title of the app that's recording the event.
`java.lang.String`	`getAppVersionCode()` The version number of the app that's recording the event.
`java.util.Map<java.lang.String,java.lang.String>`	`getAttributes()` Custom attributes that are associated with the event you're adding or updating.
`java.lang.String`	`getClientSdkVersion()` The version of the SDK that's running on the client device.
`java.lang.String`	`getEventType()` The name of the custom event that you're recording.
`java.util.Map<java.lang.String,java.lang.Double>`	`getMetrics()` Custom metrics related to the event.
`java.lang.String`	`getSdkName()` The name of the SDK that's being used to record the event.
`Session`	`getSession()` Information about the session in which the event occurred.
`java.lang.String`	`getTimestamp()` The date and time when the event occurred, in ISO 8601 format.
`int`	`hashCode()`
`void`	`setAppPackageName(java.lang.String appPackageName)` The package name associated with the app that's recording the event.
`void`	`setAppTitle(java.lang.String appTitle)` The title of the app that's recording the event.
`void`	`setAppVersionCode(java.lang.String appVersionCode)` The version number of the app that's recording the event.
`void`	`setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)` Custom attributes that are associated with the event you're adding or updating.
`void`	`setClientSdkVersion(java.lang.String clientSdkVersion)` The version of the SDK that's running on the client device.
`void`	`setEventType(java.lang.String eventType)` The name of the custom event that you're recording.
`void`	`setMetrics(java.util.Map<java.lang.String,java.lang.Double> metrics)` Custom metrics related to the event.
`void`	`setSdkName(java.lang.String sdkName)` The name of the SDK that's being used to record the event.
`void`	`setSession(Session session)` Information about the session in which the event occurred.
`void`	`setTimestamp(java.lang.String timestamp)` The date and time when the event occurred, in ISO 8601 format.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Event`	`withAppPackageName(java.lang.String appPackageName)` The package name associated with the app that's recording the event.
`Event`	`withAppTitle(java.lang.String appTitle)` The title of the app that's recording the event.
`Event`	`withAppVersionCode(java.lang.String appVersionCode)` The version number of the app that's recording the event.
`Event`	`withAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)` Custom attributes that are associated with the event you're adding or updating.
`Event`	`withClientSdkVersion(java.lang.String clientSdkVersion)` The version of the SDK that's running on the client device.
`Event`	`withEventType(java.lang.String eventType)` The name of the custom event that you're recording.
`Event`	`withMetrics(java.util.Map<java.lang.String,java.lang.Double> metrics)` Custom metrics related to the event.
`Event`	`withSdkName(java.lang.String sdkName)` The name of the SDK that's being used to record the event.
`Event`	`withSession(Session session)` Information about the session in which the event occurred.
`Event`	`withTimestamp(java.lang.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
  - getAppPackageName
```
public java.lang.String getAppPackageName()
```
    The package name associated with the app that's recording the event.
    
    Returns:
    
    The package name associated with the app that's recording the event.
  - setAppPackageName
```
public void setAppPackageName(java.lang.String appPackageName)
```
    The package name associated with the app that's recording the event.
    
    Parameters:
    
    appPackageName - The package name associated with the app that's recording the event.
  - withAppPackageName
```
public Event withAppPackageName(java.lang.String appPackageName)
```
    The package name associated with the app that's recording the event.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    appPackageName - The package name associated with the app that's recording the event.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAppTitle
```
public java.lang.String getAppTitle()
```
    The title of the app that's recording the event.
    
    Returns:
    
    The title of the app that's recording the event.
  - setAppTitle
```
public void setAppTitle(java.lang.String appTitle)
```
    The title of the app that's recording the event.
    
    Parameters:
    
    appTitle - The title of the app that's recording the event.
  - withAppTitle
```
public Event withAppTitle(java.lang.String appTitle)
```
    The title of the app that's recording the event.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    appTitle - The title of the app that's recording the event.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAppVersionCode
```
public java.lang.String getAppVersionCode()
```
    The version number of the app that's recording the event.
    
    Returns:
    
    The version number of the app that's recording the event.
  - setAppVersionCode
```
public void setAppVersionCode(java.lang.String appVersionCode)
```
    The version number of the app that's recording the event.
    
    Parameters:
    
    appVersionCode - The version number of the app that's recording the event.
  - withAppVersionCode
```
public Event withAppVersionCode(java.lang.String appVersionCode)
```
    The version number of the app that's recording the event.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    appVersionCode - The version number of the app that's recording the event.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAttributes
```
public java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.String> attributes)
```
    Custom attributes that are associated with the event you're adding or updating.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    attributes - Custom attributes that are associated with the event you're adding or updating.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addAttributesEntry
```
public Event addAttributesEntry(java.lang.String key,
                                java.lang.String value)
```
    Custom attributes that are associated with the event you're adding or updating.
    The method adds a new key-value pair into Attributes parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into Attributes.
    
    value - The corresponding value of the entry to be added into Attributes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearAttributesEntries
```
public Event clearAttributesEntries()
```
    Removes all the entries added into Attributes.
    Returns a reference to this object so that method calls can be chained together.
  - getClientSdkVersion
```
public java.lang.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.
  - setClientSdkVersion
```
public void setClientSdkVersion(java.lang.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.
  - withClientSdkVersion
```
public Event withClientSdkVersion(java.lang.String clientSdkVersion)
```
    The version of the SDK that's running on the client device.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    clientSdkVersion - The version of the SDK that's running on the client device.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEventType
```
public java.lang.String getEventType()
```
    The name of the custom event that you're recording.
    
    Returns:
    
    The name of the custom event that you're recording.
  - setEventType
```
public void setEventType(java.lang.String eventType)
```
    The name of the custom event that you're recording.
    
    Parameters:
    
    eventType - The name of the custom event that you're recording.
  - withEventType
```
public Event withEventType(java.lang.String eventType)
```
    The name of the custom event that you're recording.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    eventType - The name of the custom event that you're recording.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMetrics
```
public java.util.Map<java.lang.String,java.lang.Double> getMetrics()
```
    Custom metrics related to the event.
    
    Returns:
    
    Custom metrics related to the event.
  - setMetrics
```
public void setMetrics(java.util.Map<java.lang.String,java.lang.Double> metrics)
```
    Custom metrics related to the event.
    
    Parameters:
    
    metrics - Custom metrics related to the event.
  - withMetrics
```
public Event withMetrics(java.util.Map<java.lang.String,java.lang.Double> metrics)
```
    Custom metrics related to the event.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    metrics - Custom metrics related to the event.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addMetricsEntry
```
public Event addMetricsEntry(java.lang.String key,
                             java.lang.Double value)
```
    Custom metrics related to the event.
    The method adds a new key-value pair into Metrics parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into Metrics.
    
    value - The corresponding value of the entry to be added into Metrics.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearMetricsEntries
```
public Event clearMetricsEntries()
```
    Removes all the entries added into Metrics.
    Returns a reference to this object so that method calls can be chained together.
  - getSdkName
```
public java.lang.String getSdkName()
```
    The name of the SDK that's being used to record the event.
    
    Returns:
    
    The name of the SDK that's being used to record the event.
  - setSdkName
```
public void setSdkName(java.lang.String sdkName)
```
    The name of the SDK that's being used to record the event.
    
    Parameters:
    
    sdkName - The name of the SDK that's being used to record the event.
  - withSdkName
```
public Event withSdkName(java.lang.String sdkName)
```
    The name of the SDK that's being used to record the event.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    sdkName - The name of the SDK that's being used to record the event.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSession
```
public Session getSession()
```
    Information about the session in which the event occurred.
    
    Returns:
    
    Information about the session in which the event occurred.
  - setSession
```
public void setSession(Session session)
```
    Information about the session in which the event occurred.
    
    Parameters:
    
    session - Information about the session in which the event occurred.
  - withSession
```
public Event withSession(Session session)
```
    Information about the session in which the event occurred.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    session - Information about the session in which the event occurred.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTimestamp
```
public java.lang.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.
  - setTimestamp
```
public void setTimestamp(java.lang.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.
  - withTimestamp
```
public Event withTimestamp(java.lang.String timestamp)
```
    The date and time when the event occurred, in ISO 8601 format.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    timestamp - The date and time when the event occurred, in ISO 8601 format.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class Event

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Event

Method Detail

getAppPackageName

setAppPackageName

withAppPackageName

getAppTitle

setAppTitle

withAppTitle

getAppVersionCode

setAppVersionCode

withAppVersionCode

getAttributes

setAttributes

withAttributes

addAttributesEntry

clearAttributesEntries

getClientSdkVersion

setClientSdkVersion

withClientSdkVersion

getEventType

setEventType

withEventType

getMetrics

setMetrics

withMetrics

addMetricsEntry

clearMetricsEntries

getSdkName

setSdkName

withSdkName

getSession

setSession

withSession

getTimestamp

setTimestamp

withTimestamp

toString

hashCode

equals