Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.ace.mws.events
[Groovy] Class Event

java.lang.Object
  com.ace.mws.events.Event

class Event

Represents an event originating from any product in the Adaptive Computing suite (XCAT, MSM, MWM, MWS, MAM, etc. )

Authors:
seeleyn

Field Summary
private Map details

(Map of String => String) A map where detail name maps to detail value.

private ErrorMessage errorMessage

Details about any errors associated with the event.

private String eventCategory

Signifies what category of event.

private Date eventTime

The time the event occurred, not the time MWS received the event.

private String eventType

Signifies what type of event.

private String facility

A categorization of how this event fits in with other events.

private String id

The unique ID for this event
private UserDetails initiatedBy

Details about the user that initiated this event
private MoabObject primaryObject

Most events will have a "primary object" associated with it.

private Set relatedObjects

(MoabObject collection) Objects relating to the event that are not the primary object
private String sourceComponent

What Adaptive Computing component reported this event.

private String status

The status of the reported event.

 
Constructor Summary
Event()

 
Method Summary
Map getDetails()

(Map of String => String) A map where detail name maps to detail value.

ErrorMessage getErrorMessage()

Details about any errors associated with the event.

String getEventCategory()

Signifies what category of event.

Date getEventTime()

The time the event occurred, not the time MWS received the event.

String getEventType()

Signifies what type of event.

String getFacility()

A categorization of how this event fits in with other events.

String getId()

The unique ID for this event
UserDetails getInitiatedBy()

Details about the user that initiated this event
MoabObject getPrimaryObject()

Most events will have a "primary object" associated with it.

Set getRelatedObjects()

(MoabObject collection) Objects relating to the event that are not the primary object
String getSourceComponent()

What Adaptive Computing component reported this event.

String getStatus()

The status of the reported event.

void setDetails(Map details)

(Map of String => String) A map where detail name maps to detail value.

void setErrorMessage(ErrorMessage errorMessage)

Details about any errors associated with the event.

void setEventCategory(String eventCategory)

Signifies what category of event.

void setEventTime(Date eventTime)

The time the event occurred, not the time MWS received the event.

void setEventType(String eventType)

Signifies what type of event.

void setFacility(String facility)

A categorization of how this event fits in with other events.

void setId(String id)

The unique ID for this event
void setInitiatedBy(UserDetails initiatedBy)

Details about the user that initiated this event
void setPrimaryObject(MoabObject primaryObject)

Most events will have a "primary object" associated with it.

void setRelatedObjects(Set relatedObjects)

(MoabObject collection) Objects relating to the event that are not the primary object
void setSourceComponent(String sourceComponent)

What Adaptive Computing component reported this event.

void setStatus(String status)

The status of the reported event.

String toString()

 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Field Detail

details

