Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./mkdocs/docs/api/classiceberg_1_1rest_1_1HttpClient.html
blob: f80803d1cd490fa499831b63abc1ca81fdd7d94b [file]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>iceberg-cpp: iceberg::rest::HttpClient Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">iceberg-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>iceberg</b></li><li class="navelem"><b>rest</b></li><li class="navelem"><a class="el" href="classiceberg_1_1rest_1_1HttpClient.html">HttpClient</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classiceberg_1_1rest_1_1HttpClient-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::rest::HttpClient Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>HTTP client for making requests to Iceberg REST <a class="el" href="classiceberg_1_1Catalog.html" title="A Catalog API for table create, drop, and load operations.">Catalog</a> API.
<a href="classiceberg_1_1rest_1_1HttpClient.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="http__client_8h_source.html">http_client.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1979033678f339a8a8e04791e9d9c7b4" id="r_a1979033678f339a8a8e04791e9d9c7b4"><td class="memItemLeft" align="right" valign="top"><a id="a1979033678f339a8a8e04791e9d9c7b4" name="a1979033678f339a8a8e04791e9d9c7b4"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>HttpClient</b> (std::unordered_map&lt; std::string, std::string &gt; default_headers={})</td></tr>
<tr class="separator:a1979033678f339a8a8e04791e9d9c7b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7e16fc73ce787908f521453e5e28d35" id="r_ae7e16fc73ce787908f521453e5e28d35"><td class="memItemLeft" align="right" valign="top"><a id="ae7e16fc73ce787908f521453e5e28d35" name="ae7e16fc73ce787908f521453e5e28d35"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>HttpClient</b> (const <a class="el" href="classiceberg_1_1rest_1_1HttpClient.html">HttpClient</a> &amp;)=delete</td></tr>
<tr class="separator:ae7e16fc73ce787908f521453e5e28d35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf252eee67e50d36add44f631b6c80c7" id="r_adf252eee67e50d36add44f631b6c80c7"><td class="memItemLeft" align="right" valign="top"><a id="adf252eee67e50d36add44f631b6c80c7" name="adf252eee67e50d36add44f631b6c80c7"></a>
<a class="el" href="classiceberg_1_1rest_1_1HttpClient.html">HttpClient</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classiceberg_1_1rest_1_1HttpClient.html">HttpClient</a> &amp;)=delete</td></tr>
<tr class="separator:adf252eee67e50d36add44f631b6c80c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a499d897a1d21d03f1b96701eb26140c6" id="r_a499d897a1d21d03f1b96701eb26140c6"><td class="memItemLeft" align="right" valign="top"><a id="a499d897a1d21d03f1b96701eb26140c6" name="a499d897a1d21d03f1b96701eb26140c6"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>HttpClient</b> (<a class="el" href="classiceberg_1_1rest_1_1HttpClient.html">HttpClient</a> &amp;&amp;)=delete</td></tr>
<tr class="separator:a499d897a1d21d03f1b96701eb26140c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca85d0ded0a0c012cbd405081b262392" id="r_aca85d0ded0a0c012cbd405081b262392"><td class="memItemLeft" align="right" valign="top"><a id="aca85d0ded0a0c012cbd405081b262392" name="aca85d0ded0a0c012cbd405081b262392"></a>
<a class="el" href="classiceberg_1_1rest_1_1HttpClient.html">HttpClient</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classiceberg_1_1rest_1_1HttpClient.html">HttpClient</a> &amp;&amp;)=delete</td></tr>
<tr class="separator:aca85d0ded0a0c012cbd405081b262392"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39537d4f5ec01b0ede94f04925d83442" id="r_a39537d4f5ec01b0ede94f04925d83442"><td class="memItemLeft" align="right" valign="top"><a id="a39537d4f5ec01b0ede94f04925d83442" name="a39537d4f5ec01b0ede94f04925d83442"></a>
Result&lt; <a class="el" href="classiceberg_1_1rest_1_1HttpResponse.html">HttpResponse</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Get</b> (const std::string &amp;path, const std::unordered_map&lt; std::string, std::string &gt; &amp;params, const std::unordered_map&lt; std::string, std::string &gt; &amp;headers, const <a class="el" href="classiceberg_1_1rest_1_1ErrorHandler.html">ErrorHandler</a> &amp;error_handler, <a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html">auth::AuthSession</a> &amp;session)</td></tr>
<tr class="memdesc:a39537d4f5ec01b0ede94f04925d83442"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends a GET request. <br /></td></tr>
<tr class="separator:a39537d4f5ec01b0ede94f04925d83442"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0109de9130ec2ae7f64081eaa188085b" id="r_a0109de9130ec2ae7f64081eaa188085b"><td class="memItemLeft" align="right" valign="top"><a id="a0109de9130ec2ae7f64081eaa188085b" name="a0109de9130ec2ae7f64081eaa188085b"></a>
Result&lt; <a class="el" href="classiceberg_1_1rest_1_1HttpResponse.html">HttpResponse</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Post</b> (const std::string &amp;path, const std::string &amp;body, const std::unordered_map&lt; std::string, std::string &gt; &amp;headers, const <a class="el" href="classiceberg_1_1rest_1_1ErrorHandler.html">ErrorHandler</a> &amp;error_handler, <a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html">auth::AuthSession</a> &amp;session)</td></tr>
<tr class="memdesc:a0109de9130ec2ae7f64081eaa188085b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends a POST request. <br /></td></tr>
<tr class="separator:a0109de9130ec2ae7f64081eaa188085b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0339303726616191906a1a7e63d24089" id="r_a0339303726616191906a1a7e63d24089"><td class="memItemLeft" align="right" valign="top"><a id="a0339303726616191906a1a7e63d24089" name="a0339303726616191906a1a7e63d24089"></a>
Result&lt; <a class="el" href="classiceberg_1_1rest_1_1HttpResponse.html">HttpResponse</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>PostForm</b> (const std::string &amp;path, const std::unordered_map&lt; std::string, std::string &gt; &amp;form_data, const std::unordered_map&lt; std::string, std::string &gt; &amp;headers, const <a class="el" href="classiceberg_1_1rest_1_1ErrorHandler.html">ErrorHandler</a> &amp;error_handler, <a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html">auth::AuthSession</a> &amp;session)</td></tr>
<tr class="memdesc:a0339303726616191906a1a7e63d24089"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends a POST request with form data. <br /></td></tr>
<tr class="separator:a0339303726616191906a1a7e63d24089"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76cd8760e0a51c0b4713927e2f0e64cf" id="r_a76cd8760e0a51c0b4713927e2f0e64cf"><td class="memItemLeft" align="right" valign="top"><a id="a76cd8760e0a51c0b4713927e2f0e64cf" name="a76cd8760e0a51c0b4713927e2f0e64cf"></a>
Result&lt; <a class="el" href="classiceberg_1_1rest_1_1HttpResponse.html">HttpResponse</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Head</b> (const std::string &amp;path, const std::unordered_map&lt; std::string, std::string &gt; &amp;headers, const <a class="el" href="classiceberg_1_1rest_1_1ErrorHandler.html">ErrorHandler</a> &amp;error_handler, <a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html">auth::AuthSession</a> &amp;session)</td></tr>
<tr class="memdesc:a76cd8760e0a51c0b4713927e2f0e64cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends a HEAD request. <br /></td></tr>
<tr class="separator:a76cd8760e0a51c0b4713927e2f0e64cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a079bd7f177d5aadaef562e165d1f6775" id="r_a079bd7f177d5aadaef562e165d1f6775"><td class="memItemLeft" align="right" valign="top"><a id="a079bd7f177d5aadaef562e165d1f6775" name="a079bd7f177d5aadaef562e165d1f6775"></a>
Result&lt; <a class="el" href="classiceberg_1_1rest_1_1HttpResponse.html">HttpResponse</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Delete</b> (const std::string &amp;path, const std::unordered_map&lt; std::string, std::string &gt; &amp;params, const std::unordered_map&lt; std::string, std::string &gt; &amp;headers, const <a class="el" href="classiceberg_1_1rest_1_1ErrorHandler.html">ErrorHandler</a> &amp;error_handler, <a class="el" href="classiceberg_1_1rest_1_1auth_1_1AuthSession.html">auth::AuthSession</a> &amp;session)</td></tr>
<tr class="memdesc:a079bd7f177d5aadaef562e165d1f6775"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends a DELETE request. <br /></td></tr>
<tr class="separator:a079bd7f177d5aadaef562e165d1f6775"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>HTTP client for making requests to Iceberg REST <a class="el" href="classiceberg_1_1Catalog.html" title="A Catalog API for table create, drop, and load operations.">Catalog</a> API. </p>
</div><hr/>The documentation for this class was generated from the following files:<ul>
<li>iceberg/catalog/rest/<a class="el" href="http__client_8h_source.html">http_client.h</a></li>
<li>iceberg/catalog/rest/<b>http_client.cc</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>