Class Event
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Event.Builder,
Event>
Specifies information about an event that reports data to Amazon Pinpoint.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The package name of the app that's recording the event.final String
appTitle()
The title of the app that's recording the event.final String
The version number of the app that's recording the event.One or more custom attributes that are associated with the event.static Event.Builder
builder()
final String
The version of the SDK that's running on the client device.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The name of the event.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Attributes property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Metrics property.metrics()
One or more custom metrics that are associated with the event.final String
sdkName()
The name of the SDK that's being used to record the event.static Class
<? extends Event.Builder> final Session
session()
Information about the session in which the event occurred.final String
The date and time, in ISO 8601 format, when the event occurred.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
appPackageName
The package name of the app that's recording the event.
- Returns:
- The package name of the app that's recording the event.
-
appTitle
The title of the app that's recording the event.
- Returns:
- The title of the app that's recording the event.
-
appVersionCode
The version number of the app that's recording the event.
- Returns:
- The version number of the app that's recording the event.
-
hasAttributes
public final boolean hasAttributes()For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
attributes
One or more custom attributes that are associated with the event.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAttributes()
method.- Returns:
- One or more custom attributes that are associated with the event.
-
clientSdkVersion
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.
-
eventType
The name of the event.
- Returns:
- The name of the event.
-
hasMetrics
public final boolean hasMetrics()For responses, this returns true if the service returned a value for the Metrics property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
metrics
One or more custom metrics that are associated with the event.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMetrics()
method.- Returns:
- One or more custom metrics that are associated with the event.
-
sdkName
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.
-
session
Information about the session in which the event occurred.
- Returns:
- Information about the session in which the event occurred.
-
timestamp
The date and time, in ISO 8601 format, when the event occurred.
- Returns:
- The date and time, in ISO 8601 format, when the event occurred.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Event.Builder,
Event> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-