private Map details
(Map of String => String) A map where detail name maps to detail value. (e.g. "sourceHypervisor" => "blade256", "destinationHypervisor" => "blade257", "os" => "centos-5.5-stateless )
See Also:
Map

errorMessage

private ErrorMessage errorMessage
Details about any errors associated with the event. If this event was not associated with any errors this field will be null

eventCategory

private String eventCategory
Signifies what category of event. For example, "create", "start", "modify", etc. This is useful for certain kinds of searches or queries.

Valid categories of events generated by MWS include :

eventTime

private Date eventTime
The time the event occurred, not the time MWS received the event. It is up to the reporting component to accurately report this time. Required during POST.

eventType

private String eventType
Signifies what type of event. Types include "JobStart", "VMCreate", "TrigStart", "SchedulerCommand", among many others.

Valid types of events generated by MWS include :

facility

private String facility
A categorization of how this event fits in with other events. For example, a facility of "PolicyDecisions" would apply to all events that reflect the decisions Moab is making in its policy management logic. A facility of "Job" would group all job events together. An event can have at most one facility.

Valid facilities of events generated by MWS include :

id

private String id
The unique ID for this event

initiatedBy

private UserDetails initiatedBy
Details about the user that initiated this event

primaryObject

private MoabObject primaryObject
Most events will have a "primary object" associated with it. An event can have at most ONE primary object. For example, a JobStart event will have a primary job object, so the type would be "job" and the object ID would be the ID of the job. Primary objects are, however, optional, depending on the type of event. For example, a "SchedulerCommand" event does not have a primary object.

relatedObjects

private Set relatedObjects
(MoabObject collection) Objects relating to the event that are not the primary object
See Also:
MoabObject

sourceComponent

private String sourceComponent
What Adaptive Computing component reported this event. Examples: "MWM", "MWS", "MAM", etc.

status

private String status
The status of the reported event. Valid values include (at this time) "success", "failure", "report", or "inprogress." For example, if a VM migration event fails, it should be reported with a status of "failure" and optionally error messages.

 
Constructor Detail

Event

Event()

 
Method Detail

getDetails

Map getDetails()
(Map of String => String) A map where detail name maps to detail value. (e.g. "sourceHypervisor" => "blade256", "destinationHypervisor" => "blade257", "os" => "centos-5.5-stateless )
See Also:
Map

getErrorMessage

ErrorMessage getErrorMessage()
Details about any errors associated with the event. If this event was not associated with any errors this field will be null

getEventCategory

String getEventCategory()
Signifies what category of event. For example, "create", "start", "modify", etc. This is useful for certain kinds of searches or queries.

Valid categories of events generated by MWS include :

getEventTime

Date getEventTime()
The time the event occurred, not the time MWS received the event. It is up to the reporting component to accurately report this time. Required during POST.

getEventType

String getEventType()
Signifies what type of event. Types include "JobStart", "VMCreate", "TrigStart", "SchedulerCommand", among many others.

Valid types of events generated by MWS include :

getFacility

String getFacility()
A categorization of how this event fits in with other events. For example, a facility of "PolicyDecisions" would apply to all events that reflect the decisions Moab is making in its policy management logic. A facility of "Job" would group all job events together. An event can have at most one facility.

Valid facilities of events generated by MWS include :

getId

String getId()
The unique ID for this event

getInitiatedBy

UserDetails getInitiatedBy()
Details about the user that initiated this event

getPrimaryObject

MoabObject getPrimaryObject()
Most events will have a "primary object" associated with it. An event can have at most ONE primary object. For example, a JobStart event will have a primary job object, so the type would be "job" and the object ID would be the ID of the job. Primary objects are, however, optional, depending on the type of event. For example, a "SchedulerCommand" event does not have a primary object.

getRelatedObjects

Set getRelatedObjects()
(MoabObject collection) Objects relating to the event that are not the primary object
See Also:
MoabObject

getSourceComponent

String getSourceComponent()
What Adaptive Computing component reported this event. Examples: "MWM", "MWS", "MAM", etc.

getStatus

String getStatus()
The status of the reported event. Valid values include (at this time) "success", "failure", "report", or "inprogress." For example, if a VM migration event fails, it should be reported with a status of "failure" and optionally error messages.

setDetails

void setDetails(Map details)
(Map of String => String) A map where detail name maps to detail value. (e.g. "sourceHypervisor" => "blade256", "destinationHypervisor" => "blade257", "os" => "centos-5.5-stateless )
See Also:
Map

setErrorMessage

void setErrorMessage(ErrorMessage errorMessage)
Details about any errors associated with the event. If this event was not associated with any errors this field will be null

setEventCategory

void setEventCategory(String eventCategory)
Signifies what category of event. For example, "create", "start", "modify", etc. This is useful for certain kinds of searches or queries.

Valid categories of events generated by MWS include :

setEventTime

void setEventTime(Date eventTime)
The time the event occurred, not the time MWS received the event. It is up to the reporting component to accurately report this time. Required during POST.

setEventType

void setEventType(String eventType)
Signifies what type of event. Types include "JobStart", "VMCreate", "TrigStart", "SchedulerCommand", among many others.

Valid types of events generated by MWS include :

setFacility

void setFacility(String facility)
A categorization of how this event fits in with other events. For example, a facility of "PolicyDecisions" would apply to all events that reflect the decisions Moab is making in its policy management logic. A facility of "Job" would group all job events together. An event can have at most one facility.

Valid facilities of events generated by MWS include :

setId

void setId(String id)
The unique ID for this event

setInitiatedBy

void setInitiatedBy(UserDetails initiatedBy)
Details about the user that initiated this event

setPrimaryObject

void setPrimaryObject(MoabObject primaryObject)
Most events will have a "primary object" associated with it. An event can have at most ONE primary object. For example, a JobStart event will have a primary job object, so the type would be "job" and the object ID would be the ID of the job. Primary objects are, however, optional, depending on the type of event. For example, a "SchedulerCommand" event does not have a primary object.

setRelatedObjects

void setRelatedObjects(Set relatedObjects)
(MoabObject collection) Objects relating to the event that are not the primary object
See Also:
MoabObject

setSourceComponent

void setSourceComponent(String sourceComponent)
What Adaptive Computing component reported this event. Examples: "MWM", "MWS", "MAM", etc.

setStatus

void setStatus(String status)
The status of the reported event. Valid values include (at this time) "success", "failure", "report", or "inprogress." For example, if a VM migration event fails, it should be reported with a status of "failure" and optionally error messages.

toString

String toString()

 

Groovy Documentation