Class FreezeAction

java.lang.Object
org.elasticsearch.xpack.core.ilm.FreezeAction
All Implemented Interfaces:
NamedWriteable, Writeable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject, LifecycleAction

@Deprecated public class FreezeAction extends Object implements LifecycleAction
Deprecated.
A noop LifecycleAction that replaces the removed freeze action. We keep it for backwards compatibility purposes in case we encounter a policy or an index that refers to this action and its steps in the lifecycle state. At 10.x we would like to sanitize the freeze action from input and expunge from the lifecycle execution state of indices.
  • Nested Class Summary

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

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    Writeable.Reader<V>, Writeable.Writer<V>
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Deprecated.
     
    static final FreezeAction
    Deprecated.
     
    static final String
    Deprecated.
     

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY, EMPTY_PARAMS
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Deprecated.
     
    Deprecated.
     
    int
    Deprecated.
     
    boolean
    Deprecated.
     
    parse(org.elasticsearch.xcontent.XContentParser parser)
    Deprecated.
     
    toSteps(Client client, String phase, Step.StepKey nextStepKey)
    Deprecated.
    converts the LifecycleAction's execution plan into a series of Steps that reference each other to preserve order of operations.
    Deprecated.
     
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
    Deprecated.
     
    void
    Deprecated.
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.elasticsearch.xpack.core.ilm.LifecycleAction

    toSteps

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

    isFragment
  • Field Details

  • Method Details

    • parse

      public static FreezeAction parse(org.elasticsearch.xcontent.XContentParser parser)
      Deprecated.
    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Deprecated.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException
    • getWriteableName

      public String getWriteableName()
      Deprecated.
      Specified by:
      getWriteableName in interface NamedWriteable
    • toXContent

      public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Deprecated.
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException
    • isSafeAction

      public boolean isSafeAction()
      Deprecated.
      Specified by:
      isSafeAction in interface LifecycleAction
      Returns:
      true if this action is considered safe. An action is not safe if it will produce unwanted side effects or will get stuck when the action configuration is changed while an index is in this action
    • toSteps

      public List<Step> toSteps(Client client, String phase, Step.StepKey nextStepKey)
      Deprecated.
      Description copied from interface: LifecycleAction
      converts the LifecycleAction's execution plan into a series of Steps that reference each other to preserve order of operations.
      Specified by:
      toSteps in interface LifecycleAction
      Parameters:
      client - the client that will be used by AsyncActionStep and AsyncWaitStep steps
      phase - the name of the phase this action is being executed within
      nextStepKey - the next step to execute after this action's steps. If null, then there are no further steps to run. It is the responsibility of each LifecycleAction to implement this correctly and not forget to link to this final step so that the policy can continue.
      Returns:
      an ordered list of steps that represent the execution plan of the action
    • hashCode

      public int hashCode()
      Deprecated.
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object obj)
      Deprecated.
      Overrides:
      equals in class Object
    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object