Package org.apache.iceberg.rest

Interface RESTClient

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

BaseHTTPClient, HTTPClient

public interface RESTClient
extends Closeable

Interface for a basic HTTP Client for interfacing with the REST catalog.

Method Summary

Modifier and Type	Method	Description
default <T extends RESTResponse> T	delete(String path, Class<T> responseType, Supplier<Map<String,String>> headers, Consumer<ErrorResponse> errorHandler)
<T extends RESTResponse> T	delete(String path, Class<T> responseType, Map<String,String> headers, Consumer<ErrorResponse> errorHandler)
default <T extends RESTResponse> T	delete(String path, Map<String,String> queryParams, Class<T> responseType, Supplier<Map<String,String>> headers, Consumer<ErrorResponse> errorHandler)
default <T extends RESTResponse> T	delete(String path, Map<String,String> queryParams, Class<T> responseType, Map<String,String> headers, Consumer<ErrorResponse> errorHandler)
default <T extends RESTResponse> T	get(String path, Class<T> responseType, Supplier<Map<String,String>> headers, Consumer<ErrorResponse> errorHandler)
default <T extends RESTResponse> T	get(String path, Class<T> responseType, Map<String,String> headers, Consumer<ErrorResponse> errorHandler)
default <T extends RESTResponse> T	get(String path, Map<String,String> queryParams, Class<T> responseType, Supplier<Map<String,String>> headers, Consumer<ErrorResponse> errorHandler)
<T extends RESTResponse> T	get(String path, Map<String,String> queryParams, Class<T> responseType, Map<String,String> headers, Consumer<ErrorResponse> errorHandler)
default <T extends RESTResponse> T	get(String path, Map<String,String> queryParams, Class<T> responseType, Map<String,String> headers, Consumer<ErrorResponse> errorHandler, ParserContext parserContext)
default void	head(String path, Supplier<Map<String,String>> headers, Consumer<ErrorResponse> errorHandler)
void	head(String path, Map<String,String> headers, Consumer<ErrorResponse> errorHandler)
default <T extends RESTResponse> T	post(String path, RESTRequest body, Class<T> responseType, Supplier<Map<String,String>> headers, Consumer<ErrorResponse> errorHandler)
default <T extends RESTResponse> T	post(String path, RESTRequest body, Class<T> responseType, Supplier<Map<String,String>> headers, Consumer<ErrorResponse> errorHandler, Consumer<Map<String,String>> responseHeaders)
<T extends RESTResponse> T	post(String path, RESTRequest body, Class<T> responseType, Map<String,String> headers, Consumer<ErrorResponse> errorHandler)
default <T extends RESTResponse> T	post(String path, RESTRequest body, Class<T> responseType, Map<String,String> headers, Consumer<ErrorResponse> errorHandler, Consumer<Map<String,String>> responseHeaders)
default <T extends RESTResponse> T	post(String path, RESTRequest body, Class<T> responseType, Map<String,String> headers, Consumer<ErrorResponse> errorHandler, Consumer<Map<String,String>> responseHeaders, ParserContext parserContext)
default <T extends RESTResponse> T	postForm(String path, Map<String,String> formData, Class<T> responseType, Supplier<Map<String,String>> headers, Consumer<ErrorResponse> errorHandler)
<T extends RESTResponse> T	postForm(String path, Map<String,String> formData, Class<T> responseType, Map<String,String> headers, Consumer<ErrorResponse> errorHandler)
default RESTClient	withAuthSession(AuthSession session)	Returns a REST client that authenticates requests using the given session.

Methods inherited from interface java.io.Closeable

close

Method Details

head

default void head(String path,
 Supplier<Map<String,String>> headers,
 Consumer<ErrorResponse> errorHandler)

head

void head(String path,
 Map<String,String> headers,
 Consumer<ErrorResponse> errorHandler)

delete

default <T extends RESTResponse> T delete(String path,
 Map<String,String> queryParams,
 Class<T> responseType,
 Supplier<Map<String,String>> headers,
 Consumer<ErrorResponse> errorHandler)

delete

default <T extends RESTResponse> T delete(String path,
 Class<T> responseType,
 Supplier<Map<String,String>> headers,
 Consumer<ErrorResponse> errorHandler)

delete

<T extends RESTResponse> T delete(String path,
 Class<T> responseType,
 Map<String,String> headers,
 Consumer<ErrorResponse> errorHandler)

delete

default <T extends RESTResponse> T delete(String path,
 Map<String,String> queryParams,
 Class<T> responseType,
 Map<String,String> headers,
 Consumer<ErrorResponse> errorHandler)

get

default <T extends RESTResponse> T get(String path,
 Class<T> responseType,
 Supplier<Map<String,String>> headers,
 Consumer<ErrorResponse> errorHandler)

get

default <T extends RESTResponse> T get(String path,
 Class<T> responseType,
 Map<String,String> headers,
 Consumer<ErrorResponse> errorHandler)

get

default <T extends RESTResponse> T get(String path,
 Map<String,String> queryParams,
 Class<T> responseType,
 Supplier<Map<String,String>> headers,
 Consumer<ErrorResponse> errorHandler)

get

default <T extends RESTResponse> T get(String path,
 Map<String,String> queryParams,
 Class<T> responseType,
 Map<String,String> headers,
 Consumer<ErrorResponse> errorHandler,
 ParserContext parserContext)

get

<T extends RESTResponse> T get(String path,
 Map<String,String> queryParams,
 Class<T> responseType,
 Map<String,String> headers,
 Consumer<ErrorResponse> errorHandler)

post

default <T extends RESTResponse> T post(String path,
 RESTRequest body,
 Class<T> responseType,
 Supplier<Map<String,String>> headers,
 Consumer<ErrorResponse> errorHandler)

post

default <T extends RESTResponse> T post(String path,
 RESTRequest body,
 Class<T> responseType,
 Supplier<Map<String,String>> headers,
 Consumer<ErrorResponse> errorHandler,
 Consumer<Map<String,String>> responseHeaders)

post

default <T extends RESTResponse> T post(String path,
 RESTRequest body,
 Class<T> responseType,
 Map<String,String> headers,
 Consumer<ErrorResponse> errorHandler,
 Consumer<Map<String,String>> responseHeaders,
 ParserContext parserContext)

post

default <T extends RESTResponse> T post(String path,
 RESTRequest body,
 Class<T> responseType,
 Map<String,String> headers,
 Consumer<ErrorResponse> errorHandler,
 Consumer<Map<String,String>> responseHeaders)

post

<T extends RESTResponse> T post(String path,
 RESTRequest body,
 Class<T> responseType,
 Map<String,String> headers,
 Consumer<ErrorResponse> errorHandler)

postForm

default <T extends RESTResponse> T postForm(String path,
 Map<String,String> formData,
 Class<T> responseType,
 Supplier<Map<String,String>> headers,
 Consumer<ErrorResponse> errorHandler)

postForm

<T extends RESTResponse> T postForm(String path,
 Map<String,String> formData,
 Class<T> responseType,
 Map<String,String> headers,
 Consumer<ErrorResponse> errorHandler)

withAuthSession

default RESTClient withAuthSession(AuthSession session)

Returns a REST client that authenticates requests using the given session.

Implementation requirements:

• Closing the returned client SHOULD NOT affect this client: if they share common resources, the resources SHOULD NOT be closed until the parent client is closed.
• Closing the returned client SHOULD NOT close the given AuthSession: this is the responsibility of this method's caller.