Package com.mypurecloud.sdk.v2.model

Class FlowRuntimeExecution

java.lang.Object
com.mypurecloud.sdk.v2.model.FlowRuntimeExecution
All Implemented Interfaces:
Serializable
public class FlowRuntimeExecution extends Object implements Serializable
Details about the current state of a Flow execution
See Also:

  • Constructor Details

    • FlowRuntimeExecution

      public FlowRuntimeExecution()

    • FlowRuntimeExecution

      public FlowRuntimeExecution(Boolean initWithEmptyList)

  • Method Details

    • id

      public FlowRuntimeExecution id(String id)
      The flow execution ID

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • name

      public FlowRuntimeExecution name(String name)
      The flow execution name.

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • flowVersion

      public FlowRuntimeExecution flowVersion(FlowVersion flowVersion)
      The Version of the flow definition of the flow execution.

    • getFlowVersion

      public FlowVersion getFlowVersion()

    • setFlowVersion

      public void setFlowVersion(FlowVersion flowVersion)

    • dateLaunched

      public FlowRuntimeExecution dateLaunched(Date dateLaunched)
      The time the flow was launched. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDateLaunched

      public Date getDateLaunched()

    • setDateLaunched

      public void setDateLaunched(Date dateLaunched)

    • status

      public FlowRuntimeExecution status(FlowRuntimeExecution.StatusEnum status)
      The flow's running status, which indicates whether the flow is running normally or completed, etc.

    • getStatus

      public FlowRuntimeExecution.StatusEnum getStatus()

    • setStatus

      public void setStatus(FlowRuntimeExecution.StatusEnum status)

    • dateCompleted

      public FlowRuntimeExecution dateCompleted(Date dateCompleted)
      The time the flow completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDateCompleted

      public Date getDateCompleted()

    • setDateCompleted

      public void setDateCompleted(Date dateCompleted)

    • completionReason

      public FlowRuntimeExecution completionReason(String completionReason)
      The completion reason set at the flow completion time, if applicable.

    • getCompletionReason

      public String getCompletionReason()

    • setCompletionReason

      public void setCompletionReason(String completionReason)

    • flowErrorInfo

      public FlowRuntimeExecution flowErrorInfo(ErrorBody flowErrorInfo)
      Additional information if the flow is in error

    • getFlowErrorInfo

      public ErrorBody getFlowErrorInfo()

    • setFlowErrorInfo

      public void setFlowErrorInfo(ErrorBody flowErrorInfo)

    • outputData

      public FlowRuntimeExecution outputData(Map<String,Object> outputData)
      List of the flow's output variables, if any. Output variables are only supplied for Completed flows.

    • getOutputData

      public Map<String,Object> getOutputData()

    • setOutputData

      public void setOutputData(Map<String,Object> outputData)

    • conversation

      public FlowRuntimeExecution conversation(DomainEntityRef conversation)
      The conversation to which this Flow execution is related

    • getConversation

      public DomainEntityRef getConversation()

    • setConversation

      public void setConversation(DomainEntityRef conversation)

    • getSelfUri

      public String getSelfUri()

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object