Class UserNotificationSummary

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

Summary information about a notification for a specific user, including the user's read status.

See Also:

  • Method Details

    • notificationId

      public final String notificationId()

      The unique identifier for the notification.

      Returns:
      The unique identifier for the notification.

    • notificationStatus

      public final NotificationStatus notificationStatus()

      The status of the notification for this user. Valid values are READ, UNREAD, and HIDDEN.

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

      Returns:
      The status of the notification for this user. Valid values are READ, UNREAD, and HIDDEN.
      See Also:

    • notificationStatusAsString

      public final String notificationStatusAsString()

      The status of the notification for this user. Valid values are READ, UNREAD, and HIDDEN.

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

      Returns:
      The status of the notification for this user. Valid values are READ, UNREAD, and HIDDEN.
      See Also:

    • instanceId

      public final String instanceId()

      The identifier of the Amazon Connect instance.

      Returns:
      The identifier of the Amazon Connect instance.

    • recipientId

      public final String recipientId()

      The identifier of the recipient user.

      Returns:
      The identifier of the recipient user.

    • content

      public final Map<LocaleCode,String> content()

      The localized content of the notification.

      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 hasContent() method.

      Returns:
      The localized content of the notification.

    • hasContent

      public final boolean hasContent()
      For responses, this returns true if the service returned a value for the Content 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.

    • contentAsStrings

      public final Map<String,String> contentAsStrings()

      The localized content of the notification.

      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 hasContent() method.

      Returns:
      The localized content of the notification.

    • priority

      public final NotificationPriority priority()

      The priority level of the notification.

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

      Returns:
      The priority level of the notification.
      See Also:

    • priorityAsString

      public final String priorityAsString()

      The priority level of the notification.

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

      Returns:
      The priority level of the notification.
      See Also:

    • source

      public final NotificationSource source()

      The source that created the notification. Valid values are CUSTOMER, RULES, and SYSTEM.

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

      Returns:
      The source that created the notification. Valid values are CUSTOMER, RULES, and SYSTEM.
      See Also:

    • sourceAsString

      public final String sourceAsString()

      The source that created the notification. Valid values are CUSTOMER, RULES, and SYSTEM.

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

      Returns:
      The source that created the notification. Valid values are CUSTOMER, RULES, and SYSTEM.
      See Also:

    • createdAt

      public final Instant createdAt()

      The timestamp when the notification was created.

      Returns:
      The timestamp when the notification was created.

    • expiresAt

      public final Instant expiresAt()

      The timestamp when the notification expires.

      Returns:
      The timestamp when the notification expires.

    • toBuilder

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

    • builder

      public static UserNotificationSummary.Builder builder()

    • serializableBuilderClass

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