Class GetAliasesResponse

All Implemented Interfaces:
org.elasticsearch.common.xcontent.StatusToXContentObject, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject

public class GetAliasesResponse
extends java.lang.Object
implements org.elasticsearch.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.elasticsearch.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params
  • Field Summary

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

  • Method Summary

    Modifier and Type Method Description
    static GetAliasesResponse fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)
    Parse the get aliases response
    java.util.Map<java.lang.String,​java.util.Set<org.elasticsearch.cluster.metadata.AliasMetadata>> getAliases()
    Return the requested aliases
    java.lang.String getError()
    Return the possibly returned error, null otherwise
    org.elasticsearch.ElasticsearchException getException()
    Return the exception that may have been returned status()  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.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.elasticsearch.common.xcontent.ToXContentObject

  • Method Details

    • status

      public status()
      Specified by:
      status in interface org.elasticsearch.common.xcontent.StatusToXContentObject
    • getError

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

      public org.elasticsearch.ElasticsearchException getException()
      Return the exception that may have been returned
    • getAliases

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

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
    • fromXContent

      public static GetAliasesResponse fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws
      Parse the get aliases response