org.apache.oozie.fluentjob.api.action

Class MapReduceActionBuilder

java.lang.Object

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

org.apache.oozie.fluentjob.api.action.MapReduceActionBuilder

All Implemented Interfaces:

Builder<MapReduceAction>

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public class MapReduceActionBuilder
extends NodeBuilderBaseImpl<MapReduceActionBuilder>
implements Builder<MapReduceAction>

A builder class for MapReduceAction.

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
MapReduceAction	build() Creates a new MapReduceAction object with the properties stores in this builder.
MapReduceActionBuilder	clearArchives() Removes all archives that are registered with this builder.
MapReduceActionBuilder	clearFiles() Removes all files that are registered with this builder.
MapReduceActionBuilder	clearJobXmls() Removes all job XMLs that are registered with this builder.
static MapReduceActionBuilder	create() Creates and returns an empty builder.
static MapReduceActionBuilder	createFromExistingAction(Node action) Create and return a new MapReduceActionBuilder that is based on an already built MapReduceAction object.
protected MapReduceActionBuilder	getRuntimeSelfReference()
MapReduceActionBuilder	withArchive(String archive) Registers an archive with this builder.
MapReduceActionBuilder	withConfigClass(String configClass) Registers a configuration class with this builder.
MapReduceActionBuilder	withConfigProperty(String key, String value) Registers a configuration property (a key-value pair) with this builder.
MapReduceActionBuilder	withFile(String file) Registers a file with this builder.
MapReduceActionBuilder	withJobXml(String jobXml) Registers a job XML with this builder.
MapReduceActionBuilder	withNameNode(String nameNode) Registers a name node.
MapReduceActionBuilder	withoutArchive(String archive) Removes an archive if it is registered with this builder, otherwise does nothing.
MapReduceActionBuilder	withoutFile(String file) Removes a file if it is registered with this builder, otherwise does nothing.
MapReduceActionBuilder	withoutJobXml(String jobXml) Removes a job XML if it is registered with this builder, otherwise does nothing.
MapReduceActionBuilder	withPipes(Pipes pipes) Registers a Pipes object.
MapReduceActionBuilder	withPrepare(Prepare prepare) Registers a Prepare object.
MapReduceActionBuilder	withResourceManager(String resourceManager)
MapReduceActionBuilder	withStreaming(Streaming streaming) Registers a Streaming object.

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 MapReduceActionBuilder create()

Creates and returns an empty builder.

Returns:

An empty builder.

createFromExistingAction

public static MapReduceActionBuilder createFromExistingAction(Node action)

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

Parameters:

action - The MapReduceAction object on which this MapReduceActionBuilder will be based.

Returns:

A new MapReduceActionBuilder that is based on a previously built MapReduceAction object.

withResourceManager

public MapReduceActionBuilder withResourceManager(String resourceManager)

withNameNode

public MapReduceActionBuilder withNameNode(String nameNode)

Registers a name node.

Parameters:

nameNode - The string representing the name node.

Returns:

this

Throws:

IllegalStateException - if a name node has already been set on this builder.

withPrepare

public MapReduceActionBuilder withPrepare(Prepare prepare)

Registers a Prepare object.

Parameters:

prepare - The Prepare object to register.

Returns:

this

Throws:

IllegalStateException - if a Prepare object has already been set on this builder.

withStreaming

public MapReduceActionBuilder withStreaming(Streaming streaming)

Registers a Streaming object.

Parameters:

streaming - The Streaming object to register.

Returns:

this

Throws:

IllegalStateException - if a Streaming object has already been set on this builder.

withPipes

public MapReduceActionBuilder withPipes(Pipes pipes)

Registers a Pipes object.

Parameters:

pipes - The Pipes object to register.

Returns:

this

Throws:

IllegalStateException - if a Pipes object has already been set on this builder.

withJobXml

public MapReduceActionBuilder withJobXml(String jobXml)

Registers a job XML with this builder.

Parameters:

jobXml - The job XML to register.

Returns:

this

withoutJobXml

public MapReduceActionBuilder withoutJobXml(String jobXml)

Removes a job XML if it is registered with this builder, otherwise does nothing.

Parameters:

jobXml - The job XML to remove.

Returns:

this

clearJobXmls

public MapReduceActionBuilder clearJobXmls()

Removes all job XMLs that are registered with this builder.

Returns:

this

withConfigProperty

public MapReduceActionBuilder 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.

withConfigClass

public MapReduceActionBuilder withConfigClass(String configClass)

Registers a configuration class with this builder.

Parameters:

configClass - The string representing the configuration class.

Returns:

this

Throws:

IllegalStateException - if a configuration class has already been set on this builder.

withFile

public MapReduceActionBuilder withFile(String file)

Registers a file with this builder.

Parameters:

file - The file to register.

Returns:

this

withoutFile

public MapReduceActionBuilder withoutFile(String file)

Removes a file if it is registered with this builder, otherwise does nothing.

Parameters:

file - The file to remove.

Returns:

this

clearFiles

public MapReduceActionBuilder clearFiles()

Removes all files that are registered with this builder.

Returns:

this

withArchive

public MapReduceActionBuilder withArchive(String archive)

Registers an archive with this builder.

Parameters:

archive - The archive to register.

Returns:

this

withoutArchive

public MapReduceActionBuilder withoutArchive(String archive)

Removes an archive if it is registered with this builder, otherwise does nothing.

Parameters:

archive - The archive to remove.

Returns:

this

clearArchives

public MapReduceActionBuilder clearArchives()

Removes all archives that are registered with this builder.

Returns:

this

build

public MapReduceAction build()

Creates a new MapReduceAction 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<MapReduceAction>

Returns:

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

getRuntimeSelfReference

protected MapReduceActionBuilder getRuntimeSelfReference()

Specified by:

getRuntimeSelfReference in class NodeBuilderBaseImpl<MapReduceActionBuilder>