Module org.elasticsearch.xcore
Class ExecuteWatchRequestBuilder
java.lang.Object
org.elasticsearch.action.ActionRequestBuilder<ExecuteWatchRequest,ExecuteWatchResponse>
org.elasticsearch.xpack.core.watcher.transport.actions.execute.ExecuteWatchRequestBuilder
- All Implemented Interfaces:
RequestBuilder<ExecuteWatchRequest,ExecuteWatchResponse>
public class ExecuteWatchRequestBuilder
extends ActionRequestBuilder<ExecuteWatchRequest,ExecuteWatchResponse>
A execute watch action request builder.
-
Field Summary
Fields inherited from class org.elasticsearch.action.ActionRequestBuilder
action, client, request -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionsetActionMode(String actionId, ActionExecutionMode actionMode) Sets the mode in which the given action (identified by its id) will be handled.setAlternativeInput(Map<String, Object> alternativeInput) setDebug(boolean debug) Sets the id of the watch to be executedsetIgnoreCondition(boolean ignoreCondition) setRecordExecution(boolean recordExecution) setTriggerData(Map<String, Object> data) setTriggerEvent(TriggerEvent triggerEvent) setWatchSource(BytesReference watchSource, org.elasticsearch.xcontent.XContentType xContentType) setWatchSource(WatchSourceBuilder watchSource)
-
Constructor Details
-
ExecuteWatchRequestBuilder
-
ExecuteWatchRequestBuilder
-
-
Method Details
-
setId
Sets the id of the watch to be executed -
setIgnoreCondition
- Parameters:
ignoreCondition- set if the condition for this execution be ignored
-
setRecordExecution
- Parameters:
recordExecution- Sets if this execution be recorded in the history index and reflected in the watch
-
setAlternativeInput
- Parameters:
alternativeInput- Set's the alernative input
-
setTriggerData
- Parameters:
data- The data that should be associated with the trigger event- Throws:
IOException
-
setTriggerEvent
- Parameters:
triggerEvent- the trigger event to use- Throws:
IOException
-
setWatchSource
public ExecuteWatchRequestBuilder setWatchSource(BytesReference watchSource, org.elasticsearch.xcontent.XContentType xContentType) - Parameters:
watchSource- instead of using an existing watch use this non persisted watch
-
setWatchSource
- Parameters:
watchSource- instead of using an existing watch use this non persisted watch
-
setActionMode
Sets the mode in which the given action (identified by its id) will be handled.- Parameters:
actionId- The id of the actionactionMode- The mode in which the action will be handled in the execution
-
setDebug
- Parameters:
debug- indicates whether the watch should execute in debug mode. In debug mode the returned watch record will hold the executionvars
-