blob: c2457ef52ed3e81c1cea2ec93d0bf99013a6cee1 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.iceberg.rest</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.iceberg.rest";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.iceberg.rest</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RESTClient.html" title="interface in org.apache.iceberg.rest">RESTClient</a></th>
<td class="colLast">
<div class="block">Interface for a basic HTTP Client for interfacing with the REST catalog.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RESTMessage.html" title="interface in org.apache.iceberg.rest">RESTMessage</a></th>
<td class="colLast">
<div class="block">Interface to mark both REST requests and responses.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RESTRequest.html" title="interface in org.apache.iceberg.rest">RESTRequest</a></th>
<td class="colLast">
<div class="block">Interface to mark a REST request.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RESTResponse.html" title="interface in org.apache.iceberg.rest">RESTResponse</a></th>
<td class="colLast">
<div class="block">Interface to mark a REST response</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="CatalogHandlers.html" title="class in org.apache.iceberg.rest">CatalogHandlers</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ErrorHandler.html" title="class in org.apache.iceberg.rest">ErrorHandler</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="ErrorHandlers.html" title="class in org.apache.iceberg.rest">ErrorHandlers</a></th>
<td class="colLast">
<div class="block">A set of consumers to handle errors for requests for table entities or for namespace entities, to
throw the correct exception.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="HTTPClient.html" title="class in org.apache.iceberg.rest">HTTPClient</a></th>
<td class="colLast">
<div class="block">An HttpClient for usage with the REST catalog.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="HTTPClient.Builder.html" title="class in org.apache.iceberg.rest">HTTPClient.Builder</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ResourcePaths.html" title="class in org.apache.iceberg.rest">ResourcePaths</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RESTCatalog.html" title="class in org.apache.iceberg.rest">RESTCatalog</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.html" title="class in org.apache.iceberg.rest">RESTSerializers</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.CommitTransactionRequestDeserializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.CommitTransactionRequestDeserializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.CommitTransactionRequestSerializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.CommitTransactionRequestSerializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.ErrorResponseDeserializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.ErrorResponseDeserializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.ErrorResponseSerializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.ErrorResponseSerializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.MetadataUpdateDeserializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.MetadataUpdateDeserializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.MetadataUpdateSerializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.MetadataUpdateSerializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.NamespaceDeserializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.NamespaceDeserializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.NamespaceSerializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.NamespaceSerializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.OAuthTokenResponseDeserializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.OAuthTokenResponseDeserializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.OAuthTokenResponseSerializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.OAuthTokenResponseSerializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.RegisterTableRequestDeserializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.RegisterTableRequestDeserializer</a>&lt;T extends <a href="requests/RegisterTableRequest.html" title="interface in org.apache.iceberg.rest.requests">RegisterTableRequest</a>&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.RegisterTableRequestSerializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.RegisterTableRequestSerializer</a>&lt;T extends <a href="requests/RegisterTableRequest.html" title="interface in org.apache.iceberg.rest.requests">RegisterTableRequest</a>&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.ReportMetricsRequestDeserializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.ReportMetricsRequestDeserializer</a>&lt;T extends <a href="requests/ReportMetricsRequest.html" title="interface in org.apache.iceberg.rest.requests">ReportMetricsRequest</a>&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.ReportMetricsRequestSerializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.ReportMetricsRequestSerializer</a>&lt;T extends <a href="requests/ReportMetricsRequest.html" title="interface in org.apache.iceberg.rest.requests">ReportMetricsRequest</a>&gt;</th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.SchemaDeserializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.SchemaDeserializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.SchemaSerializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.SchemaSerializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.TableIdentifierDeserializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.TableIdentifierDeserializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.TableIdentifierSerializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.TableIdentifierSerializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.TableMetadataDeserializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.TableMetadataDeserializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.TableMetadataSerializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.TableMetadataSerializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.UnboundPartitionSpecDeserializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.UnboundPartitionSpecDeserializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.UnboundPartitionSpecSerializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.UnboundPartitionSpecSerializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.UnboundSortOrderDeserializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.UnboundSortOrderDeserializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.UnboundSortOrderSerializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.UnboundSortOrderSerializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.UpdateRequirementDeserializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.UpdateRequirementDeserializer</a></th>
<td class="colLast">Deprecated.
<div class="deprecationComment">will be removed in 1.5.0, use <code>RESTSerializers.UpdateReqDeserializer</code> instead.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.UpdateRequirementSerializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.UpdateRequirementSerializer</a></th>
<td class="colLast">Deprecated.
<div class="deprecationComment">will be removed in 1.5.0, use <code>RESTSerializers.UpdateReqSerializer</code> instead.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.UpdateTableRequestDeserializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.UpdateTableRequestDeserializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RESTSerializers.UpdateTableRequestSerializer.html" title="class in org.apache.iceberg.rest">RESTSerializers.UpdateTableRequestSerializer</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="RESTSessionCatalog.html" title="class in org.apache.iceberg.rest">RESTSessionCatalog</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="RESTUtil.html" title="class in org.apache.iceberg.rest">RESTUtil</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>