Package org.opensearch.client.opensearch.generic

Interface Request

  • public interface Request
    Generic HTTP request to OpenSearch

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Optional<Body> getBody()
      The optional body of the request.
      java.lang.String getEndpoint()
      The path of the request (without scheme, host, port, or prefix).
      java.util.Collection<java.util.Map.Entry<java.lang.String,​java.lang.String>> getHeaders()
      List of headers
      java.lang.String getMethod()
      The HTTP method.
      java.util.Map<java.lang.String,​java.lang.String> getParameters()
      Query string parameters.

    • Method Detail

      • getMethod

        java.lang.String getMethod()
        The HTTP method.

      • getEndpoint

        java.lang.String getEndpoint()
        The path of the request (without scheme, host, port, or prefix).
        Returns:
        path of the request

      • getParameters

        java.util.Map<java.lang.String,​java.lang.String> getParameters()
        Query string parameters. The returned map is an unmodifiable view of the map in the request.
        Returns:
        query string parameters

      • getHeaders

        java.util.Collection<java.util.Map.Entry<java.lang.String,​java.lang.String>> getHeaders()
        List of headers
        Returns:
        list of headers

      • getBody

        java.util.Optional<Body> getBody()
        The optional body of the request. If Optional.empty() then no body is sent with the request.
        Returns:
        optional body of the request