Class RequestOptions

java.lang.Object
org.opensearch.client.RequestOptions
public final class RequestOptions extends Object
The portion of an HTTP request to OpenSearch that can be manipulated without changing OpenSearch's behavior.

  • Field Details

    • DEFAULT

      public static final RequestOptions DEFAULT
      Default request options.

  • Method Details

    • toBuilder

      public RequestOptions.Builder toBuilder()
      Create a builder that contains these options but can be modified.

    • getHeaders

      public List<org.apache.hc.core5.http.Header> getHeaders()
      Headers to attach to the request.

    • getParameters

      public Map<String,String> getParameters()
      Query parameters to attach to the request. Any parameters present here will override matching parameters in the Request, if they exist.

    • getHttpAsyncResponseConsumerFactory

      public HttpAsyncResponseConsumerFactory getHttpAsyncResponseConsumerFactory()
      The HttpAsyncResponseConsumerFactory used to create one AsyncResponseConsumer callback per retry. Controls how the response body gets streamed from a non-blocking HTTP connection on the client side.

    • getWarningsHandler

      public WarningsHandler getWarningsHandler()
      How this request should handle warnings. If null (the default) then this request will default to the behavior dictacted by RestClientBuilder.setStrictDeprecationMode(boolean).

      This can be set to WarningsHandler.PERMISSIVE if the client should ignore all warnings which is the same behavior as setting strictDeprecationMode to true. It can be set to WarningsHandler.STRICT if the client should fail if there are any warnings which is the same behavior as settings strictDeprecationMode to false.

      It can also be set to a custom implementation of WarningsHandler to permit only certain warnings or to fail the request if the warnings returned don't exactly match some set.

    • getRequestConfig

      public org.apache.hc.client5.http.config.RequestConfig getRequestConfig()
      get RequestConfig, which can set socketTimeout, connectTimeout and so on by request
      Returns:
      RequestConfig

    • toString

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

    • equals

      public boolean equals(Object obj)
      Compare two request options for equality
      Overrides:
      equals in class Object
      Parameters:
      obj - request options instance to compare with

    • hashCode

      public int hashCode()
      Calculate the hash code of the request options
      Overrides:
      hashCode in class Object