Package 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.support.master.AcknowledgedResponse

org.elasticsearch.action.support.master.ShardsAcknowledgedResponse

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

All Implemented Interfaces:

Streamable, Writeable, ToXContent, ToXContentObject

public final class RolloverResponse
extends ShardsAcknowledgedResponse
implements ToXContentObject

Response object for RolloverRequest API Note: there is a new class with the same name for the Java HLRC that uses a typeless format. Any changes done to this class should also go to that client class.

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

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.elasticsearch.action.support.master.AcknowledgedResponse

acknowledged

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RolloverResponse(java.lang.String oldIndex, java.lang.String newIndex, java.util.Map<java.lang.String,java.lang.Boolean> conditionResults, boolean dryRun, boolean rolledOver, boolean acknowledged, boolean shardsAcknowledged)

Method Summary

Modifier and Type	Method	Description
protected void	addCustomFields(XContentBuilder builder, ToXContent.Params params)
boolean	equals(java.lang.Object o)
static RolloverResponse	fromXContent(XContentParser parser)
java.util.Map<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
int	hashCode()
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()	Deprecated. use ShardsAcknowledgedResponse.isShardsAcknowledged()
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.action.support.master.ShardsAcknowledgedResponse

declareAcknowledgedAndShardsAcknowledgedFields, isShardsAcknowledged, readShardsAcknowledged, writeShardsAcknowledged

Methods inherited from class org.elasticsearch.action.support.master.AcknowledgedResponse

declareAcknowledgedField, isAcknowledged, toXContent

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

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

toXContent

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

isFragment

Constructor Detail

RolloverResponse

public RolloverResponse(java.lang.String oldIndex,
                        java.lang.String newIndex,
                        java.util.Map<java.lang.String,java.lang.Boolean> conditionResults,
                        boolean dryRun,
                        boolean rolledOver,
                        boolean acknowledged,
                        boolean shardsAcknowledged)

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.Map<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

isShardsAcked

@Deprecated
public boolean isShardsAcked()

Deprecated.

use ShardsAcknowledgedResponse.isShardsAcknowledged()

Returns true if the requisite number of shards were started in the newly created rollover index before returning. If AcknowledgedResponse.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 AcknowledgedResponse

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

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class AcknowledgedResponse

Throws:

java.io.IOException

addCustomFields

protected void addCustomFields(XContentBuilder builder,
                               ToXContent.Params params)
                        throws java.io.IOException

Overrides:

addCustomFields in class ShardsAcknowledgedResponse

Throws:

java.io.IOException

fromXContent

public static RolloverResponse fromXContent(XContentParser parser)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class ShardsAcknowledgedResponse

hashCode

public int hashCode()

Overrides:

hashCode in class ShardsAcknowledgedResponse