Class SubscriptionEventItem

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

Represents a single segment membership event.

See Also:

  • Method Details

    • profileId

      public final String profileId()

      The unique identifier of a customer profile.

      Returns:
      The unique identifier of a customer profile.

    • updatedAt

      public final Instant updatedAt()

      The timestamp of when the membership change was detected.

      Returns:
      The timestamp of when the membership change was detected.

    • eventType

      public final SubscriptionEventType eventType()

      The type of event that triggered the membership change. The following are valid values:

      • LIVE: Real-time event triggered by a profile or calculated attribute change (Classic segments only).

      • SCHEDULE: Event generated during a scheduled execution.

      If the service returns an enum value that is not available in the current SDK version, eventType will return SubscriptionEventType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventTypeAsString().

      Returns:
      The type of event that triggered the membership change. The following are valid values:

      • LIVE: Real-time event triggered by a profile or calculated attribute change (Classic segments only).

      • SCHEDULE: Event generated during a scheduled execution.

      See Also:

    • eventTypeAsString

      public final String eventTypeAsString()

      The type of event that triggered the membership change. The following are valid values:

      • LIVE: Real-time event triggered by a profile or calculated attribute change (Classic segments only).

      • SCHEDULE: Event generated during a scheduled execution.

      If the service returns an enum value that is not available in the current SDK version, eventType will return SubscriptionEventType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventTypeAsString().

      Returns:
      The type of event that triggered the membership change. The following are valid values:

      • LIVE: Real-time event triggered by a profile or calculated attribute change (Classic segments only).

      • SCHEDULE: Event generated during a scheduled execution.

      See Also:

    • event

      public final SubscriptionEvent event()

      Whether the profile joined or left the segment. The following are valid values:

      • JOINED: The profile joined the segment.

      • LEFT: The profile left the segment.

      If the service returns an enum value that is not available in the current SDK version, event will return SubscriptionEvent.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventAsString().

      Returns:
      Whether the profile joined or left the segment. The following are valid values:

      • JOINED: The profile joined the segment.

      • LEFT: The profile left the segment.

      See Also:

    • eventAsString

      public final String eventAsString()

      Whether the profile joined or left the segment. The following are valid values:

      • JOINED: The profile joined the segment.

      • LEFT: The profile left the segment.

      If the service returns an enum value that is not available in the current SDK version, event will return SubscriptionEvent.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventAsString().

      Returns:
      Whether the profile joined or left the segment. The following are valid values:

      • JOINED: The profile joined the segment.

      • LEFT: The profile left the segment.

      See Also:

    • toBuilder

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

    • builder

      public static SubscriptionEventItem.Builder builder()

    • serializableBuilderClass

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