Package com.softlayer.api.service.notification.occurrence

Interface Event.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Event

@ApiService("SoftLayer_Notification_Occurrence_Event")
public static interface Event.Service
extends Service

The [[SoftLayer_Notification_Occurrence_Event]] service represents all events with potential to cause a disruption in service.

See Also:

SoftLayer_Notification_Occurrence_Event

Method Summary

Modifier and Type	Method	Description
Boolean	acknowledgeNotification()	<<<< EOT
Event.ServiceAsync	asAsync()	Get an async version of this service
Boolean	getAcknowledgedFlag()	Indicates whether or not this event has been acknowledged by the user.
List<Event>	getAllObjects()
byte[]	getAttachedFile(Long attachmentId)	Retrieve the contents of the file attached to a SoftLayer event by it's given identifier.
List<Attachment>	getAttachments()	A collection of attachments for this event which provide supplementary information to impacted users some examples are RFO (Reason For Outage) and root cause analysis documents.
Update	getFirstUpdate()	The first update for this event.
Long	getImpactedAccountCount()	This method will return the number of impacted owned accounts associated with this event for the current user.
List<Account>	getImpactedAccounts()	A collection of accounts impacted by this event.
Long	getImpactedDeviceCount()	This method will return the number of impacted devices associated with this event for the current user.
List<Resource>	getImpactedDevices()	This method will return a collection of SoftLayer_Notification_Occurrence_Resource objects which is a listing of the current users' impacted devices that are associated with this event.
List<Resource>	getImpactedResources()	A collection of resources impacted by this event.
List<User>	getImpactedUsers()	A collection of users impacted by this event.
Update	getLastUpdate()	The last update for this event.
Type	getNotificationOccurrenceEventType()	The type of event such as planned or unplanned maintenance.
Event	getObject()
Code	getStatusCode()
List<Update>	getUpdates()	All updates for this event.
void	setMask(Event.Mask mask)
Event.Mask	withMask()	Use the existing mask on this service or create it if not present
Event.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

Event.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

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

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

acknowledgeNotification

@ApiMethod(instanceRequired=true)
Boolean acknowledgeNotification()

<<<< EOT

See Also:

SoftLayer_Notification_Occurrence_Event::acknowledgeNotification

getAllObjects

@ApiMethod
List<Event> getAllObjects()

See Also:

SoftLayer_Notification_Occurrence_Event::getAllObjects

getAttachedFile

@ApiMethod(instanceRequired=true)
byte[] getAttachedFile(Long attachmentId)

Retrieve the contents of the file attached to a SoftLayer event by it's given identifier.

See Also:

SoftLayer_Notification_Occurrence_Event::getAttachedFile

getImpactedAccountCount

@ApiMethod(instanceRequired=true)
Long getImpactedAccountCount()

This method will return the number of impacted owned accounts associated with this event for the current user.

See Also:

SoftLayer_Notification_Occurrence_Event::getImpactedAccountCount

getImpactedDeviceCount

@ApiMethod(instanceRequired=true)
Long getImpactedDeviceCount()

This method will return the number of impacted devices associated with this event for the current user.

See Also:

SoftLayer_Notification_Occurrence_Event::getImpactedDeviceCount

getImpactedDevices

@ApiMethod(instanceRequired=true)
List<Resource> getImpactedDevices()

This method will return a collection of SoftLayer_Notification_Occurrence_Resource objects which is a listing of the current users' impacted devices that are associated with this event.

See Also:

SoftLayer_Notification_Occurrence_Event::getImpactedDevices

getObject

@ApiMethod(instanceRequired=true)
Event getObject()

See Also:

SoftLayer_Notification_Occurrence_Event::getObject

getAcknowledgedFlag

@ApiMethod(instanceRequired=true)
Boolean getAcknowledgedFlag()

Indicates whether or not this event has been acknowledged by the user.

See Also:

SoftLayer_Notification_Occurrence_Event::getAcknowledgedFlag

getAttachments

@ApiMethod(instanceRequired=true)
List<Attachment> getAttachments()

A collection of attachments for this event which provide supplementary information to impacted users some examples are RFO (Reason For Outage) and root cause analysis documents.

See Also:

SoftLayer_Notification_Occurrence_Event::getAttachments

getFirstUpdate

@ApiMethod(instanceRequired=true)
Update getFirstUpdate()

The first update for this event.

See Also:

SoftLayer_Notification_Occurrence_Event::getFirstUpdate

getImpactedAccounts

@ApiMethod(instanceRequired=true)
List<Account> getImpactedAccounts()

A collection of accounts impacted by this event. Each impacted account record relates directly to a [[SoftLayer_Account]].

See Also:

SoftLayer_Notification_Occurrence_Event::getImpactedAccounts

getImpactedResources

@ApiMethod(instanceRequired=true)
List<Resource> getImpactedResources()

A collection of resources impacted by this event. Each record will relate to some physical resource that the user has access to such as [[SoftLayer_Hardware]] or [[SoftLayer_Virtual_Guest]].

See Also:

SoftLayer_Notification_Occurrence_Event::getImpactedResources

getImpactedUsers

@ApiMethod(instanceRequired=true)
List<User> getImpactedUsers()

A collection of users impacted by this event. Each impacted user record relates directly to a [[SoftLayer_User_Customer]].

See Also:

SoftLayer_Notification_Occurrence_Event::getImpactedUsers

getLastUpdate

@ApiMethod(instanceRequired=true)
Update getLastUpdate()

The last update for this event.

See Also:

SoftLayer_Notification_Occurrence_Event::getLastUpdate

getNotificationOccurrenceEventType

@ApiMethod(instanceRequired=true)
Type getNotificationOccurrenceEventType()

The type of event such as planned or unplanned maintenance.

See Also:

SoftLayer_Notification_Occurrence_Event::getNotificationOccurrenceEventType

getStatusCode

@ApiMethod(instanceRequired=true)
Code getStatusCode()

See Also:

SoftLayer_Notification_Occurrence_Event::getStatusCode

getUpdates

@ApiMethod(instanceRequired=true)
List<Update> getUpdates()

All updates for this event.

See Also:

SoftLayer_Notification_Occurrence_Event::getUpdates