org.apache.oozie.client
Interface CoordinatorJob

All Superinterfaces:

Job

public interface CoordinatorJob
extends Job

Bean that represents an Oozie application.

Nested Class Summary

static class	CoordinatorJob.Execution Defines the possible execution order of an Oozie application.
static class	CoordinatorJob.Timeunit Defines the possible frequency unit of an Oozie application.

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

Job.Status

Method Summary

String	getAcl() Return the workflow job group.
List<CoordinatorAction>	getActions() Return list of coordinator actions.
String	getAppName() Return the name of the Oozie application (from the application definition).
String	getAppPath() Return the path to the Oozie application.
String	getBundleId() Return the BundleId.
int	getConcurrency() Return the concurrency for the coord job
String	getConf() Return the application configuration.
String	getConsoleUrl() Return the application console URL.
Date	getEndTime() Return the application end time.
CoordinatorJob.Execution	getExecutionOrder() Return the execution order policy for the coord job
int	getFrequency() Return the frequency for the coord job in unit of minute
String	getGroup() Deprecated.
String	getId() Return the application ID.
Date	getLastActionTime() Return the date for the last action of the coord job
Date	getNextMaterializedTime() Return the application next materialized time.
Date	getStartTime() Return the application start time.
Job.Status	getStatus() Return the application status.
int	getTimeout() Return the time out value for the coord job
CoordinatorJob.Timeunit	getTimeUnit() Return the timeUnit for the coord job, it could be, Timeunit enum, e.g.
String	getTimeZone() Return the time zone information for the coord job
String	getUser() Return the application user owner.

Methods inherited from interface org.apache.oozie.client.Job

getExternalId, getPauseTime, resetPending, setPending, setStatus

Method Detail

getAppPath

String getAppPath()

Return the path to the Oozie application.

Specified by:

getAppPath in interface Job

Returns:

the path to the Oozie application.

getAppName

String getAppName()

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

Specified by:

getAppName in interface Job

Returns:

the name of the Oozie application.

getId

String getId()

Return the application ID.

Specified by:

getId in interface Job

Returns:

the application ID.

getConf

String getConf()

Return the application configuration.

Specified by:

getConf in interface Job

Returns:

the application configuration.

getStatus

Job.Status getStatus()

Return the application status.

Specified by:

getStatus in interface Job

Returns:

the application status.

getFrequency

int getFrequency()

Return the frequency for the coord job in unit of minute

Returns:

the frequency for the coord job in unit of minute

getTimeUnit

CoordinatorJob.Timeunit getTimeUnit()

Return the timeUnit for the coord job, it could be, Timeunit enum, e.g. MINUTE, HOUR, DAY, WEEK or MONTH

Returns:

the time unit for the coord job

getTimeZone

String getTimeZone()

Return the time zone information for the coord job

Returns:

the time zone information for the coord job

getConcurrency

int getConcurrency()

Return the concurrency for the coord job

Returns:

the concurrency for the coord job

getExecutionOrder

CoordinatorJob.Execution getExecutionOrder()

Return the execution order policy for the coord job

Returns:

the execution order policy for the coord job

getTimeout

int getTimeout()

Return the time out value for the coord job

Returns:

the time out value for the coord job

getLastActionTime

Date getLastActionTime()

Return the date for the last action of the coord job

Returns:

the date for the last action of the coord job

getNextMaterializedTime

Date getNextMaterializedTime()

Return the application next materialized time.

Returns:

the application next materialized time.

getStartTime

Date getStartTime()

Return the application start time.

Specified by:

getStartTime in interface Job

Returns:

the application start time.

getEndTime

Date getEndTime()

Return the application end time.

Specified by:

getEndTime in interface Job

Returns:

the application end time.

getUser

String getUser()

Return the application user owner.

Specified by:

getUser in interface Job

Returns:

the application user owner.

getGroup

@Deprecated
String getGroup()

Deprecated.

Return the application group.

Use the getAcl() method instead.

Specified by:

getGroup in interface Job

Returns:

the application group.

getAcl

String getAcl()

Return the workflow job group.

Specified by:

getAcl in interface Job

Returns:

the workflow job group.

getBundleId

String getBundleId()

Return the BundleId.

Returns:

the BundleId.

getConsoleUrl

String getConsoleUrl()

Return the application console URL.

Specified by:

getConsoleUrl in interface Job

Returns:

the application console URL.

getActions

List<CoordinatorAction> getActions()

Return list of coordinator actions.

Returns:

the list of coordinator actions.