org.apache.oozie.fluentjob.api.action

Class SshActionBuilder

java.lang.Object

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

org.apache.oozie.fluentjob.api.action.SshActionBuilder

All Implemented Interfaces:

Builder<SshAction>

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public class SshActionBuilder
extends NodeBuilderBaseImpl<SshActionBuilder>
implements Builder<SshAction>

A builder class for EmailAction. 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
SshAction	build() Builds and returns an object.
SshActionBuilder	clearArgs()
static SshActionBuilder	create()
static SshActionBuilder	createFromExistingAction(Node action)
static SshActionBuilder	createFromExistingAction(SshAction action)
protected SshActionBuilder	getRuntimeSelfReference()
SshActionBuilder	withArg(String arg)
SshActionBuilder	withCaptureOutput(Boolean captureOutput)
SshActionBuilder	withCommand(String command)
SshActionBuilder	withHost(String host)
SshActionBuilder	withoutArg(String arg)

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

createFromExistingAction

public static SshActionBuilder createFromExistingAction(SshAction action)

createFromExistingAction

public static SshActionBuilder createFromExistingAction(Node action)

withHost

public SshActionBuilder withHost(String host)

withCommand

public SshActionBuilder withCommand(String command)

withArg

public SshActionBuilder withArg(String arg)

withoutArg

public SshActionBuilder withoutArg(String arg)

clearArgs

public SshActionBuilder clearArgs()

withCaptureOutput

public SshActionBuilder withCaptureOutput(Boolean captureOutput)

build

public SshAction build()

Description copied from interface: Builder

Builds and returns an object.

Specified by:

build in interface Builder<SshAction>

Returns:

The built object.

getRuntimeSelfReference

protected SshActionBuilder getRuntimeSelfReference()

Specified by:

getRuntimeSelfReference in class NodeBuilderBaseImpl<SshActionBuilder>