Class Event

java.lang.Object
software.amazon.awssdk.services.pinpoint.model.Event
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Event.Builder,Event>
@Generated("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:

  • Method Details

    • 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()
      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 the isEmpty() 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

      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.

      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

      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()
      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 the isEmpty() 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

      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.

      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

      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()
      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 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.