Package org.opensearch.client.indices.rollover

Class RolloverResponse

  • All Implemented Interfaces:
    org.opensearch.common.io.stream.Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentObject
    public final class RolloverResponse
extends org.opensearch.action.support.master.ShardsAcknowledgedResponse
    Response object for RolloverRequest API

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.opensearch.transport.TransportResponse

        org.opensearch.transport.TransportResponse.Empty

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

        org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

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

        org.opensearch.common.io.stream.Writeable.Reader<V extends java.lang.Object>, org.opensearch.common.io.stream.Writeable.Writer<V extends java.lang.Object>

    • Field Summary

      • Fields inherited from class org.opensearch.action.support.master.ShardsAcknowledgedResponse

        SHARDS_ACKNOWLEDGED

      • Fields inherited from class org.opensearch.action.support.master.AcknowledgedResponse

        acknowledged

      • Fields inherited from interface org.opensearch.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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)  
      static RolloverResponse fromXContent​(org.opensearch.common.xcontent.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

      • Methods inherited from class org.opensearch.action.support.master.ShardsAcknowledgedResponse

        addCustomFields, declareAcknowledgedAndShardsAcknowledgedFields, isShardsAcknowledged, writeShardsAcknowledged

      • Methods inherited from class org.opensearch.action.support.master.AcknowledgedResponse

        declareAcknowledgedField, isAcknowledged, toXContent, writeTo

      • Methods inherited from class org.opensearch.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.opensearch.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

      • fromXContent

        public static RolloverResponse fromXContent​(org.opensearch.common.xcontent.XContentParser parser)

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class org.opensearch.action.support.master.ShardsAcknowledgedResponse

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class org.opensearch.action.support.master.ShardsAcknowledgedResponse