org.apache.oozie.client

Interface WorkflowJob

public interface WorkflowJob

Bean that represents a workflow job.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WorkflowJob.Status Defines the possible stati of a workflow.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAcl() Return the workflow job group.
java.util.List<WorkflowAction>	getActions() Return the workflow nodes that already executed and are executing.
java.lang.String	getAppName() Return the name of the workflow application (from the workflow definition).
java.lang.String	getAppPath() Return the path to the workflow application for the workflow job.
java.lang.String	getConf() Return the job configuration.
java.lang.String	getConsoleUrl() Return the workflow job console URL.
java.util.Date	getCreatedTime() Return the workflow job creation time.
java.util.Date	getEndTime() Return the workflow job end time.
java.lang.String	getExternalId() Returns the external id for the workflow
java.lang.String	getGroup() Deprecated.
java.lang.String	getId() Return the workflow job ID.
java.util.Date	getLastModifiedTime() Return the workflow job last modified time.
java.lang.String	getParentId() Return the coordinator action ID or the parent workflow ID
int	getRun() Return the workflow job run number.
java.util.Date	getStartTime() Return the workflow job start time.
WorkflowJob.Status	getStatus() Return the workflow job status.
java.lang.String	getUser() Return the workflow job user owner.

Method Detail

getAppPath

java.lang.String getAppPath()

Return the path to the workflow application for the workflow job.

Returns:

the path to the workflow application for the workflow job.

getAppName

java.lang.String getAppName()

Return the name of the workflow application (from the workflow definition).

Returns:

the name of the workflow application.

getId

java.lang.String getId()

Return the workflow job ID.

Returns:

the workflow job ID.

getConf

java.lang.String getConf()

Return the job configuration.

Returns:

the job configuration.

getStatus

WorkflowJob.Status getStatus()

Return the workflow job status.

Returns:

the workflow job status.

getLastModifiedTime

java.util.Date getLastModifiedTime()

Return the workflow job last modified time.

Returns:

the workflow job last modified time.

getCreatedTime

java.util.Date getCreatedTime()

Return the workflow job creation time.

Returns:

the workflow job creation time.

getStartTime

java.util.Date getStartTime()

Return the workflow job start time.

Returns:

the workflow job start time.

getEndTime

java.util.Date getEndTime()

Return the workflow job end time.

Returns:

the workflow job end time.

getUser

java.lang.String getUser()

Return the workflow job user owner.

Returns:

the workflow job user owner.

getGroup

@Deprecated
java.lang.String getGroup()

Deprecated.

Return the workflow job group.

Use the getAcl() method instead.

Returns:

the workflow job group.

getAcl

java.lang.String getAcl()

Return the workflow job group.

Returns:

the workflow job group.

getRun

int getRun()

Return the workflow job run number.

Except for reruns, this property is always 1.

Returns:

the workflow job run number.

getConsoleUrl

java.lang.String getConsoleUrl()

Return the workflow job console URL.

Returns:

the workflow job console URL.

getParentId

java.lang.String getParentId()

Return the coordinator action ID or the parent workflow ID

Returns:

the coordinator action ID/ Parent Workflow ID.

getActions

java.util.List<WorkflowAction> getActions()

Return the workflow nodes that already executed and are executing.

Returns:

the workflow nodes that already executed and are executing.

getExternalId

java.lang.String getExternalId()

Returns the external id for the workflow

Returns:

external id for the workflow