org.elasticsearch.action.admin.indices.rollover

Class RolloverResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.admin.indices.rollover.RolloverResponse

All Implemented Interfaces:

Streamable, ToXContent, ToXContentObject

public final class RolloverResponse
extends ActionResponse
implements ToXContentObject

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportResponse

TransportResponse.Empty

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Boolean>>	getConditionStatus() Returns the statuses of all the request conditions
java.lang.String	getNewIndex() Returns the name of the index that the request alias currently points to
java.lang.String	getOldIndex() Returns the name of the index that the request alias was pointing to
boolean	isAcknowledged() Returns true if the creation of the new rollover index and switching of the alias to the newly created index was successful, and returns false otherwise.
boolean	isDryRun() Returns if the rollover execution was skipped even when conditions were met
boolean	isRolledOver() Returns true if the rollover was not simulated and the conditions were met
boolean	isShardsAcked() Returns true if the requisite number of shards were started in the newly created rollover index before returning.
void	readFrom(StreamInput in) Set this object's fields from a StreamInput.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out) Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Method Detail

getOldIndex

public java.lang.String getOldIndex()

Returns the name of the index that the request alias was pointing to

getNewIndex

public java.lang.String getNewIndex()

Returns the name of the index that the request alias currently points to

getConditionStatus

public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> getConditionStatus()

Returns the statuses of all the request conditions

isDryRun

public boolean isDryRun()

Returns if the rollover execution was skipped even when conditions were met

isRolledOver

public boolean isRolledOver()

Returns true if the rollover was not simulated and the conditions were met

isAcknowledged

public boolean isAcknowledged()

Returns true if the creation of the new rollover index and switching of the alias to the newly created index was successful, and returns false otherwise. If isDryRun() is true, then this will also return false. If this returns false, then isShardsAcked() will also return false.

isShardsAcked

public boolean isShardsAcked()

Returns true if the requisite number of shards were started in the newly created rollover index before returning. If isAcknowledged() is false, then this will also return false.

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionResponse

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionResponse

Throws:

java.io.IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException