WorkflowJobBean (Apache Oozie Core 4.3.0 API)

java.lang.Object
- org.apache.oozie.WorkflowJobBean

All Implemented Interfaces:: org.apache.hadoop.io.Writable, JsonBean, WorkflowJob

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

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.oozie.client.WorkflowJob
  WorkflowJob.Status

Constructor Summary

Constructors
Constructor and Description

WorkflowJobBean()
Default constructor.

Constructors
Constructor and Description
`WorkflowJobBean()` Default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getAcl()`
`List<WorkflowAction>`	`getActions()`
`String`	`getAppName()`
`String`	`getAppPath()`
`String`	`getConf()`
`StringBlob`	`getConfBlob()`
`String`	`getConsoleUrl()` Return the workflow job console URL.
`Date`	`getCreatedTime()`
`Timestamp`	`getCreatedTimestamp()`
`Date`	`getEndTime()`
`Timestamp`	`getEndTimestamp()`
`String`	`getExternalId()`
`String`	`getGroup()`
`String`	`getId()`
`Date`	`getLastModifiedTime()`
`Timestamp`	`getLastModifiedTimestamp()`
`String`	`getlogToken()`
`String`	`getLogToken()`
`String`	`getParentId()` For a sub-workflow, return the Parent Workflow ID and for a top level workflow return the Coordinator action id, if any.
`String`	`getProtoActionConf()`
`StringBlob`	`getProtoActionConfBlob()`
`int`	`getRun()`
`String`	`getSlaXml()`
`StringBlob`	`getSlaXmlBlob()`
`Date`	`getStartTime()`
`Timestamp`	`getStartTimestamp()`
`WorkflowJob.Status`	`getStatus()`
`String`	`getStatusStr()`
`String`	`getUser()`
`BinaryBlob`	`getWfInstanceBlob()`
`WorkflowInstance`	`getWorkflowInstance()`
`boolean`	`inTerminalState()`
`void`	`readFields(DataInput dataInput)` Deserialize a workflow bean from a data input.
`void`	`setActions(List<WorkflowActionBean> nodes)`
`void`	`setAppName(String appName)`
`void`	`setAppPath(String appPath)`
`void`	`setConf(String conf)`
`void`	`setConfBlob(StringBlob conf)`
`void`	`setConsoleUrl(String consoleUrl)` Set the workflow job console URL.
`void`	`setCreatedTime(Date createdTime)`
`void`	`setEndTime(Date endTime)`
`void`	`setExternalId(String externalId)`
`void`	`setGroup(String group)`
`void`	`setId(String id)`
`void`	`setLastModifiedTime(Date lastModifiedTime)`
`void`	`setLogToken(String logToken)`
`void`	`setParentId(String parentId)` Set parent id for the workflow.
`void`	`setProtoActionConf(String protoActionConf)`
`void`	`setProtoActionConfBlob(StringBlob protoBytes)`
`void`	`setRun(int run)`
`void`	`setSlaXml(String slaXml)`
`void`	`setSlaXmlBlob(StringBlob slaXml)`
`void`	`setStartTime(Date startTime)`
`void`	`setStatus(WorkflowJob.Status val)`
`void`	`setStatusStr(String statusStr)`
`void`	`setUser(String user)`
`void`	`setWfInstanceBlob(BinaryBlob wfInstance)`
`void`	`setWorkflowInstance(WorkflowInstance workflowInstance)`
`static org.json.simple.JSONArray`	`toJSONArray(List<WorkflowJobBean> workflows, 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(String timeZoneId)` Return the JSONObject for the bean with the given time zone.
`String`	`toString()`
`void`	`write(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(DataOutput dataOutput)
           throws IOException
```
    Serialize the workflow bean to a data output.
    
    Specified by:
    
    write in interface org.apache.hadoop.io.Writable
    
    Parameters:
    dataOutput - data output.
    
    Throws:
    
    IOException - thrown if the workflow bean could not be serialized.
  - readFields
```
public void readFields(DataInput dataInput)
                throws IOException
```
    Deserialize a workflow bean from a data input.
    
    Specified by:
    
    readFields in interface org.apache.hadoop.io.Writable
    
    Parameters:
    dataInput - data input.
    
    Throws:
    
    IOException - thrown if the workflow bean could not be deserialized.
  - inTerminalState
```
public boolean inTerminalState()
```
  - getLogToken
```
public String getLogToken()
```
  - setLogToken
```
public void setLogToken(String logToken)
```
  - getSlaXml
```
public String getSlaXml()
```
  - setSlaXml
```
public void setSlaXml(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 String getProtoActionConf()
```
  - setProtoActionConf
```
public void setProtoActionConf(String protoActionConf)
```
  - setProtoActionConfBlob
```
public void setProtoActionConfBlob(StringBlob protoBytes)
```
  - getProtoActionConfBlob
```
public StringBlob getProtoActionConfBlob()
```
  - getlogToken
```
public String getlogToken()
```
  - getLastModifiedTimestamp
```
public Timestamp getLastModifiedTimestamp()
```
  - getStartTimestamp
```
public Timestamp getStartTimestamp()
```
  - getCreatedTimestamp
```
public Timestamp getCreatedTimestamp()
```
  - getEndTimestamp
```
public Timestamp getEndTimestamp()
```
  - setStatusStr
```
public void setStatusStr(String statusStr)
```
  - setStatus
```
public void setStatus(WorkflowJob.Status val)
```
  - getStatus
```
public WorkflowJob.Status getStatus()
```
    Specified by:
    
    getStatus in interface WorkflowJob
  - getStatusStr
```
public String getStatusStr()
```
  - setExternalId
```
public void setExternalId(String externalId)
```
  - getExternalId
```
public String getExternalId()
```
    Specified by:
    
    getExternalId in interface WorkflowJob
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    Specified by:
    
    getLastModifiedTime in interface WorkflowJob
  - getCreatedTime
```
public Date getCreatedTime()
```
    Specified by:
    
    getCreatedTime in interface WorkflowJob
  - setCreatedTime
```
public void setCreatedTime(Date createdTime)
```
  - getStartTime
```
public Date getStartTime()
```
    Specified by:
    
    getStartTime in interface WorkflowJob
  - setStartTime
```
public void setStartTime(Date startTime)
```
  - getEndTime
```
public Date getEndTime()
```
    Specified by:
    
    getEndTime in interface WorkflowJob
  - setEndTime
```
public void setEndTime(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(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 String getAppPath()
```
    Specified by:
    
    getAppPath in interface WorkflowJob
  - setAppPath
```
public void setAppPath(String appPath)
```
  - getAppName
```
public String getAppName()
```
    Specified by:
    
    getAppName in interface WorkflowJob
  - setAppName
```
public void setAppName(String appName)
```
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface WorkflowJob
  - setId
```
public void setId(String id)
```
  - getConf
```
public String getConf()
```
    Specified by:
    
    getConf in interface WorkflowJob
  - setConf
```
public void setConf(String conf)
```
  - setConfBlob
```
public void setConfBlob(StringBlob conf)
```
  - getConfBlob
```
public StringBlob getConfBlob()
```
  - getUser
```
public String getUser()
```
    Specified by:
    
    getUser in interface WorkflowJob
  - setUser
```
public void setUser(String user)
```
  - getGroup
```
public String getGroup()
```
    Specified by:
    
    getGroup in interface WorkflowJob
  - getAcl
```
public String getAcl()
```
    Specified by:
    
    getAcl in interface WorkflowJob
  - setGroup
```
public void setGroup(String group)
```
  - getRun
```
public int getRun()
```
    Specified by:
    
    getRun in interface WorkflowJob
  - setRun
```
public void setRun(int run)
```
  - getConsoleUrl
```
public String getConsoleUrl()
```
    Return the workflow job console URL.
    
    Specified by:
    
    getConsoleUrl in interface WorkflowJob
    
    Returns:
    the workflow job console URL.
  - getParentId
```
public 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 WorkflowJob
    
    Returns:
    the Parent Workflow Id/Coordinator Id if any.
  - setParentId
```
public void setParentId(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(String consoleUrl)
```
    Set the workflow job console URL.
    
    Parameters:
    consoleUrl - the workflow job console URL.
  - getActions
```
public List<WorkflowAction> getActions()
```
    Specified by:
    
    getActions in interface WorkflowJob
  - setActions
```
public void setActions(List<WorkflowActionBean> nodes)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toJSONArray
```
public static org.json.simple.JSONArray toJSONArray(List<WorkflowJobBean> workflows,
                                    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.

Class WorkflowJobBean

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WorkflowJobBean

Method Detail

write

readFields

inTerminalState

getLogToken

setLogToken

getSlaXml

setSlaXml

setSlaXmlBlob

getSlaXmlBlob

getWorkflowInstance

getWfInstanceBlob

setWorkflowInstance

setWfInstanceBlob

getProtoActionConf

setProtoActionConf

setProtoActionConfBlob

getProtoActionConfBlob

getlogToken

getLastModifiedTimestamp

getStartTimestamp

getCreatedTimestamp

getEndTimestamp

setStatusStr

setStatus

getStatus

getStatusStr

setExternalId

getExternalId

setLastModifiedTime

getLastModifiedTime

getCreatedTime

setCreatedTime

getStartTime

setStartTime

getEndTime

setEndTime

toJSONObject

toJSONObject

getAppPath

setAppPath

getAppName

setAppName

getId

setId

getConf

setConf

setConfBlob

getConfBlob

getUser

setUser

getGroup

getAcl

setGroup

getRun

setRun

getConsoleUrl

getParentId

setParentId

setConsoleUrl

getActions

setActions

toString

toJSONArray