Class RumEvent

java.lang.Object
software.amazon.awssdk.services.rum.model.RumEvent
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RumEvent.Builder,RumEvent>
@Generated("software.amazon.awssdk:codegen") public final class RumEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RumEvent.Builder,RumEvent>

A structure that contains the information for one performance event that RUM collects from a user session with your application.

See Also:

  • Method Details

    • details

      public final String details()

      A string containing details about the event.

      Returns:
      A string containing details about the event.

    • id

      public final String id()

      A unique ID for this event.

      Returns:
      A unique ID for this event.

    • metadata

      public final String metadata()

      Metadata about this event, which contains a JSON serialization of the identity of the user for this session. The user information comes from information such as the HTTP user-agent request header and document interface.

      Returns:
      Metadata about this event, which contains a JSON serialization of the identity of the user for this session. The user information comes from information such as the HTTP user-agent request header and document interface.

    • timestamp

      public final Instant timestamp()

      The exact time that this event occurred.

      Returns:
      The exact time that this event occurred.

    • type

      public final String type()

      The JSON schema that denotes the type of event this is, such as a page load or a new session.

      Returns:
      The JSON schema that denotes the type of event this is, such as a page load or a new session.

    • toBuilder

      public RumEvent.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<RumEvent.Builder,RumEvent>
      Returns:
      a builder for type T

    • builder

      public static RumEvent.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RumEvent.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.