Package com.morpheusdata.model
Class ProcessEvent
java.lang.Object
com.morpheusdata.model.MorpheusModel
com.morpheusdata.model.ProcessEvent
- All Implemented Interfaces:
Serializable
Represents an event (or step) within a
Process.
Extends MorpheusModel to inherit the id field. When used as a parameter
for MorpheusProcessService.runProcessStep(com.morpheusdata.model.process.RunProcessStepRequest), the id
should be set to the value returned by
InsertProcessStepResponse.getProcessEventId() so the
platform can locate the persisted event to dispatch.
- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionWhether this event step can be cancelled.When the event ended.Error text for the event.The event message.Display name for the event.Process event output text (e.g.Whether this event step can be retried on failure.When the event was started.The event status (e.g.Deprecated.UsestepTypeinstead.Fields inherited from class com.morpheusdata.model.MorpheusModel
config, id -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetError()getName()The type of step this event represents.getType()Deprecated.UsegetStepType()instead.voidsetCancelable(Boolean cancelable) voidsetEndDate(Date endDate) voidvoidsetEventTitle(String eventTitle) voidsetJobConfig(Map jobConfig) voidsetJobName(String jobName) voidsetMessage(String message) voidvoidvoidsetRetryable(Boolean retryable) voidsetStartDate(Date startDate) voidvoidsetStepType(ProcessStepType stepType) Sets the type of step for this eventvoidDeprecated.UsesetStepType(ProcessStepType)instead.Methods inherited from class com.morpheusdata.model.MorpheusModel
getConfig, getConfigMap, getConfigProperty, getDirtyProperties, getDirtyPropertyValues, getId, getProperties, isDirty, markClean, markDirty, markDirty, setConfig, setConfigMap, setConfigProperty, setId
-
Field Details
-
type
Deprecated.UsestepTypeinstead. -
stepType
-
eventTitle
-
jobName
-
jobConfig
-
status
The event status (e.g. 'pending', 'queued', 'running', 'complete', 'failed').- Since:
- 1.5.0
-
message
The event message. Shown in the history detail when the event status is not 'failed'.- Since:
- 1.5.0
-
output
Process event output text (e.g. command output, log content).- Since:
- 1.5.0
-
error
Error text for the event. Shown in the history detail when the event status is 'failed'.- Since:
- 1.5.0
-
startDate
When the event was started.- Since:
- 1.5.0
-
endDate
When the event ended. Null if still active.- Since:
- 1.5.0
-
name
Display name for the event.- Since:
- 1.5.0
-
retryable
Whether this event step can be retried on failure.- Since:
- 1.5.0
-
cancelable
Whether this event step can be cancelled.- Since:
- 1.5.0
-
-
Constructor Details
-
ProcessEvent
public ProcessEvent()
-
-
Method Details
-
getType
Deprecated.UsegetStepType()instead. -
setType
Deprecated.UsesetStepType(ProcessStepType)instead. -
getStepType
The type of step this event represents.See
ProcessStepTypefor some examples from core.- Returns:
- step type
-
setStepType
Sets the type of step for this eventSee
ProcessStepTypefor some examples from core.- Parameters:
stepType- step type
-
getEventTitle
-
setEventTitle
-
getJobName
-
setJobName
-
getJobConfig
-
setJobConfig
-
getStatus
-
setStatus
-
getMessage
-
setMessage
-
getOutput
-
setOutput
-
getError
-
setError
-
getStartDate
-
setStartDate
-
getEndDate
-
setEndDate
-
getName
-
setName
-
getRetryable
-
setRetryable
-
getCancelable
-
setCancelable
-
ProcessStepTypeinstead.