CoordinatorActionBean (Apache Oozie Core 4.1.0 API)

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

All Implemented Interfaces:: org.apache.hadoop.io.Writable, org.apache.oozie.client.CoordinatorAction, JsonBean

@Entity
public class CoordinatorActionBean
extends Object
implements org.apache.hadoop.io.Writable, org.apache.oozie.client.CoordinatorAction, JsonBean

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

Constructor Summary

Constructors
Constructor and Description

CoordinatorActionBean()

Constructors
Constructor and Description
`CoordinatorActionBean()`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`decrementAndGetPending()` decrement pending and return it
`boolean`	`equals(Object obj)`
`int`	`getActionNumber()`
`String`	`getActionXml()`
`StringBlob`	`getActionXmlBlob()`
`String`	`getConsoleUrl()`
`String`	`getCreatedConf()`
`StringBlob`	`getCreatedConfBlob()`
`Date`	`getCreatedTime()`
`Timestamp`	`getCreatedTimestamp()`
`String`	`getErrorCode()`
`String`	`getErrorMessage()`
`String`	`getExternalId()`
`String`	`getExternalStatus()`
`String`	`getId()`
`String`	`getJobId()`
`Date`	`getLastModifiedTime()`
`Timestamp`	`getLastModifiedTimestamp()`
`String`	`getMissingDependencies()`
`StringBlob`	`getMissingDependenciesBlob()`
`Date`	`getNominalTime()`
`Timestamp`	`getNominalTimestamp()`
`int`	`getPending()` Get some actions are in progress for particular bundle action.
`String`	`getPushMissingDependencies()`
`StringBlob`	`getPushMissingDependenciesBlob()`
`Date`	`getRerunTime()`
`Timestamp`	`getRerunTimestamp()`
`String`	`getRunConf()`
`StringBlob`	`getRunConfBlob()`
`String`	`getSlaXml()`
`StringBlob`	`getSlaXmlBlob()`
`org.apache.oozie.client.CoordinatorAction.Status`	`getStatus()`
`String`	`getStatusStr()` Return the status in string
`int`	`getTimeOut()`
`String`	`getTrackerUri()`
`String`	`getType()`
`int`	`hashCode()`
`int`	`incrementAndGetPending()` increment pending and return it
`boolean`	`isPending()` Return if the action is pending.
`boolean`	`isTerminalStatus()`
`boolean`	`isTerminalWithFailure()` Return if the action is complete with failure.
`void`	`readFields(DataInput dataInput)` Deserialize a coordinator bean from a data input.
`void`	`setActionNumber(int actionNumber)`
`void`	`setActionXml(String actionXml)`
`void`	`setActionXmlBlob(StringBlob actionXml)`
`void`	`setConsoleUrl(String consoleUrl)`
`void`	`setCreatedConf(String createdConf)`
`void`	`setCreatedConfBlob(StringBlob createdConf)`
`void`	`setCreatedTime(Date createdTime)`
`void`	`setErrorCode(String errorCode)`
`void`	`setErrorInfo(String errorCode, String errorMessage)`
`void`	`setErrorMessage(String errorMessage)`
`void`	`setExternalId(String externalId)`
`void`	`setExternalStatus(String externalStatus)`
`void`	`setId(String id)`
`void`	`setJobId(String id)`
`void`	`setLastModifiedTime(Date lastModifiedTime)`
`void`	`setMissingDependencies(String missingDependencies)`
`void`	`setMissingDependenciesBlob(StringBlob missingDependencies)`
`void`	`setNominalTime(Date nominalTime)`
`void`	`setPending(int pending)` Set some actions are in progress for particular coordinator action.
`void`	`setPushMissingDependencies(String pushMissingDependencies)`
`void`	`setPushMissingDependenciesBlob(StringBlob pushMissingDependencies)`
`void`	`setRerunTime(Date rerunTime)`
`void`	`setRunConf(String runConf)`
`void`	`setRunConfBlob(StringBlob runConf)`
`void`	`setSlaXml(String slaXml)`
`void`	`setSlaXmlBlob(StringBlob slaXml)`
`void`	`setStatus(org.apache.oozie.client.CoordinatorAction.Status status)`
`void`	`setStatusStr(String statusStr)`
`void`	`setTimeOut(int timeOut)`
`void`	`setTrackerUri(String trackerUri)`
`void`	`setType(String type)`
`static org.json.simple.JSONArray`	`toJSONArray(List<CoordinatorActionBean> actions, String timeZoneId)` Convert a nodes 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 coordinator bean to a data output.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CoordinatorActionBean
```
public CoordinatorActionBean()
```
- Method Detail
  - 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.
  - write
