FSActionBuilder (Apache Oozie Fluent Job API 5.2.1 API)

java.lang.Object
- org.apache.oozie.fluentjob.api.action.NodeBuilderBaseImpl<FSActionBuilder>
- - org.apache.oozie.fluentjob.api.action.FSActionBuilder

All Implemented Interfaces:

Builder<FSAction>
```
@InterfaceAudience.Private
 @InterfaceStability.Unstable
public class FSActionBuilder
extends NodeBuilderBaseImpl<FSActionBuilder>
implements Builder<FSAction>
```
A builder class for FSAction.
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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FSAction`	`build()` Creates a new `FSAction` object with the properties stores in this builder.
`FSActionBuilder`	`clearChgrps()` Removes all `Chgrp` objects that are registered with this builder.
`FSActionBuilder`	`clearChmods()` Removes all `Chmod` objects that are registered with this builder.
`FSActionBuilder`	`clearDeletes()` Removes all `Delete` objects that are registered with this builder.
`FSActionBuilder`	`clearJobXmls()` Removes all job XMLs that are registered with this builder.
`FSActionBuilder`	`clearMkdirs()` Removes all `Mkdir` objects that are registered with this builder.
`FSActionBuilder`	`clearMoves()` Removes all `Move` objects that are registered with this builder.
`FSActionBuilder`	`clearTouchzs()` Removes all `Touchz` objects that are registered with this builder.
`static FSActionBuilder`	`create()` Creates and returns an empty builder.
`static FSActionBuilder`	`createFromExistingAction(Node action)` Create and return a new `FSActionBuilder` that is based on an already built `FSAction` object.
`protected FSActionBuilder`	`getRuntimeSelfReference()`
`FSActionBuilder`	`withChgrp(Chgrp chgrp)` Registers a `Chgrp` object with this builder.
`FSActionBuilder`	`withChmod(Chmod chmod)` Registers a `Chmod` object with this builder.
`FSActionBuilder`	`withConfigProperty(String key, String value)` Registers a configuration property (a key-value pair) with this builder.
`FSActionBuilder`	`withDelete(Delete delete)` Registers a `Delete` object with this builder.
`FSActionBuilder`	`withJobXml(String jobXml)` Registers a job XML with this builder.
`FSActionBuilder`	`withMkdir(Mkdir mkdir)` Registers a `Mkdir` object with this builder.
`FSActionBuilder`	`withMove(Move move)` Registers a `Move` object with this builder.
`FSActionBuilder`	`withNameNode(String nameNode)` Registers a name node.
`FSActionBuilder`	`withoutChgrp(Chgrp chgrp)` Removes a `Chgrp` object if it is registered with this builder, otherwise does nothing.
`FSActionBuilder`	`withoutChmod(Chmod chmod)` Removes a `Chmod` object if it is registered with this builder, otherwise does nothing.
`FSActionBuilder`	`withoutDelete(Delete delete)` Removes a `Delete` object if it is registered with this builder, otherwise does nothing.
`FSActionBuilder`	`withoutJobXml(String jobXml)` Removes a job XML if it is registered with this builder, otherwise does nothing.
`FSActionBuilder`	`withoutMkdir(Mkdir mkdir)` Removes a `Mkdir` object if it is registered with this builder, otherwise does nothing.
`FSActionBuilder`	`withoutMove(Move move)` Removes a `Move` object if it is registered with this builder, otherwise does nothing.
`FSActionBuilder`	`withoutTouchz(Touchz touchz)` Removes a `Touchz` object if it is registered with this builder, otherwise does nothing.
`FSActionBuilder`	`withTouchz(Touchz touchz)` Registers a `Touchz` object with this builder.

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 FSActionBuilder create()
```
    Creates and returns an empty builder.
    
    Returns:
    
    An empty builder.
  - createFromExistingAction
```
public static FSActionBuilder createFromExistingAction(Node action)
```
    Create and return a new FSActionBuilder that is based on an already built FSAction object. The properties of the builder will initially be the same as those of the provided FSAction object, but it is possible to modify them once.
    
    Parameters:
    
    action - The FSAction object on which this FSActionBuilder will be based.
    
    Returns:
    
    A new FSActionBuilder that is based on a previously built FSAction object.
  - withNameNode
```
public FSActionBuilder 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.
  - withJobXml
```
public FSActionBuilder withJobXml(String jobXml)
```
    Registers a job XML with this builder.
    
    Parameters:
    
    jobXml - The job XML to register.
    
    Returns:
    
    this
  - withoutJobXml
```
public FSActionBuilder 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 FSActionBuilder clearJobXmls()
```
    Removes all job XMLs that are registered with this builder.
    
    Returns:
    
    this
  - withConfigProperty
```
public FSActionBuilder 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.
  - withDelete
