Class RestResponse

  • Direct Known Subclasses:
    BytesRestResponse

    public abstract class RestResponse
    extends java.lang.Object
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.util.Map<java.lang.String,​java.util.List<java.lang.String>> customHeaders  
    • 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, or null if none have been set.
      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
    • Field Detail

      • customHeaders

        protected java.util.Map<java.lang.String,​java.util.List<java.lang.String>> customHeaders
    • 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

        @Nullable
        public java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getHeaders()
        Returns custom headers that have been added, or null if none have been set.