Interface Guest.Service
- All Superinterfaces:
Maskable
,ResultLimitable
,Service
- Enclosing class:
- Guest
@ApiService("SoftLayer_User_Customer_Notification_Virtual_Guest") public static interface Guest.Service extends Service
This service represents the link between a monitored guest instance, and a user account.
When a monitoring service on that guest instance fails and the monitor is set to "notify users," any users linked to that guest instance using this service will be notified of the failure.
When a monitoring service on that guest instance fails and the monitor is set to "notify users," any users linked to that guest instance using this service will be notified of the failure.
-
Method Summary
Modifier and Type Method Description Guest.ServiceAsync
asAsync()
Get an async version of this serviceGuest
createObject(Guest templateObject)
Passing in an unsaved instance of a SoftLayer_Customer_Notification_Virtual_Guest object into this function will create the object and return the results to the user.List<Guest>
createObjects(List<Guest> templateObjects)
Passing in a collection of unsaved instances of SoftLayer_Customer_Notification_Virtual_Guest objects into this function will create all objects and return the results to the user.Boolean
deleteObjects(List<Guest> templateObjects)
Like any other API object, the customer notification objects can be deleted by passing an instance of them into this function.List<Guest>
findByGuestId(Long id)
This method returns all SoftLayer_User_Customer_Notification_Virtual_Guest objects associated with the passed in ID as long as that Virtual Guest ID is owned by the current user's account.Guest
getGuest()
The virtual guest object that will be monitored.Guest
getObject()
getObject retrieves the SoftLayer_User_Customer_Notification_Virtual_Guest object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_Notification_Virtual_Guest service.Customer
getUser()
The user that will be notified when the associated virtual guest object fails a monitoring instance.void
setMask(Guest.Mask mask)
Guest.Mask
withMask()
Use the existing mask on this service or create it if not presentGuest.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return itMethods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit
-
Method Details
-
asAsync
Guest.ServiceAsync asAsync()Description copied from interface:Service
Get an async version of this service -
withNewMask
Guest.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 interfaceMaskable
-
withMask
Guest.Mask withMask()Description copied from interface:Maskable
Use the existing mask on this service or create it if not present -
setMask
-
createObject
Passing in an unsaved instance of a SoftLayer_Customer_Notification_Virtual_Guest object into this function will create the object and return the results to the user. -
createObjects
Passing in a collection of unsaved instances of SoftLayer_Customer_Notification_Virtual_Guest objects into this function will create all objects and return the results to the user. -
deleteObjects
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. -
findByGuestId
This method returns all SoftLayer_User_Customer_Notification_Virtual_Guest objects associated with the passed in ID as long as that Virtual Guest ID is owned by the current user's account.
This behavior can also be accomplished by simply tapping monitoringUserNotification on the Virtual_Guest object. -
getObject
getObject retrieves the SoftLayer_User_Customer_Notification_Virtual_Guest object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_Notification_Virtual_Guest service. You can only retrieve guest notifications attached to virtual guests and users that belong to your account -
getGuest
The virtual guest object that will be monitored. -
getUser
The user that will be notified when the associated virtual guest object fails a monitoring instance.
-