Package com.softlayer.api.service.notification

Class Preference

java.lang.Object
com.softlayer.api.Type
com.softlayer.api.service.Entity
com.softlayer.api.service.notification.Preference
@ApiType("SoftLayer_Notification_Preference")
public class Preference
extends Entity
Retrieve details for preferences. Preferences are used to allow the subscriber to modify their subscription in various ways. Details such as friendly name, keyname maximum and minimum values can be retrieved. These provide details to help configure subscriber preferences correctly.
See Also:
SoftLayer_Notification_Preference

  • Field Details

    • description

      @ApiProperty(canBeNullOrNotSet=true) protected String description
      A description of what the preference is used for.

    • descriptionSpecified

      protected boolean descriptionSpecified

    • id

      @ApiProperty(canBeNullOrNotSet=true) protected Long id
      Unique identifier for the notification preference.

    • idSpecified

      protected boolean idSpecified

    • keyName

      @ApiProperty(canBeNullOrNotSet=true) protected String keyName
      Name that can be used by external systems to refer to preference.

    • keyNameSpecified

      protected boolean keyNameSpecified

    • maximumValue

      @ApiProperty(canBeNullOrNotSet=true) protected String maximumValue
      Largest value allowed for the preference.

    • maximumValueSpecified

      protected boolean maximumValueSpecified

    • minimumValue

      @ApiProperty(canBeNullOrNotSet=true) protected String minimumValue
      Smallest value allowed for the preference.

    • minimumValueSpecified

      protected boolean minimumValueSpecified

    • name

      @ApiProperty(canBeNullOrNotSet=true) protected String name
      Friendly name for the notification.

    • nameSpecified

      protected boolean nameSpecified

    • units

      @ApiProperty(canBeNullOrNotSet=true) protected String units
      The unit of measure used for the preference's value, minimum and maximum as well.

    • unitsSpecified

      protected boolean unitsSpecified

    • value

      @ApiProperty(canBeNullOrNotSet=true) protected String value
      Default value used when setting up preferences for a new subscriber.

    • valueSpecified

      protected boolean valueSpecified

  • Constructor Details

    • Preference

      public Preference()

  • Method Details

    • getDescription

      public String getDescription()

    • setDescription

      public void setDescription​(String description)

    • isDescriptionSpecified

      public boolean isDescriptionSpecified()

    • unsetDescription

      public void unsetDescription()

    • getId

      public Long getId()

    • setId

      public void setId​(Long id)

    • isIdSpecified

      public boolean isIdSpecified()

    • unsetId

      public void unsetId()

    • getKeyName

      public String getKeyName()

    • setKeyName

      public void setKeyName​(String keyName)

    • isKeyNameSpecified

      public boolean isKeyNameSpecified()

    • unsetKeyName

      public void unsetKeyName()

    • getMaximumValue

      public String getMaximumValue()

    • setMaximumValue

      public void setMaximumValue​(String maximumValue)

    • isMaximumValueSpecified

      public boolean isMaximumValueSpecified()

    • unsetMaximumValue

      public void unsetMaximumValue()

    • getMinimumValue

      public String getMinimumValue()

    • setMinimumValue

      public void setMinimumValue​(String minimumValue)

    • isMinimumValueSpecified

      public boolean isMinimumValueSpecified()

    • unsetMinimumValue

      public void unsetMinimumValue()

    • getName

      public String getName()

    • setName

      public void setName​(String name)

    • isNameSpecified

      public boolean isNameSpecified()

    • unsetName

      public void unsetName()

    • getUnits

      public String getUnits()

    • setUnits

      public void setUnits​(String units)

    • isUnitsSpecified

      public boolean isUnitsSpecified()

    • unsetUnits

      public void unsetUnits()

    • getValue

      public String getValue()

    • setValue

      public void setValue​(String value)

    • isValueSpecified

      public boolean isValueSpecified()

    • unsetValue

      public void unsetValue()