Package org.elasticsearch.client.watcher

Class ExecuteWatchRequest

java.lang.Object

org.elasticsearch.client.watcher.ExecuteWatchRequest

All Implemented Interfaces:

Validatable, ToXContent, ToXContentObject

public class ExecuteWatchRequest
extends Object
implements Validatable, ToXContentObject

An execute watch request to execute a watch by id or inline

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExecuteWatchRequest.ActionExecutionMode

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Fields inherited from interface org.elasticsearch.client.Validatable

EMPTY

Method Summary

Modifier and Type	Method	Description
static ExecuteWatchRequest	byId(String id)	Execute an existing watch on the cluster
Map<String,ExecuteWatchRequest.ActionExecutionMode>	getActionModes()
String	getId()
boolean	ignoreCondition()
static ExecuteWatchRequest	inline(String watchContent)	Execute an inline watch
boolean	isDebug()
boolean	recordExecution()
void	setActionMode(String actionId, ExecuteWatchRequest.ActionExecutionMode actionMode)	Sets the action execution mode for the give action (identified by its id).
void	setAlternativeInput(String alternativeInput)
void	setDebug(boolean debug)
void	setIgnoreCondition(boolean ignoreCondition)
void	setRecordExecution(boolean recordExecution)
void	setTriggerData(String data)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.client.Validatable

validate

Method Detail

byId

public static ExecuteWatchRequest byId(String id)

Execute an existing watch on the cluster

Parameters:

id - the id of the watch to execute

inline

public static ExecuteWatchRequest inline(String watchContent)

Execute an inline watch

Parameters:

watchContent - the JSON definition of the watch

getId

public String getId()

setIgnoreCondition

public void setIgnoreCondition(boolean ignoreCondition)

Parameters:

ignoreCondition - set if the condition for this execution be ignored

ignoreCondition

public boolean ignoreCondition()

setRecordExecution

public void setRecordExecution(boolean recordExecution)

Parameters:

recordExecution - Sets if this execution be recorded in the history index

recordExecution

public boolean recordExecution()

setAlternativeInput

public void setAlternativeInput(String alternativeInput)

Parameters:

alternativeInput - Sets the alternative input

setTriggerData

public void setTriggerData(String data)

Parameters:

data - A JSON string representing the data that should be associated with the trigger event.

setActionMode

public void setActionMode(String actionId,
                          ExecuteWatchRequest.ActionExecutionMode actionMode)

Sets the action execution mode for the give action (identified by its id).

Parameters:

actionId - the action id.

actionMode - the execution mode of the action.

getActionModes

public Map<String,ExecuteWatchRequest.ActionExecutionMode> getActionModes()

setDebug

public void setDebug(boolean debug)

Parameters:

debug - indicates whether the watch should execute in debug mode. In debug mode the returned watch record will hold the execution vars

isDebug

public boolean isDebug()

toString

public String toString()

Overrides:

toString in class Object

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException