org.apache.ambari.server.stack.upgrade

Class ExecuteTask

java.lang.Object

org.apache.ambari.server.stack.upgrade.Task

org.apache.ambari.server.stack.upgrade.ExecuteTask

public class ExecuteTask
extends Task

Used to represent an execution that should occur on an agent. An equivalent class exists in the python server-side, called ExecuteTask in ru_execute_tasks.py

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.ambari.server.stack.upgrade.Task

Task.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	actionVerb
String	function Function name to call in the script element.
ExecuteHostType	hosts The hosts to run the task on.
String	script Similar to a command, but instead it is a call to invoke the script (using its relative path).

Fields inherited from class org.apache.ambari.server.stack.upgrade.Task

condition, GSON, isSequential, scope, summary, timeoutConfig

Constructor Summary

Constructors

Constructor and Description
ExecuteTask()

Method Summary

Modifier and Type	Method and Description
String	getActionVerb()
StageWrapper.Type	getStageWrapperType()
Task.Type	getType()

Methods inherited from class org.apache.ambari.server.stack.upgrade.Task

getSummary, toString

Methods inherited from class java.lang.Object

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

Field Detail

hosts

public ExecuteHostType hosts

The hosts to run the task on. Default to running on ExecuteHostType.ALL.

script

public String script

Similar to a command, but instead it is a call to invoke the script (using its relative path). THe script and function elements are used together, and are invoked with additional environment variables. If both a (script, function) and command are defined, only the (script, function) will be executed. The service is already specified as part of the group.

function

public String function

Function name to call in the script element.

actionVerb

public static final String actionVerb

See Also:

Constant Field Values

Constructor Detail

ExecuteTask

public ExecuteTask()

Method Detail

getType

public Task.Type getType()

Specified by:

getType in class Task

Returns:

the type of the task

getStageWrapperType

public StageWrapper.Type getStageWrapperType()

Specified by:

getStageWrapperType in class Task

Returns:

when a single Task is constructed, this is the type of stage it should belong to.

getActionVerb

public String getActionVerb()

Specified by:

getActionVerb in class Task

Returns:

a verb to display that describes the type of task, e.g., "executing".