org.apache.oozie.fluentjob.api.action

Class SubWorkflowAction

java.lang.Object

org.apache.oozie.fluentjob.api.action.Node

org.apache.oozie.fluentjob.api.action.SubWorkflowAction

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public class SubWorkflowAction
extends Node

A class representing the Oozie subworkflow action. Instances of this class should be built using the builder SubWorkflowActionBuilder. The properties of the builder can only be set once, an attempt to set them a second time will trigger an IllegalStateException. Builder instances can be used to build several elements, although properties already set cannot be changed after a call to SubWorkflowActionBuilder.build() either.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.oozie.fluentjob.api.action.Node

Node.NodeWithCondition

Method Summary

Modifier and Type	Method and Description
String	getAppPath() Returns the path to the application definition (usually workflow.xml) of the subworkflow.
String	getConfigProperty(String property) Returns the value associated with the provided configuration property name.
Map<String,String>	getConfiguration() Returns an immutable map of the configuration key-value pairs stored in this MapReduceAction object.
boolean	isPropagatingConfiguration() Returns whether the configuration of the main workflow should propagate to the subworkflow.

Methods inherited from class org.apache.oozie.fluentjob.api.action.Node

getAllChildren, getAllParents, getChildrenWithConditions, getChildrenWithoutConditions, getCredentials, getDefaultConditionalChild, getErrorHandler, getName, getParentsWithConditions, getParentsWithoutConditions, getRetryInterval, getRetryMax, getRetryPolicy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAppPath

public String getAppPath()

Returns the path to the application definition (usually workflow.xml) of the subworkflow.

Returns:

The path to the application definition (usually workflow.xml) of the subworkflow.

isPropagatingConfiguration

public boolean isPropagatingConfiguration()

Returns whether the configuration of the main workflow should propagate to the subworkflow.

Returns:

true if the configuration of the main workflow should propagate to the subworkflow; false otherwise.

getConfigProperty

public String getConfigProperty(String property)

Returns the value associated with the provided configuration property name.

Parameters:

property - The name of the configuration property for which the value will be returned.

Returns:

The value associated with the provided configuration property name.

getConfiguration

public Map<String,String> getConfiguration()

Returns an immutable map of the configuration key-value pairs stored in this MapReduceAction object.

Returns:

An immutable map of the configuration key-value pairs stored in this MapReduceAction object.