Package org.apache.iceberg.rest

Interface HTTPRequest

@Immutable public interface HTTPRequest
Represents an HTTP request.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    HTTPRequest.HTTPMethod
     

  • Method Summary

    Modifier and Type
    Method
    Description
    URI
    baseUri()
    Returns the base URI configured at the REST client level.
    Object
    body()
    Returns the raw, unencoded request body.
    default void
    check()
     
    default String
    encodedBody()
    Returns the encoded request body as a string.
    default HTTPHeaders
    headers()
    Returns the headers of this request.
    default com.fasterxml.jackson.databind.ObjectMapper
    mapper()
    Returns the ObjectMapper to use for encoding the request body.
    HTTPRequest.HTTPMethod
    method()
    Returns the HTTP method of this request.
    String
    path()
    Returns the path of this request.
    Map<String,String>
    queryParameters()
    Returns the query parameters of this request.
    default URI
    requestUri()
    Returns the full URI of this request.

  • Method Details

    • baseUri

      @Nullable URI baseUri()
      Returns the base URI configured at the REST client level. The base URI is used to construct the full requestUri(). May be null if the REST client does not have a base URI and the path is an absolute URI.

    • requestUri

      @Lazy default URI requestUri()
      Returns the full URI of this request. The URI is constructed from the base URI, path, and query parameters. It cannot be modified directly.

    • method

      HTTPRequest.HTTPMethod method()
      Returns the HTTP method of this request.

    • path

      String path()
      Returns the path of this request.

    • queryParameters

      Map<String,String> queryParameters()
      Returns the query parameters of this request.

    • headers

      @Default default HTTPHeaders headers()
      Returns the headers of this request.

    • body

      @Nullable @Redacted Object body()
      Returns the raw, unencoded request body.

    • encodedBody

      @Lazy @Nullable @Redacted default String encodedBody()
      Returns the encoded request body as a string.

    • mapper

      @Default default com.fasterxml.jackson.databind.ObjectMapper mapper()
      Returns the ObjectMapper to use for encoding the request body. The default is RESTObjectMapper.mapper().

    • check

      @Check default void check()