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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Preference.Mask

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`description`	A description of what the preference is used for.
`protected boolean`	`descriptionSpecified`
`protected Long`	`id`	Unique identifier for the notification preference.
`protected boolean`	`idSpecified`
`protected String`	`keyName`	Name that can be used by external systems to refer to preference.
`protected boolean`	`keyNameSpecified`
`protected String`	`maximumValue`	Largest value allowed for the preference.
`protected boolean`	`maximumValueSpecified`
`protected String`	`minimumValue`	Smallest value allowed for the preference.
`protected boolean`	`minimumValueSpecified`
`protected String`	`name`	Friendly name for the notification.
`protected boolean`	`nameSpecified`
`protected String`	`units`	The unit of measure used for the preference's value, minimum and maximum as well.
`protected boolean`	`unitsSpecified`
`protected String`	`value`	Default value used when setting up preferences for a new subscriber.
`protected boolean`	`valueSpecified`

Fields inherited from class com.softlayer.api.Type
unknownProperties

Constructor Summary

Constructors
Constructor Description

Preference()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getDescription()`
`Long`	`getId()`
`String`	`getKeyName()`
`String`	`getMaximumValue()`
`String`	`getMinimumValue()`
`String`	`getName()`
`String`	`getUnits()`
`String`	`getValue()`
`boolean`	`isDescriptionSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isKeyNameSpecified()`
`boolean`	`isMaximumValueSpecified()`
`boolean`	`isMinimumValueSpecified()`
`boolean`	`isNameSpecified()`
`boolean`	`isUnitsSpecified()`
`boolean`	`isValueSpecified()`
`void`	`setDescription(String description)`
`void`	`setId(Long id)`
`void`	`setKeyName(String keyName)`
`void`	`setMaximumValue(String maximumValue)`
`void`	`setMinimumValue(String minimumValue)`
`void`	`setName(String name)`
`void`	`setUnits(String units)`
`void`	`setValue(String value)`
`void`	`unsetDescription()`
`void`	`unsetId()`
`void`	`unsetKeyName()`
`void`	`unsetMaximumValue()`
`void`	`unsetMinimumValue()`
`void`	`unsetName()`
`void`	`unsetUnits()`
`void`	`unsetValue()`

Methods inherited from class com.softlayer.api.Type
getUnknownProperties, setUnknownProperties

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

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 Detail
- Preference
```
public Preference()
```

Method Detail

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()
```

Class Preference

Nested Class Summary

Field Summary

Fields inherited from class com.softlayer.api.Type

Constructor Summary

Method Summary

Methods inherited from class com.softlayer.api.Type

Methods inherited from class java.lang.Object

Field Detail

description

descriptionSpecified

id

idSpecified

keyName

keyNameSpecified

maximumValue

maximumValueSpecified

minimumValue

minimumValueSpecified

name

nameSpecified

units

unitsSpecified

value

valueSpecified

Constructor Detail

Preference

Method Detail

getDescription

setDescription

isDescriptionSpecified

unsetDescription

getId

setId

isIdSpecified

unsetId

getKeyName

setKeyName

isKeyNameSpecified

unsetKeyName

getMaximumValue

setMaximumValue

isMaximumValueSpecified

unsetMaximumValue

getMinimumValue

setMinimumValue

isMinimumValueSpecified

unsetMinimumValue

getName

setName

isNameSpecified

unsetName

getUnits

setUnits

isUnitsSpecified

unsetUnits

getValue

setValue

isValueSpecified

unsetValue