Package co.elastic.clients.elasticsearch.watcher

Enum ActionExecutionMode

java.lang.Object
java.lang.Enum<ActionExecutionMode>
co.elastic.clients.elasticsearch.watcher.ActionExecutionMode
All Implemented Interfaces:
JsonEnum, JsonpSerializable, java.io.Serializable, java.lang.Comparable<ActionExecutionMode>, java.lang.constant.Constable
@JsonpDeserializable
public enum ActionExecutionMode
extends java.lang.Enum<ActionExecutionMode>
implements JsonEnum
See Also:
API specification

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

    Nested classes/interfaces inherited from interface co.elastic.clients.json.JsonEnum

    JsonEnum.Deserializer<T extends JsonEnum>

  • Enum Constant Summary

    Enum Constants
    Enum Constant Description
    Execute
    Executes the action as it would have been executed if the watch had been triggered by its own trigger.
    ForceExecute
    Similar to the execute mode, except the action is not throttled even if the current state of the watch indicates it should be.
    ForceSimulate
    Similar to the simulate mode, except the action is not throttled even if the current state of the watch indicates it should be.
    Simulate
    The action execution is simulated.
    Skip
    The action is skipped and is not executed or simulated.

  • Field Summary

    Fields
    Modifier and Type Field Description
    static JsonEnum.Deserializer<ActionExecutionMode> _DESERIALIZER  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String jsonValue()  
    static ActionExecutionMode valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static ActionExecutionMode[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface co.elastic.clients.json.JsonEnum

    aliases, serialize

  • Enum Constant Details

    • Simulate

      public static final ActionExecutionMode Simulate
      The action execution is simulated. Each action type defines its own simulation operation mode. For example, the email action creates the email that would have been sent but does not actually send it. In this mode, the action might be throttled if the current state of the watch indicates it should be.

    • ForceSimulate

      public static final ActionExecutionMode ForceSimulate
      Similar to the simulate mode, except the action is not throttled even if the current state of the watch indicates it should be.

    • Execute

      public static final ActionExecutionMode Execute
      Executes the action as it would have been executed if the watch had been triggered by its own trigger. The execution might be throttled if the current state of the watch indicates it should be.

    • ForceExecute

      public static final ActionExecutionMode ForceExecute
      Similar to the execute mode, except the action is not throttled even if the current state of the watch indicates it should be.

    • Skip

      public static final ActionExecutionMode Skip
      The action is skipped and is not executed or simulated. Effectively forces the action to be throttled.

  • Field Details

  • Method Details

    • values

      public static ActionExecutionMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static ActionExecutionMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null

    • jsonValue

      public java.lang.String jsonValue()
      Specified by:
      jsonValue in interface JsonEnum