Package org.opensearch.client

Class Request

java.lang.Object
org.opensearch.client.Request
public final class Request extends Object
HTTP Request to OpenSearch.

  • Constructor Details

    • Request

      public Request(String method, String endpoint)
      Create the Request.
      Parameters:
      method - the HTTP method
      endpoint - the path of the request (without scheme, host, port, or prefix)

  • Method Details

    • getMethod

      public String getMethod()
      The HTTP method.

    • getEndpoint

      public String getEndpoint()
      The path of the request (without scheme, host, port, or prefix).

    • addParameter

      public void addParameter(String name, String value)
      Add a query string parameter.
      Parameters:
      name - the name of the url parameter. Must not be null.
      value - the value of the url url parameter. If null then the parameter is sent as name rather than name=value
      Throws:
      IllegalArgumentException - if a parameter with that name has already been set

    • addParameters

      public void addParameters(Map<String,String> paramSource)
      Add query parameters using the provided map of key value pairs.
      Parameters:
      paramSource - a map of key value pairs where the key is the url parameter.
      Throws:
      IllegalArgumentException - if a parameter with that name has already been set.

    • getParameters

      public Map<String,String> getParameters()
      Query string parameters. The returned map is an unmodifiable view of the map in the request so calls to addParameter(String, String) will change it.

    • setEntity

      public void setEntity(org.apache.http.HttpEntity entity)
      Set the body of the request. If not set or set to null then no body is sent with the request.
      Parameters:
      entity - the HttpEntity to be set as the body of the request.

    • setJsonEntity

      public void setJsonEntity(String entity)
      Set the body of the request to a string. If not set or set to null then no body is sent with the request. The Content-Type will be sent as application/json. If you need a different content type then use setEntity(HttpEntity).
      Parameters:
      entity - JSON string to be set as the entity body of the request.

    • getEntity

      public org.apache.http.HttpEntity getEntity()
      The body of the request. If null then no body is sent with the request.

    • setOptions

      public void setOptions(RequestOptions options)
      Set the portion of an HTTP request to OpenSearch that can be manipulated without changing OpenSearch's behavior.
      Parameters:
      options - the options to be set.
      Throws:
      NullPointerException - if options is null.

    • setOptions

      public void setOptions(RequestOptions.Builder options)
      Set the portion of an HTTP request to OpenSearch that can be manipulated without changing OpenSearch's behavior.
      Parameters:
      options - the options to be set.
      Throws:
      NullPointerException - if options is null.

    • getOptions

      public RequestOptions getOptions()
      Get the portion of an HTTP request to OpenSearch that can be manipulated without changing OpenSearch's behavior.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object