Package org.elasticsearch.client.watcher

Class ExecuteWatchRequest

java.lang.Object
org.elasticsearch.client.watcher.ExecuteWatchRequest
All Implemented Interfaces:
Validatable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public class ExecuteWatchRequest extends Object implements Validatable, org.elasticsearch.xcontent.ToXContentObject
An execute watch request to execute a watch by id or inline

  • Method Details

    • 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 org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException