Package org.opensearch.action.admin.indices.rollover

Class RolloverResponse

java.lang.Object
org.opensearch.core.transport.TransportMessage
org.opensearch.core.transport.TransportResponse
org.opensearch.core.action.ActionResponse
org.opensearch.action.support.master.AcknowledgedResponse
org.opensearch.action.support.master.ShardsAcknowledgedResponse
org.opensearch.action.admin.indices.rollover.RolloverResponse
All Implemented Interfaces:
org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject
@PublicApi(since="1.0.0") public final class RolloverResponse extends ShardsAcknowledgedResponse implements org.opensearch.core.xcontent.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.

Opensearch.api:

  • Nested Class Summary

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

    org.opensearch.core.transport.TransportResponse.Empty

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

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

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

    org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

  • 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.core.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    RolloverResponse(String oldIndex, String newIndex, Map<String,Boolean> conditionResults, boolean dryRun, boolean rolledOver, boolean acknowledged, boolean shardsAcknowledged)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    addCustomFields(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
     
    boolean
    equals(Object o)
     
    static RolloverResponse
    fromXContent(org.opensearch.core.xcontent.XContentParser parser)
     
    Map<String,Boolean>
    getConditionStatus()
    Returns the statuses of all the request conditions
    String
    getNewIndex()
    Returns the name of the index that the request alias currently points to
    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
    isShardsAcknowledged()
    Returns true if the requisite number of shards were started before returning from the index creation operation.
    void
    writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
     

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

    declareAcknowledgedAndShardsAcknowledgedFields, writeShardsAcknowledged

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

    declareAcknowledgedField, isAcknowledged, toXContent

    Methods inherited from class org.opensearch.core.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.core.xcontent.ToXContent

    toXContent

    Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

    isFragment

  • Constructor Details

    • RolloverResponse

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

  • Method Details

    • getOldIndex

      public String getOldIndex()
      Returns the name of the index that the request alias was pointing to

    • getNewIndex

      public String getNewIndex()
      Returns the name of the index that the request alias currently points to

    • getConditionStatus

      public Map<String,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

    • isShardsAcknowledged

      public boolean isShardsAcknowledged()
      Description copied from class: ShardsAcknowledgedResponse
      Returns true if the requisite number of shards were started before returning from the index creation operation. If AcknowledgedResponse.isAcknowledged() is false, then this also returns false.
      Overrides:
      isShardsAcknowledged in class ShardsAcknowledgedResponse

    • writeTo

      public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      writeTo in interface org.opensearch.core.common.io.stream.Writeable
      Overrides:
      writeTo in class AcknowledgedResponse
      Throws:
      IOException

    • addCustomFields

      protected void addCustomFields(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params) throws IOException
      Overrides:
      addCustomFields in class ShardsAcknowledgedResponse
      Throws:
      IOException

    • fromXContent

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

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class ShardsAcknowledgedResponse

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class ShardsAcknowledgedResponse