Package org.opensearch.client.opensearch.generic

Class Requests

  • public final class Requests
extends java.lang.Object
    Helper class to construct requests instances

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Requests.JsonBodyBuilder
      A new builder for requests with JSON body

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Requests.JsonBodyBuilder builder()
      Creates a new builder for requests with JSON body
      static Request create​(java.lang.String method, java.lang.String endpoint, java.util.Collection<java.util.Map.Entry<java.lang.String,​java.lang.String>> headers, java.util.Map<java.lang.String,​java.lang.String> parameters, Body body)
      Create request instance

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • builder

        public static Requests.JsonBodyBuilder builder()
        Creates a new builder for requests with JSON body
        Returns:
        a new builder for requests with JSON body

      • create

        public static Request create​(java.lang.String method,
                             java.lang.String endpoint,
                             java.util.Collection<java.util.Map.Entry<java.lang.String,​java.lang.String>> headers,
                             java.util.Map<java.lang.String,​java.lang.String> parameters,
                             @Nullable
                             Body body)
        Create request instance
        Parameters:
        method - the HTTP method
        endpoint - the path of the request (without scheme, host, port, or prefix)
        headers - list of headers
        parameters - query parameters
        body - optional body
        Returns:
        request instance