Package com.softlayer.api.service

Class Notification

java.lang.Object

com.softlayer.api.Type

com.softlayer.api.service.Entity

com.softlayer.api.service.Notification

Direct Known Subclasses:

Mobile

@ApiType("SoftLayer_Notification")
public class Notification
extends Entity

Details provided for the notification are basic. Details such as the related preferences, name and keyname for the notification can be retrieved. The keyname property for the notification can be used to refer to a notification when integrating into the SoftLayer Notification system. The name property can used more for display purposes.

See Also:

SoftLayer_Notification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Notification.Mask
static interface	Notification.Service	SoftLayer Customers can use this service to view all of the available notifications that can be subscribed to.
static interface	Notification.ServiceAsync

Field Summary

Fields

Modifier and Type	Field	Description
protected Long	id	Unique identifier for the notification.
protected boolean	idSpecified
protected String	keyName	Name that can be used by external systems to refer to a notification.
protected boolean	keyNameSpecified
protected String	name	Friendly name for the notification.
protected boolean	nameSpecified
protected Long	preferenceCount	A count of the preferences related to the notification.
protected List<Preference>	preferences	The preferences related to the notification.
protected Long	requiredPreferenceCount	A count of the required preferences related to the notification.
protected List<Preference>	requiredPreferences	The required preferences related to the notification.

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor	Description
Notification()

Method Summary

Modifier and Type	Method	Description
Notification.Service	asService(ApiClient client)
Long	getId()
String	getKeyName()
String	getName()
Long	getPreferenceCount()
List<Preference>	getPreferences()
Long	getRequiredPreferenceCount()
List<Preference>	getRequiredPreferences()
boolean	isIdSpecified()
boolean	isKeyNameSpecified()
boolean	isNameSpecified()
static Notification.Service	service(ApiClient client)
static Notification.Service	service(ApiClient client, Long id)
void	setId(Long id)
void	setKeyName(String keyName)
void	setName(String name)
void	setPreferenceCount(Long preferenceCount)
void	setRequiredPreferenceCount(Long requiredPreferenceCount)
void	unsetId()
void	unsetKeyName()
void	unsetName()

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

preferences

@ApiProperty
protected List<Preference> preferences

The preferences related to the notification. These are preferences are configurable and optional for subscribers to use.

requiredPreferences

@ApiProperty
protected List<Preference> requiredPreferences

The required preferences related to the notification. While configurable, the subscriber does not have the option whether to use the preference.

id

@ApiProperty(canBeNullOrNotSet=true)
protected Long id

Unique identifier for the notification.

idSpecified

protected boolean idSpecified

keyName

@ApiProperty(canBeNullOrNotSet=true)
protected String keyName

Name that can be used by external systems to refer to a notification.

keyNameSpecified

protected boolean keyNameSpecified

name

@ApiProperty(canBeNullOrNotSet=true)
protected String name

Friendly name for the notification.

nameSpecified

protected boolean nameSpecified

preferenceCount

@ApiProperty
protected Long preferenceCount

A count of the preferences related to the notification. These are preferences are configurable and optional for subscribers to use.

requiredPreferenceCount

@ApiProperty
protected Long requiredPreferenceCount

A count of the required preferences related to the notification. While configurable, the subscriber does not have the option whether to use the preference.

Constructor Detail

Notification

public Notification()

Method Detail

getPreferences

public List<Preference> getPreferences()

getRequiredPreferences

public List<Preference> getRequiredPreferences()

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

getName

public String getName()

setName

public void setName(String name)

isNameSpecified

public boolean isNameSpecified()

unsetName

public void unsetName()

getPreferenceCount

public Long getPreferenceCount()

setPreferenceCount

public void setPreferenceCount(Long preferenceCount)

getRequiredPreferenceCount

public Long getRequiredPreferenceCount()

setRequiredPreferenceCount

public void setRequiredPreferenceCount(Long requiredPreferenceCount)

asService

public Notification.Service asService(ApiClient client)

service

public static Notification.Service service(ApiClient client)

service

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