Class RolloverAction

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

public class RolloverAction extends Object implements LifecycleAction
A LifecycleAction which rolls over the index.
  • Field Details

  • Constructor Details

    • RolloverAction

      public RolloverAction(RolloverConditions conditions)
    • RolloverAction

      public RolloverAction(@Nullable ByteSizeValue maxSize, @Nullable ByteSizeValue maxPrimaryShardSize, @Nullable org.elasticsearch.core.TimeValue maxAge, @Nullable Long maxDocs, @Nullable Long maxPrimaryShardDocs, @Nullable ByteSizeValue minSize, @Nullable ByteSizeValue minPrimaryShardSize, @Nullable org.elasticsearch.core.TimeValue minAge, @Nullable Long minDocs, @Nullable Long minPrimaryShardDocs)
  • Method Details

    • parse

      public static RolloverAction parse(org.elasticsearch.xcontent.XContentParser parser) throws IOException
      Throws:
      IOException
    • read

      public static RolloverAction read(StreamInput in) throws IOException
      Throws:
      IOException
    • writeTo

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

      public String getWriteableName()
      Specified by:
      getWriteableName in interface NamedWriteable
    • getConditions

      public RolloverConditions getConditions()
    • 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
    • isSafeAction

      public boolean isSafeAction()
      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)
      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()
      Overrides:
      hashCode in class Object
    • equals

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

      public String toString()
      Overrides:
      toString in class Object