org.apache.oozie.fluentjob.api.action

Class SubWorkflowActionBuilder

java.lang.Object

org.apache.oozie.fluentjob.api.action.NodeBuilderBaseImpl<SubWorkflowActionBuilder>

org.apache.oozie.fluentjob.api.action.SubWorkflowActionBuilder

All Implemented Interfaces:

Builder<SubWorkflowAction>

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public class SubWorkflowActionBuilder
extends NodeBuilderBaseImpl<SubWorkflowActionBuilder>
implements Builder<SubWorkflowAction>

A builder class for SubWorkflowAction. The properties of the builder can only be set once, an attempt to set them a second time will trigger an IllegalStateException. The properties that are lists are an exception to this rule, of course multiple elements can be added / removed. Builder instances can be used to build several elements, although properties already set cannot be changed after a call to build() either.

Method Summary

Modifier and Type	Method and Description
SubWorkflowAction	build() Creates a new SubWorkflowAction object with the properties stores in this builder.
static SubWorkflowActionBuilder	create() Creates and returns an empty builder.
static SubWorkflowActionBuilder	createFromExistingAction(SubWorkflowAction action) Create and return a new SubWorkflowActionBuilder that is based on an already built SubWorkflowAction object.
protected SubWorkflowActionBuilder	getRuntimeSelfReference()
SubWorkflowActionBuilder	withAppPath(String appPath) Registers the path to the application definition (usually workflow.xml) of the subworkflow.
SubWorkflowActionBuilder	withConfigProperty(String key, String value) Registers a configuration property (a key-value pair) with this builder.
SubWorkflowActionBuilder	withoutPropagatingConfiguration() Registers that the configuration of the main workflow should NOT propagate to the subworkflow.
SubWorkflowActionBuilder	withPropagatingConfiguration() Registers that the configuration of the main workflow should propagate to the subworkflow.

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

addAsChildToAllParents, clearCredentials, clearParents, withCredential, withErrorHandler, withName, withoutCredential, withoutErrorHandler, withoutParent, withParent, withParentDefaultConditional, withParentWithCondition, withRetryInterval, withRetryMax, withRetryPolicy

Methods inherited from class java.lang.Object

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

Method Detail

create

public static SubWorkflowActionBuilder create()

Creates and returns an empty builder.

Returns:

An empty builder.

createFromExistingAction

public static SubWorkflowActionBuilder createFromExistingAction(SubWorkflowAction action)

Create and return a new SubWorkflowActionBuilder that is based on an already built SubWorkflowAction object. The properties of the builder will initially be the same as those of the provided SubWorkflowAction object, but it is possible to modify them once.

Parameters:

action - The SubWorkflowAction object on which this SubWorkflowActionBuilder will be based.

Returns:

A new SubWorkflowActionBuilder that is based on a previously built SubWorkflowAction object.

withAppPath

public SubWorkflowActionBuilder withAppPath(String appPath)

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

Parameters:

appPath - HDFS application path

Returns:

This builder.

withPropagatingConfiguration

public SubWorkflowActionBuilder withPropagatingConfiguration()

Registers that the configuration of the main workflow should propagate to the subworkflow.

Returns:

This builder.

withoutPropagatingConfiguration

public SubWorkflowActionBuilder withoutPropagatingConfiguration()

Registers that the configuration of the main workflow should NOT propagate to the subworkflow.

Returns:

This builder.

withConfigProperty

public SubWorkflowActionBuilder withConfigProperty(String key,
                                                   String value)

Registers a configuration property (a key-value pair) with this builder. If the provided key has already been set on this builder, an exception is thrown. Setting a key to null means deleting it.

Parameters:

key - The name of the property to set.

value - The value of the property to set.

Returns:

this

Throws:

IllegalStateException - if the provided key has already been set on this builder.

build

public SubWorkflowAction build()

Creates a new SubWorkflowAction object with the properties stores in this builder. The new MapReduceAction object is independent of this builder and the builder can be used to build new instances.

Specified by:

build in interface Builder<SubWorkflowAction>

Returns:

A new MapReduceAction object with the properties stored in this builder.

getRuntimeSelfReference

protected SubWorkflowActionBuilder getRuntimeSelfReference()

Specified by:

getRuntimeSelfReference in class NodeBuilderBaseImpl<SubWorkflowActionBuilder>