Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ilm

Class ReadOnlyAction

java.lang.Object

org.elasticsearch.xpack.core.ilm.ReadOnlyAction

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentObject, LifecycleAction

public class ReadOnlyAction
extends Object
implements LifecycleAction

A LifecycleAction which sets the index to be read-only.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, 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	INDEXING_COMPLETE_STEP_NAME
static final String	NAME

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ReadOnlyAction()
ReadOnlyAction(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getWriteableName()
int	hashCode()
boolean	isSafeAction()
static ReadOnlyAction	parse(XContentParser parser)
List<Step>	toSteps(Client client, String phase, Step.StepKey nextStepKey)	converts the LifecycleAction's execution plan into a series of Steps that reference each other to preserve order of operations.
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

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

NAME

public static final String NAME

See Also:

• Constant Field Values

INDEXING_COMPLETE_STEP_NAME

public static final String INDEXING_COMPLETE_STEP_NAME

See Also:

• Constant Field Values

Constructor Details

ReadOnlyAction

public ReadOnlyAction()

ReadOnlyAction

public ReadOnlyAction(StreamInput in)

Method Details

parse

public static ReadOnlyAction parse(XContentParser parser)

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

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