Class ProcessEvent

java.lang.Object
com.morpheusdata.model.MorpheusModel
com.morpheusdata.model.ProcessEvent
All Implemented Interfaces:
Serializable

public class ProcessEvent extends MorpheusModel
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:
  • Field Details

    • type

      Deprecated.
      Use stepType instead.
    • stepType

      public ProcessStepType stepType
    • eventTitle

      public String eventTitle
    • jobName

      public String jobName
    • jobConfig

      public Map jobConfig
    • status

      public String status
      The event status (e.g. 'pending', 'queued', 'running', 'complete', 'failed').
      Since:
      1.5.0
    • message

      public String message
      The event message. Shown in the history detail when the event status is not 'failed'.
      Since:
      1.5.0
    • output

      public String output
      Process event output text (e.g. command output, log content).
      Since:
      1.5.0
    • error

      public String error
      Error text for the event. Shown in the history detail when the event status is 'failed'.
      Since:
      1.5.0
    • startDate

      public Date startDate
      When the event was started.
      Since:
      1.5.0
    • endDate

      public Date endDate
      When the event ended. Null if still active.
      Since:
      1.5.0
    • name

      public String name
      Display name for the event.
      Since:
      1.5.0
    • retryable

      public Boolean retryable
      Whether this event step can be retried on failure.
      Since:
      1.5.0
    • cancelable

      public Boolean cancelable
      Whether this event step can be cancelled.
      Since:
      1.5.0
  • Constructor Details

    • ProcessEvent

      public ProcessEvent()
  • Method Details

    • getType

      @Deprecated(since="1.2.8") public ProcessEvent.ProcessType getType()
      Deprecated.
      Use getStepType() instead.
    • setType

      @Deprecated(since="1.2.8") public void setType(ProcessEvent.ProcessType type)
      Deprecated.
    • getStepType

      public ProcessStepType getStepType()
      The type of step this event represents.

      See ProcessStepType for some examples from core.

      Returns:
      step type
    • setStepType

      public void setStepType(ProcessStepType stepType)
      Sets the type of step for this event

      See ProcessStepType for some examples from core.

      Parameters:
      stepType - step type
    • getEventTitle

      public String getEventTitle()
    • setEventTitle

      public void setEventTitle(String eventTitle)
    • getJobName

      public String getJobName()
    • setJobName

      public void setJobName(String jobName)
    • getJobConfig

      public Map getJobConfig()
    • setJobConfig

      public void setJobConfig(Map jobConfig)
    • getStatus

      public String getStatus()
    • setStatus

      public void setStatus(String status)
    • getMessage

      public String getMessage()
    • setMessage

      public void setMessage(String message)
    • getOutput

      public String getOutput()
    • setOutput

      public void setOutput(String output)
    • getError

      public String getError()
    • setError

      public void setError(String error)
    • getStartDate

      public Date getStartDate()
    • setStartDate

      public void setStartDate(Date startDate)
    • getEndDate

      public Date getEndDate()
    • setEndDate

      public void setEndDate(Date endDate)
    • getName

      public String getName()
    • setName

      public void setName(String name)
    • getRetryable

      public Boolean getRetryable()
    • setRetryable

      public void setRetryable(Boolean retryable)
    • getCancelable

      public Boolean getCancelable()
    • setCancelable

      public void setCancelable(Boolean cancelable)