Class ShrinkAction

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

public class ShrinkAction extends Object implements LifecycleAction
A LifecycleAction which shrinks the index.
  • Field Details

    • NAME

      public static final String NAME
      See Also:
    • NUMBER_OF_SHARDS_FIELD

      public static final org.elasticsearch.xcontent.ParseField NUMBER_OF_SHARDS_FIELD
    • MAX_PRIMARY_SHARD_SIZE

      public static final org.elasticsearch.xcontent.ParseField MAX_PRIMARY_SHARD_SIZE
    • ALLOW_WRITE_AFTER_SHRINK

      public static final org.elasticsearch.xcontent.ParseField ALLOW_WRITE_AFTER_SHRINK
    • CONDITIONAL_SKIP_SHRINK_STEP

      public static final String CONDITIONAL_SKIP_SHRINK_STEP
      See Also:
    • CONDITIONAL_DATASTREAM_CHECK_KEY

      public static final String CONDITIONAL_DATASTREAM_CHECK_KEY
      See Also:
    • CLEAR_WRITE_BLOCK_SETTINGS

      public static final Settings CLEAR_WRITE_BLOCK_SETTINGS
  • Constructor Details

  • Method Details

    • parse

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

      public Integer getNumberOfShards()
    • getMaxPrimaryShardSize

      public ByteSizeValue getMaxPrimaryShardSize()
    • getAllowWriteAfterShrink

      public boolean getAllowWriteAfterShrink()
    • 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
    • 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
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object