com.emc.storageos.model.workflow

Class WorkflowStepRestRep

java.lang.Object

com.emc.storageos.model.DataObjectRestRep

com.emc.storageos.model.workflow.WorkflowStepRestRep

public class WorkflowStepRestRep
extends DataObjectRestRep

Constructor Summary

Constructors

Constructor and Description
WorkflowStepRestRep()

Method Summary

Modifier and Type	Method and Description
java.util.List<RelatedResourceRep>	getChildWorkflows()
java.lang.String	getControllerName() Returns the name of the controller (long) that will be invoked for this Step.
java.lang.String	getDescription() Returns a description provided at Step creation time of what the Step is doing.
java.util.Date	getEndTime() A String representing the time the Step completed.
java.lang.String	getExecuteMethod() Returns the execution method in the controller that will be invoked for the Step.
java.lang.String	getMessage() Returns the message returned from the controller when the Step completed.
java.util.Date	getStartTime() A String representing the time the Step was dispatched (started).
java.lang.String	getState() Returns the Step state has a String (from Workflow.StepState.) Typically this will be SUCCESS or ERROR.
java.lang.String	getStepGroup() Returns the StepGroup name this step belongs to.
java.lang.String	getStepId() Returns the unique stepId identifying this Step.
java.lang.String	getSystem() This is the URI for the system that will be used for the Step (if known).
java.lang.String	getSystemType() Returns the system type (typically from system.getSystemType()).
java.lang.String	getWaitFor() If present, indicates this Step will not execute until a prerequisite Step or StepGroup has successfully completed Execution.
RelatedResourceRep	getWorkflow() This is a link to the Workflow containing this Step.
void	setChildWorkflows(java.util.List<RelatedResourceRep> childWorkflows)
void	setControllerName(java.lang.String controllerName)
void	setDescription(java.lang.String description)
void	setEndTime(java.util.Date endTime)
void	setExecuteMethod(java.lang.String executeMethod)
void	setMessage(java.lang.String message)
void	setStartTime(java.util.Date startTime)
void	setState(java.lang.String state)
void	setStepGroup(java.lang.String stepGroup)
void	setStepId(java.lang.String stepId)
void	setSystem(java.lang.String system)
void	setSystemType(java.lang.String systemType)
void	setWaitFor(java.lang.String waitFor)
void	setWorkflow(RelatedResourceRep workflow)

Methods inherited from class com.emc.storageos.model.DataObjectRestRep

getCreationTime, getGlobal, getId, getInactive, getInternal, getLink, getName, getRemote, getTags, getVdc, setCreationTime, setGlobal, setId, setInactive, setInternal, setLink, setName, setRemote, setTags, setVdc, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WorkflowStepRestRep

public WorkflowStepRestRep()

Method Detail

getControllerName

public java.lang.String getControllerName()

Returns the name of the controller (long) that will be invoked for this Step. This is used by the Dispatcher.

Returns:

controllerName String

setControllerName

public void setControllerName(java.lang.String controllerName)

getDescription

public java.lang.String getDescription()

Returns a description provided at Step creation time of what the Step is doing. The description is used for logging and history.

Returns:

String

setDescription

public void setDescription(java.lang.String description)

getSystem

public java.lang.String getSystem()

This is the URI for the system that will be used for the Step (if known).

Returns:

URI

setSystem

public void setSystem(java.lang.String system)

getSystemType

public java.lang.String getSystemType()

Returns the system type (typically from system.getSystemType()).

Returns:

String representation of System Type

setSystemType

public void setSystemType(java.lang.String systemType)

getEndTime

public java.util.Date getEndTime()

A String representing the time the Step completed.

Returns:

String representing date/time

setEndTime

public void setEndTime(java.util.Date endTime)

getExecuteMethod

public java.lang.String getExecuteMethod()

Returns the execution method in the controller that will be invoked for the Step.

Returns:

String methodName

setExecuteMethod

public void setExecuteMethod(java.lang.String executeMethod)

getMessage

public java.lang.String getMessage()

Returns the message returned from the controller when the Step completed. This generally indicates success or error, and if an error the nature of the error.

Returns:

String

setMessage

public void setMessage(java.lang.String message)

getStartTime

public java.util.Date getStartTime()

A String representing the time the Step was dispatched (started).

Returns:

String representing date/time

setStartTime

public void setStartTime(java.util.Date startTime)

getState

public java.lang.String getState()

Returns the Step state has a String (from Workflow.StepState.) Typically this will be SUCCESS or ERROR.

Returns:

String state

setState

public void setState(java.lang.String state)

getStepGroup

public java.lang.String getStepGroup()

Returns the StepGroup name this step belongs to. Steps do not always belong to a Step Group. This is used for programming dependencies in the Workflow.

Returns:

stepGroup name String

setStepGroup

public void setStepGroup(java.lang.String stepGroup)

getStepId

public java.lang.String getStepId()

Returns the unique stepId identifying this Step. This is how the Step is identified in Zookeeper. This is not the same as the Step's Cassandra URI.

Returns:

stepId String.

setStepId

public void setStepId(java.lang.String stepId)

getWaitFor

public java.lang.String getWaitFor()

If present, indicates this Step will not execute until a prerequisite Step or StepGroup has successfully completed Execution. This is the name of the prerequistive Step or StepGroup. This is used to create dependencies between Steps.

Returns:

waitFor String

setWaitFor

public void setWaitFor(java.lang.String waitFor)

getWorkflow

public RelatedResourceRep getWorkflow()

This is a link to the Workflow containing this Step.

Returns:

Workflow link

setWorkflow

public void setWorkflow(RelatedResourceRep workflow)

getChildWorkflows

public java.util.List<RelatedResourceRep> getChildWorkflows()

setChildWorkflows

public void setChildWorkflows(java.util.List<RelatedResourceRep> childWorkflows)