Package com.softlayer.api.service

Interface Notification.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

All Known Subinterfaces:

Mobile.Service

Enclosing class:

Notification

@ApiService("SoftLayer_Notification")
public static interface Notification.Service
extends Service

SoftLayer Customers can use this service to view all of the available notifications that can be subscribed to. Some of the notifications are required while others are not.

See Also:

SoftLayer_Notification

Method Summary

Modifier and Type	Method	Description
Notification.ServiceAsync	asAsync()	Get an async version of this service
List<Notification>	getAllObjects()	Use this method to retrieve all active notifications that can be subscribed to.
Notification	getObject()
List<Preference>	getPreferences()	The preferences related to the notification.
List<Preference>	getRequiredPreferences()	The required preferences related to the notification.
void	setMask(Notification.Mask mask)
Notification.Mask	withMask()	Use the existing mask on this service or create it if not present
Notification.Mask	withNewMask()	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Details

asAsync

Notification.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Notification.Mask withNewMask()

Description copied from interface: Maskable

Overwrite the existing mask on this service with a new one and return it

Specified by:

withNewMask in interface Maskable

withMask

Notification.Mask withMask()

Description copied from interface: Maskable

Use the existing mask on this service or create it if not present

Specified by:

withMask in interface Maskable

setMask

void setMask(Notification.Mask mask)

getAllObjects

@ApiMethod List<Notification> getAllObjects()

Use this method to retrieve all active notifications that can be subscribed to.

See Also:

SoftLayer_Notification::getAllObjects

getObject

@ApiMethod(instanceRequired=true) Notification getObject()

See Also:

SoftLayer_Notification::getObject

getPreferences

@ApiMethod(instanceRequired=true) List<Preference> getPreferences()

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

See Also:

SoftLayer_Notification::getPreferences

getRequiredPreferences

@ApiMethod(instanceRequired=true) List<Preference> getRequiredPreferences()

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

See Also:

SoftLayer_Notification::getRequiredPreferences