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>

Model for creating or updating events.

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
Map<String,String>	attributes() Custom attributes that are associated with the event you're adding or updating.
static Event.Builder	builder()
String	clientSdkVersion() The version of the SDK that's running on the client device.
boolean	equals(Object obj)
String	eventType() The name of the custom event that you're recording.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,Double>	metrics() Custom metrics related to the event.
List<SdkField<?>>	sdkFields()
static Class<? extends Event.Builder>	serializableBuilderClass()
Session	session() Information about the session in which the event occurred.
String	timestamp() The date and time when the event occurred, in ISO 8601 format.
Event.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

attributes

public Map<String,String> attributes()

Custom attributes that are associated with the event you're adding or updating.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Custom attributes that are associated with the event you're adding or updating.

clientSdkVersion

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

The name of the custom event that you're recording.

Returns:

The name of the custom event that you're recording.

metrics

public Map<String,Double> metrics()

Custom metrics related to the event.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Custom metrics related to the event.

session

public Session session()

Information about the session in which the event occurred.

Returns:

Information about the session in which the event occurred.

timestamp

public String timestamp()

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.

toBuilder

public Event.Builder 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 interface ToCopyableBuilder<Event.Builder,Event>

Returns:

a builder for type T

builder

public static Event.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.