Package com.softlayer.api.service.notification.user

Class Subscriber

java.lang.Object
com.softlayer.api.Type
com.softlayer.api.service.Entity
com.softlayer.api.service.notification.user.Subscriber
Direct Known Subclasses:
Billing, Mobile
@ApiType("SoftLayer_Notification_User_Subscriber")
public class Subscriber
extends Entity
A notification subscriber will have details pertaining to the subscriber's notification subscription. You can receive details such as preferences, details of the preferences, delivery methods and the delivery methods for the subscriber.

NOTE: There are preferences and delivery methods that cannot be modified. Also, there are some subscriptions that are required.
See Also:
SoftLayer_Notification_User_Subscriber

  • Field Details

    • deliveryMethods

      @ApiProperty protected List<Method> deliveryMethods
      The delivery methods used to send the subscribed notification.

    • notification

      @ApiProperty protected Notification notification
      Notification subscribed to.

    • preferences

      @ApiProperty protected List<Preference> preferences
      Associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold.

    • preferencesDetails

      @ApiProperty protected List<Preference> preferencesDetails
      Preference details such as description, minimum and maximum limits, default value and unit of measure.

    • resourceRecord

      @ApiProperty protected Resource resourceRecord
      The subscriber id to resource id mapping.

    • userRecord

      @ApiProperty protected Customer userRecord
      User record for the subscription.

    • active

      @ApiProperty(canBeNullOrNotSet=true) protected Long active
      The current status of the subscription.

    • activeSpecified

      protected boolean activeSpecified

    • id

      @ApiProperty(canBeNullOrNotSet=true) protected Long id
      Unique identifier of the subscriber that will receive the alerts.

    • idSpecified

      protected boolean idSpecified

    • notificationId

      @ApiProperty(canBeNullOrNotSet=true) protected Long notificationId
      Unique identifier of the notification subscribed to.

    • notificationIdSpecified

      protected boolean notificationIdSpecified

    • userRecordId

      @ApiProperty(canBeNullOrNotSet=true) protected Long userRecordId
      Unique identifier of the user the subscription is for.

    • userRecordIdSpecified

      protected boolean userRecordIdSpecified

    • deliveryMethodCount

      @ApiProperty protected Long deliveryMethodCount
      A count of the delivery methods used to send the subscribed notification.

    • preferenceCount

      @ApiProperty protected Long preferenceCount
      A count of associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold.

    • preferencesDetailCount

      @ApiProperty protected Long preferencesDetailCount
      A count of preference details such as description, minimum and maximum limits, default value and unit of measure.

  • Constructor Details

    • Subscriber

      public Subscriber()

  • Method Details

    • getDeliveryMethods

      public List<Method> getDeliveryMethods()

    • getNotification

      public Notification getNotification()

    • setNotification

      public void setNotification​(Notification notification)

    • getPreferences

      public List<Preference> getPreferences()

    • getPreferencesDetails

      public List<Preference> getPreferencesDetails()

    • getResourceRecord

      public Resource getResourceRecord()

    • setResourceRecord

      public void setResourceRecord​(Resource resourceRecord)

    • getUserRecord

      public Customer getUserRecord()

    • setUserRecord

      public void setUserRecord​(Customer userRecord)

    • getActive

      public Long getActive()

    • setActive

      public void setActive​(Long active)

    • isActiveSpecified

      public boolean isActiveSpecified()

    • unsetActive

      public void unsetActive()

    • getId

      public Long getId()

    • setId

      public void setId​(Long id)

    • isIdSpecified

      public boolean isIdSpecified()

    • unsetId

      public void unsetId()

    • getNotificationId

      public Long getNotificationId()

    • setNotificationId

      public void setNotificationId​(Long notificationId)

    • isNotificationIdSpecified

      public boolean isNotificationIdSpecified()

    • unsetNotificationId

      public void unsetNotificationId()

    • getUserRecordId

      public Long getUserRecordId()

    • setUserRecordId

      public void setUserRecordId​(Long userRecordId)

    • isUserRecordIdSpecified

      public boolean isUserRecordIdSpecified()

    • unsetUserRecordId

      public void unsetUserRecordId()

    • getDeliveryMethodCount

      public Long getDeliveryMethodCount()

    • setDeliveryMethodCount

      public void setDeliveryMethodCount​(Long deliveryMethodCount)

    • getPreferenceCount

      public Long getPreferenceCount()

    • setPreferenceCount

      public void setPreferenceCount​(Long preferenceCount)

    • getPreferencesDetailCount

      public Long getPreferencesDetailCount()

    • setPreferencesDetailCount

      public void setPreferencesDetailCount​(Long preferencesDetailCount)

    • asService

      public Subscriber.Service asService​(ApiClient client)

    • service

      public static Subscriber.Service service​(ApiClient client)

    • service

      public static Subscriber.Service service​(ApiClient client, Long id)