Class PushNotificationPreferences

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

The channel membership preferences for push notification.

See Also:

  • Method Details

    • allowNotifications

      public final AllowNotifications allowNotifications()

      Enum value that indicates which push notifications to send to the requested member of a channel. ALL sends all push notifications, NONE sends no push notifications, FILTERED sends only filtered push notifications.

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

      Returns:
      Enum value that indicates which push notifications to send to the requested member of a channel. ALL sends all push notifications, NONE sends no push notifications, FILTERED sends only filtered push notifications.
      See Also:

    • allowNotificationsAsString

      public final String allowNotificationsAsString()

      Enum value that indicates which push notifications to send to the requested member of a channel. ALL sends all push notifications, NONE sends no push notifications, FILTERED sends only filtered push notifications.

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

      Returns:
      Enum value that indicates which push notifications to send to the requested member of a channel. ALL sends all push notifications, NONE sends no push notifications, FILTERED sends only filtered push notifications.
      See Also:

    • filterRule

      public final String filterRule()

      The simple JSON object used to send a subset of a push notification to the requested member.

      Returns:
      The simple JSON object used to send a subset of a push notification to the requested member.

    • toBuilder

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

    • builder

      public static PushNotificationPreferences.Builder builder()

    • serializableBuilderClass

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