org.apache.oozie

Class WorkflowJobBean

java.lang.Object

org.apache.oozie.WorkflowJobBean

All Implemented Interfaces:

org.apache.hadoop.io.Writable, JsonBean, org.apache.oozie.client.WorkflowJob

@Entity
public class WorkflowJobBean
extends java.lang.Object
implements org.apache.hadoop.io.Writable, org.apache.oozie.client.WorkflowJob, JsonBean

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.oozie.client.WorkflowJob

org.apache.oozie.client.WorkflowJob.Status

Constructor Summary

Constructors

Constructor and Description
WorkflowJobBean() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAcl()
java.util.List<org.apache.oozie.client.WorkflowAction>	getActions()
java.lang.String	getAppName()
java.lang.String	getAppPath()
java.lang.String	getConf()
StringBlob	getConfBlob()
java.lang.String	getConsoleUrl() Return the workflow job console URL.
java.util.Date	getCreatedTime()
java.sql.Timestamp	getCreatedTimestamp()
java.util.Date	getEndTime()
java.sql.Timestamp	getEndTimestamp()
java.lang.String	getExternalId()
java.lang.String	getGroup()
java.lang.String	getId()
java.util.Date	getLastModifiedTime()
java.sql.Timestamp	getLastModifiedTimestamp()
java.lang.String	getlogToken()
java.lang.String	getLogToken()
java.lang.String	getParentId() For a sub-workflow, return the Parent Workflow ID and for a top level workflow return the Coordinator action id, if any.
java.lang.String	getProtoActionConf()
StringBlob	getProtoActionConfBlob()
int	getRun()
java.lang.String	getSlaXml()
StringBlob	getSlaXmlBlob()
java.util.Date	getStartTime()
java.sql.Timestamp	getStartTimestamp()
org.apache.oozie.client.WorkflowJob.Status	getStatus()
java.lang.String	getStatusStr()
java.lang.String	getUser()
BinaryBlob	getWfInstanceBlob()
WorkflowInstance	getWorkflowInstance()
boolean	inTerminalState()
void	readFields(java.io.DataInput dataInput) Deserialize a workflow bean from a data input.
void	setActions(java.util.List<WorkflowActionBean> nodes)
void	setAppName(java.lang.String appName)
void	setAppPath(java.lang.String appPath)
void	setConf(java.lang.String conf)
void	setConfBlob(StringBlob conf)
void	setConsoleUrl(java.lang.String consoleUrl) Set the workflow job console URL.
void	setCreatedTime(java.util.Date createdTime)
void	setEndTime(java.util.Date endTime)
void	setExternalId(java.lang.String externalId)
void	setGroup(java.lang.String group)
void	setId(java.lang.String id)
void	setLastModifiedTime(java.util.Date lastModifiedTime)
void	setLogToken(java.lang.String logToken)
void	setParentId(java.lang.String parentId) Set parent id for the workflow.
void	setProtoActionConf(java.lang.String protoActionConf)
void	setProtoActionConfBlob(StringBlob protoBytes)
void	setRun(int run)
void	setSlaXml(java.lang.String slaXml)
void	setSlaXmlBlob(StringBlob slaXml)
void	setStartTime(java.util.Date startTime)
void	setStatus(org.apache.oozie.client.WorkflowJob.Status val)
void	setStatusStr(java.lang.String statusStr)
void	setUser(java.lang.String user)
void	setWfInstanceBlob(BinaryBlob wfInstance)
void	setWorkflowInstance(WorkflowInstance workflowInstance)
static org.json.simple.JSONArray	toJSONArray(java.util.List<WorkflowJobBean> workflows, java.lang.String timeZoneId) Convert a workflows list into a JSONArray.
org.json.simple.JSONObject	toJSONObject() Return the JSONObject for the bean with GMT time zone.
org.json.simple.JSONObject	toJSONObject(java.lang.String timeZoneId) Return the JSONObject for the bean with the given time zone.
java.lang.String	toString()
void	write(java.io.DataOutput dataOutput) Serialize the workflow bean to a data output.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WorkflowJobBean

public WorkflowJobBean()

Default constructor.

Method Detail

write

public void write(java.io.DataOutput dataOutput)
           throws java.io.IOException

Serialize the workflow bean to a data output.

Specified by:

write in interface org.apache.hadoop.io.Writable

Parameters:

dataOutput - data output.

Throws:

java.io.IOException - thrown if the workflow bean could not be serialized.

readFields

public void readFields(java.io.DataInput dataInput)
                throws java.io.IOException

Deserialize a workflow bean from a data input.

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Parameters:

dataInput - data input.

Throws:

java.io.IOException - thrown if the workflow bean could not be deserialized.

inTerminalState

public boolean inTerminalState()

getLogToken

public java.lang.String getLogToken()

setLogToken

public void setLogToken(java.lang.String logToken)

getSlaXml

public java.lang.String getSlaXml()

setSlaXml

public void setSlaXml(java.lang.String slaXml)

setSlaXmlBlob

public void setSlaXmlBlob(StringBlob slaXml)

getSlaXmlBlob

public StringBlob getSlaXmlBlob()

getWorkflowInstance

public WorkflowInstance getWorkflowInstance()

getWfInstanceBlob

public BinaryBlob getWfInstanceBlob()

setWorkflowInstance

public void setWorkflowInstance(WorkflowInstance workflowInstance)

setWfInstanceBlob

public void setWfInstanceBlob(BinaryBlob wfInstance)

getProtoActionConf

public java.lang.String getProtoActionConf()

setProtoActionConf

