Package org.opensearch.client

Class GetAliasesResponse

  • All Implemented Interfaces:
    org.opensearch.common.xcontent.StatusToXContentObject, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentObject
    public class GetAliasesResponse
extends java.lang.Object
implements org.opensearch.common.xcontent.StatusToXContentObject
    Response obtained from the get aliases API. The format is pretty horrible as it holds aliases, but at the same time errors can come back through the status and error fields. Such errors are mostly 404 - NOT FOUND for aliases that were specified but not found. In such case the client won't throw exception so it allows to retrieve the returned aliases, while at the same time checking if errors were returned. There's also the case where an exception is returned, like for instance an IndexNotFoundException. We would usually throw such exception, but we configure the client to not throw for 404 to support the case above, hence we also not throw in case an index is not found, although it is a hard error that doesn't come back with aliases.

    • Nested Class Summary

      • 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

    • Field Summary

      • Fields inherited from interface org.opensearch.common.xcontent.ToXContent

        EMPTY_PARAMS

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static GetAliasesResponse fromXContent​(org.opensearch.common.xcontent.XContentParser parser)
      Parse the get aliases response
      java.util.Map<java.lang.String,​java.util.Set<org.opensearch.cluster.metadata.AliasMetadata>> getAliases()
      Return the requested aliases
      java.lang.String getError()
      Return the possibly returned error, null otherwise
      org.opensearch.OpenSearchException getException()
      Return the exception that may have been returned
      org.opensearch.rest.RestStatus status()  
      org.opensearch.common.xcontent.XContentBuilder toXContent​(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)  

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.opensearch.common.xcontent.ToXContentObject

        isFragment

    • Method Detail

      • status

        public org.opensearch.rest.RestStatus status()
        Specified by:
        status in interface org.opensearch.common.xcontent.StatusToXContentObject

      • getError

        public java.lang.String getError()
        Return the possibly returned error, null otherwise

      • getException

        public org.opensearch.OpenSearchException getException()
        Return the exception that may have been returned

      • getAliases

        public java.util.Map<java.lang.String,​java.util.Set<org.opensearch.cluster.metadata.AliasMetadata>> getAliases()
        Return the requested aliases

      • toXContent

        public org.opensearch.common.xcontent.XContentBuilder toXContent​(org.opensearch.common.xcontent.XContentBuilder builder,
                                                                 org.opensearch.common.xcontent.ToXContent.Params params)
                                                          throws java.io.IOException
        Specified by:
        toXContent in interface org.opensearch.common.xcontent.ToXContent
        Throws:
        java.io.IOException

      • fromXContent

        public static GetAliasesResponse fromXContent​(org.opensearch.common.xcontent.XContentParser parser)
                                       throws java.io.IOException
        Parse the get aliases response
        Throws:
        java.io.IOException