org.rundeck.api.domain
Class RundeckEvent

java.lang.Object
  org.rundeck.api.domain.RundeckEvent

All Implemented Interfaces:

Serializable

public class RundeckEvent
extends Object
implements Serializable

Represents a RunDeck event

Author:

Vincent Behar

See Also:

Serialized Form

Nested Class Summary

static class	RundeckEvent.EventStatus The status of an event
static class	RundeckEvent.NodeSummary Summary for nodes

Constructor Summary

RundeckEvent()

Method Summary

boolean	equals(Object obj)
String	getAbortedBy()
String	getDuration()
Long	getDurationInMillis()
Long	getDurationInSeconds()
Date	getEndedAt()
Long	getExecutionId()
String	getJobId()
RundeckEvent.NodeSummary	getNodeSummary()
String	getProject()
String	getShortDuration()
Date	getStartedAt()
RundeckEvent.EventStatus	getStatus()
String	getSummary()
String	getTitle()
String	getUser()
int	hashCode()
boolean	isAdhoc()
void	setAbortedBy(String abortedBy)
void	setEndedAt(Date endedAt)
void	setExecutionId(Long executionId)
void	setJobId(String jobId)
void	setNodeSummary(RundeckEvent.NodeSummary nodeSummary)
void	setProject(String project)
void	setStartedAt(Date startedAt)
void	setStatus(RundeckEvent.EventStatus status)
void	setSummary(String summary)
void	setTitle(String title)
void	setUser(String user)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RundeckEvent

public RundeckEvent()

Method Detail

getDurationInMillis

public Long getDurationInMillis()

Returns:

the duration of the event in milliseconds (or null if the dates are invalid)

getDurationInSeconds

public Long getDurationInSeconds()

Returns:

the duration of the event in seconds (or null if the dates are invalid)

getDuration

public String getDuration()

Returns:

the duration of the event, as a human-readable string : "3 minutes 34 seconds" (or null if the dates are invalid)

getShortDuration

public String getShortDuration()

Returns:

the duration of the event, as a "short" human-readable string : "0:03:34.187" (or null if the dates are invalid)

isAdhoc

public boolean isAdhoc()

Returns:

true if this event is for an ad-hoc command or script, false otherwise (for a job)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getStatus

public RundeckEvent.EventStatus getStatus()

Returns:

the status of the event - see RundeckEvent.EventStatus

setStatus

public void setStatus(RundeckEvent.EventStatus status)

getSummary

public String getSummary()

setSummary

public void setSummary(String summary)

getNodeSummary

public RundeckEvent.NodeSummary getNodeSummary()

Returns:

the node summary - see RundeckEvent.NodeSummary

setNodeSummary

public void setNodeSummary(RundeckEvent.NodeSummary nodeSummary)

getUser

public String getUser()

setUser

public void setUser(String user)

getProject

public String getProject()

setProject

public void setProject(String project)

getStartedAt

public Date getStartedAt()

setStartedAt

public void setStartedAt(Date startedAt)

getEndedAt

public Date getEndedAt()

setEndedAt

public void setEndedAt(Date endedAt)

getAbortedBy

public String getAbortedBy()

setAbortedBy

public void setAbortedBy(String abortedBy)

getExecutionId

public Long getExecutionId()

Returns:

the ID of the execution associated with this event, or null if there is not

setExecutionId

public void setExecutionId(Long executionId)

getJobId

public String getJobId()

Returns:

the ID of the job associated with this event, or null in the case of an ad-hoc command or script

setJobId

public void setJobId(String jobId)

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object