java.lang.Object
org.elasticsearch.xpack.core.ilm.FreezeAction
- All Implemented Interfaces:
NamedWriteable,Writeable,org.elasticsearch.xcontent.ToXContent,org.elasticsearch.xcontent.ToXContentObject,LifecycleAction
A
LifecycleAction which freezes the index.-
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.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final FreezeActionstatic final StringFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Method Summary
Modifier and TypeMethodDescriptionbooleaninthashCode()booleanstatic FreezeActionparse(org.elasticsearch.xcontent.XContentParser parser) toSteps(Client client, String phase, Step.StepKey nextStepKey) converts theLifecycleAction's execution plan into a series ofSteps that reference each other to preserve order of operations.toString()org.elasticsearch.xcontent.XContentBuildertoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) voidwriteTo(StreamOutput out) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xpack.core.ilm.LifecycleAction
toStepsMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
NAME
- See Also:
-
CONDITIONAL_SKIP_FREEZE_STEP
- See Also:
-
INSTANCE
-
-
Method Details
-
parse
-
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
getWriteableName
- Specified by:
getWriteableNamein interfaceNamedWriteable
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceorg.elasticsearch.xcontent.ToXContent- Throws:
IOException
-
isSafeAction
public boolean isSafeAction()- Specified by:
isSafeActionin interfaceLifecycleAction- 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
Description copied from interface:LifecycleActionconverts theLifecycleAction's execution plan into a series ofSteps that reference each other to preserve order of operations.- Specified by:
toStepsin interfaceLifecycleAction- Parameters:
client- the client that will be used byAsyncActionStepandAsyncWaitStepstepsphase- the name of the phase this action is being executed withinnextStepKey- 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 eachLifecycleActionto 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() -
equals
-
toString
-