```
public void write(DataOutput dataOutput)
           throws IOException
```
    Serialize the coordinator bean to a data output.
    
    Specified by:
    
    write in interface org.apache.hadoop.io.Writable
    
    Parameters:
    dataOutput - data output.
    
    Throws:
    
    IOException - thrown if the coordinator bean could not be serialized.
  - readFields
```
public void readFields(DataInput dataInput)
                throws IOException
```
    Deserialize a coordinator 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.
  - getJobId
```
public String getJobId()
```
    Specified by:
    
    getJobId in interface org.apache.oozie.client.CoordinatorAction
  - setJobId
```
public void setJobId(String id)
```
  - getStatus
```
public org.apache.oozie.client.CoordinatorAction.Status getStatus()
```
    Specified by:
    
    getStatus in interface org.apache.oozie.client.CoordinatorAction
  - getStatusStr
```
public String getStatusStr()
```
    Return the status in string
    
    Returns:
  - setStatus
```
public void setStatus(org.apache.oozie.client.CoordinatorAction.Status status)
```
  - setStatusStr
```
public void setStatusStr(String statusStr)
```
  - setCreatedTime
```
public void setCreatedTime(Date createdTime)
```
  - setRerunTime
```
public void setRerunTime(Date rerunTime)
```
  - setNominalTime
```
public void setNominalTime(Date nominalTime)
```
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
  - getCreatedTime
```
public Date getCreatedTime()
```
    Specified by:
    
    getCreatedTime in interface org.apache.oozie.client.CoordinatorAction
  - getCreatedTimestamp
```
public Timestamp getCreatedTimestamp()
```
  - getRerunTime
```
public Date getRerunTime()
```
  - getRerunTimestamp
```
public Timestamp getRerunTimestamp()
```
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    Specified by:
    
    getLastModifiedTime in interface org.apache.oozie.client.CoordinatorAction
  - getLastModifiedTimestamp
```
public Timestamp getLastModifiedTimestamp()
```
  - getNominalTime
```
public Date getNominalTime()
```
    Specified by:
    
    getNominalTime in interface org.apache.oozie.client.CoordinatorAction
  - getNominalTimestamp
```
public Timestamp getNominalTimestamp()
```
  - getExternalId
```
public String getExternalId()
```
    Specified by:
    
    getExternalId in interface org.apache.oozie.client.CoordinatorAction
  - setExternalId
```
public void setExternalId(String externalId)
```
  - getSlaXmlBlob
```
public StringBlob getSlaXmlBlob()
```
  - setSlaXmlBlob
```
public void setSlaXmlBlob(StringBlob slaXml)
```
  - getSlaXml
```
public String getSlaXml()
```
  - setSlaXml
```
public void setSlaXml(String slaXml)
```
  - isTerminalStatus
```
public boolean isTerminalStatus()
```
    Returns:
    true if in terminal status
  - isTerminalWithFailure
```
public boolean isTerminalWithFailure()
```
    Return if the action is complete with failure.
    
    Returns:
    if the action is complete with failure.
  - setPending
```
public void setPending(int pending)
```
    Set some actions are in progress for particular coordinator action.
    
    Parameters:
    pending - set pending to true
  - incrementAndGetPending
```
public int incrementAndGetPending()
```
    increment pending and return it
    
    Returns:
    pending
  - decrementAndGetPending
```
public int decrementAndGetPending()
```
    decrement pending and return it
    
    Returns:
    pending
  - getPending
```
public int getPending()
```
    Get some actions are in progress for particular bundle action.
    
    Returns:
    pending
  - isPending
```
public boolean isPending()
```
    Return if the action is pending.
    
    Returns:
    if the action is pending.
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface org.apache.oozie.client.CoordinatorAction
  - setId
```
public void setId(String id)
```
  - getType
```
public String getType()
```
  - setType
```
public void setType(String type)
```
  - setActionNumber
```
public void setActionNumber(int actionNumber)
```
  - getActionNumber
```
public int getActionNumber()
```
    Specified by:
    
    getActionNumber in interface org.apache.oozie.client.CoordinatorAction
  - getCreatedConf
```
public String getCreatedConf()
```
    Specified by:
    
    getCreatedConf in interface org.apache.oozie.client.CoordinatorAction
  - setCreatedConf
```
public void setCreatedConf(String createdConf)
```
  - setCreatedConfBlob
```
public void setCreatedConfBlob(StringBlob createdConf)
```
  - getCreatedConfBlob
```
public StringBlob getCreatedConfBlob()
```
  - setRunConf
```
public void setRunConf(String runConf)
```
  - getRunConf
```
public String getRunConf()
```
    Specified by:
    
    getRunConf in interface org.apache.oozie.client.CoordinatorAction
  - setRunConfBlob
```
public void setRunConfBlob(StringBlob runConf)
```
  - getRunConfBlob
```
public StringBlob getRunConfBlob()
```
  - setMissingDependencies
