org.apache.oozie.client
Interface WorkflowAction


public interface WorkflowAction

Bean that represents a workflow action in a workflow job.


Nested Class Summary
static class WorkflowAction.Status
          Defines the possible stati of a action.
 
Method Summary
 String getConf()
          Return the action configuration.
 String getConsoleUrl()
          Return the URL to the web console of the system executing the action.
 String getCred()
          Return the Credential.
 String getData()
          Return the action data.
 Date getEndTime()
          Return the end time of the action action.
 String getErrorCode()
          Return the error code of the action, if it ended in ERROR.
 String getErrorMessage()
          Return the error message of the action, if it ended in ERROR.
 String getExternalChildIDs()
          Return the external child IDs of the action.
 String getExternalId()
          Return the external ID of the action.
 String getExternalStatus()
          Return the external status of the action.
 String getId()
          Return the action action ID.
 String getName()
          Return the action name.
 int getRetries()
          Return the number of retries of the action.
 Date getStartTime()
          Return the start time of the action action.
 String getStats()
          Return the action statistics.
 WorkflowAction.Status getStatus()
          Return the current status of the action action.
 String getTrackerUri()
          Return the URL to programmatically track the status of the action.
 String getTransition()
          Return the transition a action took.
 String getType()
          Return the action type.
 int getUserRetryCount()
          Return the number of user retry of the action.
 int getUserRetryInterval()
          Return the interval of user retry of the action, in minutes.
 int getUserRetryMax()
          Return the max number of user retry of the action.
 

Method Detail

getId

String getId()
Return the action action ID.

Returns:
the action action ID.

getName

String getName()
Return the action name.

Returns:
the action name.

getCred

String getCred()
Return the Credential.

Returns:
the Credential.

getType

String getType()
Return the action type.

Returns:
the action type.

getConf

String getConf()
Return the action configuration.

Returns:
the action configuration.

getStatus

WorkflowAction.Status getStatus()
Return the current status of the action action.

Returns:
the current status of the action action.

getRetries

int getRetries()
Return the number of retries of the action.

Returns:
the number of retries of the action.

getUserRetryCount

int getUserRetryCount()
Return the number of user retry of the action.

Returns:
the number of user retry of the action.

getUserRetryMax

int getUserRetryMax()
Return the max number of user retry of the action.

Returns:
the max number of user retry of the action.

getUserRetryInterval

int getUserRetryInterval()
Return the interval of user retry of the action, in minutes.

Returns:
the interval of user retry of the action, in minutes.

getStartTime

Date getStartTime()
Return the start time of the action action.

Returns:
the start time of the action action.

getEndTime

Date getEndTime()
Return the end time of the action action.

Returns:
the end time of the action action.

getTransition

String getTransition()
Return the transition a action took.

Returns:
the transition a action took.

getData

String getData()
Return the action data.

Returns:
the action data.

getStats

String getStats()
Return the action statistics.

Returns:
the action statistics.

getExternalChildIDs

String getExternalChildIDs()
Return the external child IDs of the action.

Returns:
the external child IDs of the action.

getExternalId

String getExternalId()
Return the external ID of the action.

Returns:
the external ID of the action.

getExternalStatus

String getExternalStatus()
Return the external status of the action.

Returns:
the external status of the action.

getTrackerUri

String getTrackerUri()
Return the URL to programmatically track the status of the action.

Returns:
the URL to programmatically track the status of the action.

getConsoleUrl

String getConsoleUrl()
Return the URL to the web console of the system executing the action.

Returns:
the URL to the web console of the system executing the action.

getErrorCode

String getErrorCode()
Return the error code of the action, if it ended in ERROR.

Returns:
the error code of the action.

getErrorMessage

String getErrorMessage()
Return the error message of the action, if it ended in ERROR.

Returns:
the error message of the action.


Copyright © 2012 Apache Software Foundation. All Rights Reserved.