```
public FSActionBuilder withDelete(Delete delete)
```
    Registers a Delete object with this builder.
    
    Parameters:
    
    delete - The Delete object to register.
    
    Returns:
    
    this
  - withoutDelete
```
public FSActionBuilder withoutDelete(Delete delete)
```
    Removes a Delete object if it is registered with this builder, otherwise does nothing.
    
    Parameters:
    
    delete - The Delete object to remove.
    
    Returns:
    
    this
  - clearDeletes
```
public FSActionBuilder clearDeletes()
```
    Removes all Delete objects that are registered with this builder.
    
    Returns:
    
    this
  - withMkdir
```
public FSActionBuilder withMkdir(Mkdir mkdir)
```
    Registers a Mkdir object with this builder.
    
    Parameters:
    
    mkdir - The Mkdir object to register.
    
    Returns:
    
    this
  - withoutMkdir
```
public FSActionBuilder withoutMkdir(Mkdir mkdir)
```
    Removes a Mkdir object if it is registered with this builder, otherwise does nothing.
    
    Parameters:
    
    mkdir - The Mkdir object to remove.
    
    Returns:
    
    this
  - clearMkdirs
```
public FSActionBuilder clearMkdirs()
```
    Removes all Mkdir objects that are registered with this builder.
    
    Returns:
    
    this
  - withMove
```
public FSActionBuilder withMove(Move move)
```
    Registers a Move object with this builder.
    
    Parameters:
    
    move - The Move object to register.
    
    Returns:
    
    this
  - withoutMove
```
public FSActionBuilder withoutMove(Move move)
```
    Removes a Move object if it is registered with this builder, otherwise does nothing.
    
    Parameters:
    
    move - The Move object to remove.
    
    Returns:
    
    this
  - clearMoves
```
public FSActionBuilder clearMoves()
```
    Removes all Move objects that are registered with this builder.
    
    Returns:
    
    this
  - withChmod
```
public FSActionBuilder withChmod(Chmod chmod)
```
    Registers a Chmod object with this builder.
    
    Parameters:
    
    chmod - The Chmod object to register.
    
    Returns:
    
    this
  - withoutChmod
```
public FSActionBuilder withoutChmod(Chmod chmod)
```
    Removes a Chmod object if it is registered with this builder, otherwise does nothing.
    
    Parameters:
    
    chmod - The Chmod object to remove.
    
    Returns:
    
    this
  - clearChmods
```
public FSActionBuilder clearChmods()
```
    Removes all Chmod objects that are registered with this builder.
    
    Returns:
    
    this
  - withTouchz
```
public FSActionBuilder withTouchz(Touchz touchz)
```
    Registers a Touchz object with this builder.
    
    Parameters:
    
    touchz - The Touchz object to register.
    
    Returns:
    
    this
  - withoutTouchz
```
public FSActionBuilder withoutTouchz(Touchz touchz)
```
    Removes a Touchz object if it is registered with this builder, otherwise does nothing.
    
    Parameters:
    
    touchz - The Touchz object to remove.
    
    Returns:
    
    this
  - clearTouchzs
```
public FSActionBuilder clearTouchzs()
```
    Removes all Touchz objects that are registered with this builder.
    
    Returns:
    
    this
  - withChgrp
```
public FSActionBuilder withChgrp(Chgrp chgrp)
```
    Registers a Chgrp object with this builder.
    
    Parameters:
    
    chgrp - The Chgrp object to register.
    
    Returns:
    
    this
  - withoutChgrp
```
public FSActionBuilder withoutChgrp(Chgrp chgrp)
```
    Removes a Chgrp object if it is registered with this builder, otherwise does nothing.
    
    Parameters:
    
    chgrp - The Chgrp object to remove.
    
    Returns:
    
    this
  - clearChgrps
```
public FSActionBuilder clearChgrps()
```
    Removes all Chgrp objects that are registered with this builder.
    
    Returns:
    
    this
  - build
```
public FSAction build()
```
    Creates a new FSAction object with the properties stores in this builder. The new FSAction object is independent of this builder and the builder can be used to build new instances.
    
    Specified by:
    
    build in interface Builder<FSAction>
    
    Returns:
    
    A new FSAction object with the properties stored in this builder.
  - getRuntimeSelfReference
```
protected FSActionBuilder getRuntimeSelfReference()
```
    Specified by:
    
    getRuntimeSelfReference in class NodeBuilderBaseImpl<FSActionBuilder>

Class FSActionBuilder

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

create

createFromExistingAction

withNameNode

withJobXml

withoutJobXml

clearJobXmls

withConfigProperty

withDelete

withoutDelete

clearDeletes

withMkdir

withoutMkdir

clearMkdirs

withMove

withoutMove

clearMoves

withChmod

withoutChmod

clearChmods

withTouchz

withoutTouchz

clearTouchzs

withChgrp

withoutChgrp

clearChgrps

build

getRuntimeSelfReference