```
public void setMissingDependencies(String missingDependencies)
```
  - getMissingDependencies
```
public String getMissingDependencies()
```
    Specified by:
    
    getMissingDependencies in interface org.apache.oozie.client.CoordinatorAction
  - setMissingDependenciesBlob
```
public void setMissingDependenciesBlob(StringBlob missingDependencies)
```
  - getMissingDependenciesBlob
```
public StringBlob getMissingDependenciesBlob()
```
  - getPushMissingDependencies
```
public String getPushMissingDependencies()
```
    Specified by:
    
    getPushMissingDependencies in interface org.apache.oozie.client.CoordinatorAction
  - setPushMissingDependencies
```
public void setPushMissingDependencies(String pushMissingDependencies)
```
  - setPushMissingDependenciesBlob
```
public void setPushMissingDependenciesBlob(StringBlob pushMissingDependencies)
```
  - getPushMissingDependenciesBlob
```
public StringBlob getPushMissingDependenciesBlob()
```
  - getExternalStatus
```
public String getExternalStatus()
```
    Specified by:
    
    getExternalStatus in interface org.apache.oozie.client.CoordinatorAction
  - setExternalStatus
```
public void setExternalStatus(String externalStatus)
```
  - getTrackerUri
```
public String getTrackerUri()
```
    Specified by:
    
    getTrackerUri in interface org.apache.oozie.client.CoordinatorAction
  - setTrackerUri
```
public void setTrackerUri(String trackerUri)
```
  - getConsoleUrl
```
public String getConsoleUrl()
```
    Specified by:
    
    getConsoleUrl in interface org.apache.oozie.client.CoordinatorAction
  - setConsoleUrl
```
public void setConsoleUrl(String consoleUrl)
```
  - getErrorCode
```
public String getErrorCode()
```
    Specified by:
    
    getErrorCode in interface org.apache.oozie.client.CoordinatorAction
  - getErrorMessage
```
public String getErrorMessage()
```
    Specified by:
    
    getErrorMessage in interface org.apache.oozie.client.CoordinatorAction
  - setErrorInfo
```
public void setErrorInfo(String errorCode,
                String errorMessage)
```
  - getActionXml
```
public String getActionXml()
```
  - setActionXml
```
public void setActionXml(String actionXml)
```
  - setActionXmlBlob
```
public void setActionXmlBlob(StringBlob actionXml)
```
  - getActionXmlBlob
```
public StringBlob getActionXmlBlob()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getTimeOut
```
public int getTimeOut()
```
  - setTimeOut
```
public void setTimeOut(int timeOut)
```
  - setErrorCode
```
public void setErrorCode(String errorCode)
```
    Specified by:
    
    setErrorCode in interface org.apache.oozie.client.CoordinatorAction
  - setErrorMessage
```
public void setErrorMessage(String errorMessage)
```
    Specified by:
    
    setErrorMessage in interface org.apache.oozie.client.CoordinatorAction
  - 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.
  - toJSONArray
```
public static org.json.simple.JSONArray toJSONArray(List<CoordinatorActionBean> actions,
                                    String timeZoneId)
```
    Convert a nodes list into a JSONArray.
    
    Parameters:
    actions - nodes list.
    timeZoneId - time zone to use for dates in the JSON array.
    
    Returns:
    the corresponding JSON array.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class CoordinatorActionBean

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CoordinatorActionBean

Method Detail

toJSONObject

write

readFields

getJobId

setJobId

getStatus

getStatusStr

setStatus

setStatusStr

setCreatedTime

setRerunTime

setNominalTime

setLastModifiedTime

getCreatedTime

getCreatedTimestamp

getRerunTime

getRerunTimestamp

getLastModifiedTime

getLastModifiedTimestamp

getNominalTime

getNominalTimestamp

getExternalId

setExternalId

getSlaXmlBlob

setSlaXmlBlob

getSlaXml

setSlaXml

isTerminalStatus

isTerminalWithFailure

setPending

incrementAndGetPending

decrementAndGetPending

getPending

isPending

getId

setId

getType

setType

setActionNumber

getActionNumber

getCreatedConf

setCreatedConf

setCreatedConfBlob

getCreatedConfBlob

setRunConf

getRunConf

setRunConfBlob

getRunConfBlob

setMissingDependencies

getMissingDependencies

setMissingDependenciesBlob

getMissingDependenciesBlob

getPushMissingDependencies

setPushMissingDependencies

setPushMissingDependenciesBlob

getPushMissingDependenciesBlob

getExternalStatus

setExternalStatus

getTrackerUri

setTrackerUri

getConsoleUrl

setConsoleUrl

getErrorCode

getErrorMessage

setErrorInfo

getActionXml

setActionXml

setActionXmlBlob

getActionXmlBlob

toString

getTimeOut