public void setProtoActionConf(java.lang.String protoActionConf)

setProtoActionConfBlob

public void setProtoActionConfBlob(StringBlob protoBytes)

getProtoActionConfBlob

public StringBlob getProtoActionConfBlob()

getlogToken

public java.lang.String getlogToken()

getLastModifiedTimestamp

public java.sql.Timestamp getLastModifiedTimestamp()

getStartTimestamp

public java.sql.Timestamp getStartTimestamp()

getCreatedTimestamp

public java.sql.Timestamp getCreatedTimestamp()

getEndTimestamp

public java.sql.Timestamp getEndTimestamp()

setStatusStr

public void setStatusStr(java.lang.String statusStr)

setStatus

public void setStatus(org.apache.oozie.client.WorkflowJob.Status val)

getStatus

public org.apache.oozie.client.WorkflowJob.Status getStatus()

Specified by:

getStatus in interface org.apache.oozie.client.WorkflowJob

getStatusStr

public java.lang.String getStatusStr()

setExternalId

public void setExternalId(java.lang.String externalId)

getExternalId

public java.lang.String getExternalId()

Specified by:

getExternalId in interface org.apache.oozie.client.WorkflowJob

setLastModifiedTime

public void setLastModifiedTime(java.util.Date lastModifiedTime)

getLastModifiedTime

public java.util.Date getLastModifiedTime()

Specified by:

getLastModifiedTime in interface org.apache.oozie.client.WorkflowJob

getCreatedTime

public java.util.Date getCreatedTime()

Specified by:

getCreatedTime in interface org.apache.oozie.client.WorkflowJob

setCreatedTime

public void setCreatedTime(java.util.Date createdTime)

getStartTime

public java.util.Date getStartTime()

Specified by:

getStartTime in interface org.apache.oozie.client.WorkflowJob

setStartTime

public void setStartTime(java.util.Date startTime)

getEndTime

public java.util.Date getEndTime()

Specified by:

getEndTime in interface org.apache.oozie.client.WorkflowJob

setEndTime

public void setEndTime(java.util.Date endTime)

toJSONObject

public org.json.simple.JSONObject toJSONObject()

Description copied from interface: JsonBean

Return the JSONObject for the bean with GMT time zone.

Specified by:

toJSONObject in interface JsonBean

Returns:

the JSONObject for the bean with GMT time zone.

toJSONObject

public org.json.simple.JSONObject toJSONObject(java.lang.String timeZoneId)

Description copied from interface: JsonBean

Return the JSONObject for the bean with the given time zone.

Specified by:

toJSONObject in interface JsonBean

Parameters:

timeZoneId - the time zone to use

Returns:

the JSONObject for the bean with the given time zone.

getAppPath

public java.lang.String getAppPath()

Specified by:

getAppPath in interface org.apache.oozie.client.WorkflowJob

setAppPath

public void setAppPath(java.lang.String appPath)

getAppName

public java.lang.String getAppName()

Specified by:

getAppName in interface org.apache.oozie.client.WorkflowJob

setAppName

public void setAppName(java.lang.String appName)

getId

public java.lang.String getId()

Specified by:

getId in interface org.apache.oozie.client.WorkflowJob

setId

public void setId(java.lang.String id)

getConf

public java.lang.String getConf()

Specified by:

getConf in interface org.apache.oozie.client.WorkflowJob

setConf

public void setConf(java.lang.String conf)

setConfBlob

public void setConfBlob(StringBlob conf)

getConfBlob

public StringBlob getConfBlob()

getUser

public java.lang.String getUser()

Specified by:

getUser in interface org.apache.oozie.client.WorkflowJob

setUser

public void setUser(java.lang.String user)

getGroup

public java.lang.String getGroup()

Specified by:

getGroup in interface org.apache.oozie.client.WorkflowJob

getAcl

public java.lang.String getAcl()

Specified by:

getAcl in interface org.apache.oozie.client.WorkflowJob

setGroup

public void setGroup(java.lang.String group)

getRun

public int getRun()

Specified by:

getRun in interface org.apache.oozie.client.WorkflowJob

setRun

public void setRun(int run)

getConsoleUrl

public java.lang.String getConsoleUrl()

Return the workflow job console URL.

Specified by:

getConsoleUrl in interface org.apache.oozie.client.WorkflowJob

Returns:

the workflow job console URL.

getParentId

public java.lang.String getParentId()

For a sub-workflow, return the Parent Workflow ID and for a top level workflow return the Coordinator action id, if any.

Specified by:

getParentId in interface org.apache.oozie.client.WorkflowJob

Returns:

the Parent Workflow Id/Coordinator Id if any.

setParentId

public void setParentId(java.lang.String parentId)

Set parent id for the workflow. For a top level workflow it is the coordinator action id if submitted through coordinator

Parameters:

parentId - the Parent Action id

setConsoleUrl

public void setConsoleUrl(java.lang.String consoleUrl)

Set the workflow job console URL.

Parameters:

consoleUrl - the workflow job console URL.

getActions

public java.util.List<org.apache.oozie.client.WorkflowAction> getActions()

Specified by:

getActions in interface org.apache.oozie.client.WorkflowJob

setActions

public void setActions(java.util.List<WorkflowActionBean> nodes)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toJSONArray

public static org.json.simple.JSONArray toJSONArray(java.util.List<WorkflowJobBean> workflows,
                                    java.lang.String timeZoneId)

Convert a workflows list into a JSONArray.

Parameters:

workflows - workflows list.

timeZoneId - time zone to use for dates in the JSON array.

Returns:

the corresponding JSON array.