org.apache.oozie.fluentjob.api.action

Class FSAction

java.lang.Object

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

org.apache.oozie.fluentjob.api.action.FSAction

All Implemented Interfaces:

HasAttributes

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public class FSAction
extends Node
implements HasAttributes

A class representing the Oozie file system action. Instances of this class should be built using the builder FSActionBuilder. 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 FSActionBuilder.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
ActionAttributes	getAttributes()
List<Chgrp>	getChgrps() Returns the Chgrp objects that specify the directories or files the owner / group of which will be changed and to what when running this action.
List<Chmod>	getChmods() Returns the Chmod objects that specify the directories or files the permission of which will be changed and to what when running this action.
String	getConfigProperty(String property) Returns the value associated with the provided configuration property name.
Map<String,String>	getConfiguration() Returns all configuration properties of this FSAction as a map.
List<Delete>	getDeletes() Returns the Delete objects that specify which directories or files will be deleted when running this action.
List<String>	getJobXmls() Returns the list of job XMLs used by this FSAction.
List<Mkdir>	getMkdirs() Returns the Mkdir objects that specify which directories will be created when running this action.
List<Move>	getMoves() Returns the Move objects that specify which directories or files will be moved and where when running this action.
String	getNameNode() Returns the name node used by this FSAction.
List<Touchz>	getTouchzs() Returns the Touchz objects that specify which files will be touched when running this action.

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

getNameNode

public String getNameNode()

Returns the name node used by this FSAction.

Returns:

The name node used by this FSAction.

getJobXmls

public List<String> getJobXmls()

Returns the list of job XMLs used by this FSAction.

Returns:

The list of job XMLs used by this FSAction.

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 all configuration properties of this FSAction as a map.

Returns:

All configuration properties of this FSAction as a map.

getDeletes

public List<Delete> getDeletes()

Returns the Delete objects that specify which directories or files will be deleted when running this action.

Returns:

The Delete objects that specify which directories or files will be deleted when running this action.

getMkdirs

public List<Mkdir> getMkdirs()

Returns the Mkdir objects that specify which directories will be created when running this action.

Returns:

The Mkdir objects that specify which directories will be created when running this action.

getMoves

public List<Move> getMoves()

Returns the Move objects that specify which directories or files will be moved and where when running this action.

Returns:

The Move objects that specify which directories or files will be moved and where when running this action.

getChmods

public List<Chmod> getChmods()

Returns the Chmod objects that specify the directories or files the permission of which will be changed and to what when running this action.

Returns:

The Chmod objects that specify the directories or files the permission of which will be changed and to what when running this action.

getTouchzs

public List<Touchz> getTouchzs()

Returns the Touchz objects that specify which files will be touched when running this action.

Returns:

The Touchz objects that specify which files will be touched when running this action.

getChgrps

public List<Chgrp> getChgrps()

Returns the Chgrp objects that specify the directories or files the owner / group of which will be changed and to what when running this action.

Returns:

The Chgrp objects that specify the directories or files the owner / group of which will be changed and to what when running this action.

getAttributes

public ActionAttributes getAttributes()

Specified by:

getAttributes in interface HasAttributes