software.amazon.awssdk.services.pinpoint.model

Class Event

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.Event

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Event.Builder,Event>

@Generated(value="software.amazon.awssdk:codegen")
public final class Event
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Event.Builder,Event>

Specifies information about an event that reports data to Amazon Pinpoint.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Event.Builder

Method Summary

Modifier and Type	Method and Description
String	appPackageName() The package name of the app that's recording the event.
String	appTitle() The title of the app that's recording the event.
String	appVersionCode() The version number of the app that's recording the event.
Map<String,String>	attributes() One or more custom attributes that are associated with the event.
static Event.Builder	builder()
String	clientSdkVersion() The version of the SDK that's running on the client device.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eventType() The name of the event.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAttributes() Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasMetrics() Returns true if the Metrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Map<String,Double>	metrics() One or more custom metrics that are associated with the event.
List<SdkField<?>>	sdkFields()
String	sdkName() The name of the SDK that's being used to record the event.
static Class<? extends Event.Builder>	serializableBuilderClass()
Session	session() Information about the session in which the event occurred.
String	timestamp() The date and time, in ISO 8601 format, when the event occurred.
Event.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

appPackageName

public final String 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

public final String appTitle()

The title of the app that's recording the event.

Returns:

The title of the app that's recording the event.

appVersionCode

public final String 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()

Returns true if the Attributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

attributes

public final Map<String,String> 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.

You can use hasAttributes() to see if a value was sent in this field.

Returns:

One or more custom attributes that are associated with the event.

clientSdkVersion

public final String 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

public final String eventType()

The name of the event.

Returns:

The name of the event.

hasMetrics

public final boolean hasMetrics()

Returns true if the Metrics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

metrics

public final Map<String,Double> 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.

You can use hasMetrics() to see if a value was sent in this field.

Returns:

One or more custom metrics that are associated with the event.

sdkName

public final String 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

public final Session session()

Information about the session in which the event occurred.

Returns:

Information about the session in which the event occurred.

timestamp

public final String 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

public Event.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Event.Builder,Event>

builder

public static Event.Builder builder()

serializableBuilderClass

public static Class<? extends Event.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo