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

Interface Hardware.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Hardware

@ApiService("SoftLayer_User_Customer_Notification_Hardware")
public static interface Hardware.Service
extends Service

This service represents the link between a monitored hardware instance, and a user account.

When a monitoring service on that hardware instance fails and the monitor is set to "notify users," any users linked to that hardware instance using this service will be notified of the failure.

See Also:

SoftLayer_User_Customer_Notification_Hardware

Method Summary

Modifier and Type	Method	Description
Hardware.ServiceAsync	asAsync()	Get an async version of this service
Hardware	createObject(Hardware templateObject)	Passing in an unsaved instances of a Customer_Notification_Hardware object into this function will create the object and return the results to the user.
List<Hardware>	createObjects(List<Hardware> templateObjects)	Passing in a collection of unsaved instances of Customer_Notification_Hardware objects into this function will create all objects and return the results to the user.
Boolean	deleteObjects(List<Hardware> templateObjects)	Like any other API object, the customer notification objects can be deleted by passing an instance of them into this function.
List<Hardware>	findByHardwareId(Long hardwareId)	This method returns all Customer_Notification_Hardware objects associated with the passed in hardware ID as long as that hardware ID is owned by the current user's account.
Hardware	getHardware()	The hardware object that will be monitored.
Hardware	getObject()	getObject retrieves the SoftLayer_User_Customer_Notification_Hardware object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_Notification_Hardware service.
Customer	getUser()	The user that will be notified when the associated hardware object fails a monitoring instance.
void	setMask(Hardware.Mask mask)
Hardware.Mask	withMask()	Use the existing mask on this service or create it if not present
Hardware.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 Detail

asAsync

Hardware.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Hardware.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

Hardware.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(Hardware.Mask mask)

createObject

@ApiMethod
Hardware createObject(Hardware templateObject)

Passing in an unsaved instances of a Customer_Notification_Hardware object into this function will create the object and return the results to the user.

See Also:

SoftLayer_User_Customer_Notification_Hardware::createObject

createObjects

@ApiMethod
List<Hardware> createObjects(List<Hardware> templateObjects)

Passing in a collection of unsaved instances of Customer_Notification_Hardware objects into this function will create all objects and return the results to the user.

See Also:

SoftLayer_User_Customer_Notification_Hardware::createObjects

deleteObjects

@ApiMethod
Boolean deleteObjects(List<Hardware> templateObjects)

Like any other API object, the customer notification objects can be deleted by passing an instance of them into this function. The ID on the object must be set.

See Also:

SoftLayer_User_Customer_Notification_Hardware::deleteObjects

findByHardwareId

@ApiMethod
List<Hardware> findByHardwareId(Long hardwareId)

This method returns all Customer_Notification_Hardware objects associated with the passed in hardware ID as long as that hardware ID is owned by the current user's account.

This behavior can also be accomplished by simply tapping monitoringUserNotification on the Hardware_Server object.

See Also:

SoftLayer_User_Customer_Notification_Hardware::findByHardwareId

getObject

@ApiMethod(instanceRequired=true)
Hardware getObject()

getObject retrieves the SoftLayer_User_Customer_Notification_Hardware object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_Notification_Hardware service. You can only retrieve hardware notifications attached to hardware and users that belong to your account

See Also:

SoftLayer_User_Customer_Notification_Hardware::getObject

getHardware

@ApiMethod(instanceRequired=true)
Hardware getHardware()

The hardware object that will be monitored.

See Also:

SoftLayer_User_Customer_Notification_Hardware::getHardware

getUser

@ApiMethod(instanceRequired=true)
Customer getUser()

The user that will be notified when the associated hardware object fails a monitoring instance.

See Also:

SoftLayer_User_Customer_Notification_Hardware::getUser