Package org.elasticsearch.rest

Class RestResponse

  • Direct Known Subclasses:
    BytesRestResponse
    public abstract class RestResponse
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      RestResponse()  

    • Method Summary

      Modifier and Type Method Description
      void addHeader​(java.lang.String name, java.lang.String value)
      Add a custom header.
      abstract BytesReference content()
      The response content.
      abstract java.lang.String contentType()
      The response content type.
      void copyHeaders​(ElasticsearchException ex)  
      java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getHeaders()
      Returns custom headers that have been added.
      abstract RestStatus status()
      The rest status code.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • RestResponse

        public RestResponse()

    • Method Detail

      • contentType

        public abstract java.lang.String contentType()
        The response content type.

      • content

        public abstract BytesReference content()
        The response content. Note, if the content is Releasable it should automatically be released when done by the channel sending it.

      • status

        public abstract RestStatus status()
        The rest status code.

      • addHeader

        public void addHeader​(java.lang.String name,
                      java.lang.String value)
        Add a custom header.

      • getHeaders

        public java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getHeaders()
        Returns custom headers that have been added. This method should not be used to mutate headers.