Class Response

java.lang.Object
org.opensearch.client.Response
public class Response extends Object
Holds an opensearch response. It wraps the HttpResponse returned and associates it with its corresponding RequestLine and HttpHost.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.hc.core5.http.HttpEntity
    getEntity()
    Returns the response body available, null otherwise
    String
    getHeader(String name)
    Returns the value of the first header with a specified name of this message.
    org.apache.hc.core5.http.Header[]
    getHeaders()
    Returns all the response headers
    org.apache.hc.core5.http.HttpHost
    getHost()
    Returns the node that returned this response
    org.apache.hc.core5.http.message.RequestLine
    getRequestLine()
    Returns the request line that generated this response
    org.apache.hc.core5.http.message.StatusLine
    getStatusLine()
    Returns the status line of the current response
    List<String>
    getWarnings()
    Returns a list of all warning headers returned in the response.
    boolean
    hasWarnings()
    Returns true if there is at least one warning header returned in the response.
    String
    toString()
    Convert response to string representation

    Methods inherited from class java.lang.Object

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

  • Method Details

    • getRequestLine

      public org.apache.hc.core5.http.message.RequestLine getRequestLine()
      Returns the request line that generated this response

    • getHost

      public org.apache.hc.core5.http.HttpHost getHost()
      Returns the node that returned this response

    • getStatusLine

      public org.apache.hc.core5.http.message.StatusLine getStatusLine()
      Returns the status line of the current response

    • getHeaders

      public org.apache.hc.core5.http.Header[] getHeaders()
      Returns all the response headers

    • getHeader

      public String getHeader(String name)
      Returns the value of the first header with a specified name of this message. If there is more than one matching header in the message the first element is returned. If there is no matching header in the message null is returned.
      Parameters:
      name - header name

    • getEntity

      public org.apache.hc.core5.http.HttpEntity getEntity()
      Returns the response body available, null otherwise
      See Also:
      • HttpEntity

    • getWarnings

      public List<String> getWarnings()
      Returns a list of all warning headers returned in the response.

    • hasWarnings

      public boolean hasWarnings()
      Returns true if there is at least one warning header returned in the response.

    • toString

      public String toString()
      Convert response to string representation
      Overrides:
      toString in class Object