blob: d67fbb866fa6637b69a6e0fad333525dff5c7f0c [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::PlanTableScanResponse Struct 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"><a class="el" href="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="namespaceiceberg_1_1rest.html">rest</a></li><li class="navelem"><a class="el" href="structiceberg_1_1rest_1_1PlanTableScanResponse.html">PlanTableScanResponse</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structiceberg_1_1rest_1_1PlanTableScanResponse-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::rest::PlanTableScanResponse Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Response from initiating a scan planning operation, including plan status and initial scan tasks.
<a href="structiceberg_1_1rest_1_1PlanTableScanResponse.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="types_8h_source.html">types.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:a911c5af130563b0b3f18d8a459eb8fd4" id="r_a911c5af130563b0b3f18d8a459eb8fd4"><td class="memItemLeft" align="right" valign="top"><a id="a911c5af130563b0b3f18d8a459eb8fd4" name="a911c5af130563b0b3f18d8a459eb8fd4"></a>
Status&#160;</td><td class="memItemRight" valign="bottom"><b>Validate</b> () const</td></tr>
<tr class="separator:a911c5af130563b0b3f18d8a459eb8fd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3800a3b8b940b7f0df6798b6aa8d0e9" id="r_ab3800a3b8b940b7f0df6798b6aa8d0e9"><td class="memItemLeft" align="right" valign="top"><a id="ab3800a3b8b940b7f0df6798b6aa8d0e9" name="ab3800a3b8b940b7f0df6798b6aa8d0e9"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="structiceberg_1_1rest_1_1PlanTableScanResponse.html">PlanTableScanResponse</a> &amp;) const</td></tr>
<tr class="separator:ab3800a3b8b940b7f0df6798b6aa8d0e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a634d6d66a2e832101eb4d8201d52c2ca" id="r_a634d6d66a2e832101eb4d8201d52c2ca"><td class="memItemLeft" align="right" valign="top"><a id="a634d6d66a2e832101eb4d8201d52c2ca" name="a634d6d66a2e832101eb4d8201d52c2ca"></a>
std::optional&lt; std::vector&lt; std::string &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>plan_tasks</b></td></tr>
<tr class="separator:a634d6d66a2e832101eb4d8201d52c2ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85975f7aa7c47b569d6a23d0e096b250" id="r_a85975f7aa7c47b569d6a23d0e096b250"><td class="memItemLeft" align="right" valign="top"><a id="a85975f7aa7c47b569d6a23d0e096b250" name="a85975f7aa7c47b569d6a23d0e096b250"></a>
std::optional&lt; std::vector&lt; std::shared_ptr&lt; <a class="el" href="classiceberg_1_1FileScanTask.html">FileScanTask</a> &gt; &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>file_scan_tasks</b></td></tr>
<tr class="separator:a85975f7aa7c47b569d6a23d0e096b250"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2f3fc2dcbb458cb993bddc15ed2f303" id="r_ac2f3fc2dcbb458cb993bddc15ed2f303"><td class="memItemLeft" align="right" valign="top"><a id="ac2f3fc2dcbb458cb993bddc15ed2f303" name="ac2f3fc2dcbb458cb993bddc15ed2f303"></a>
std::vector&lt; std::shared_ptr&lt; <a class="el" href="structiceberg_1_1DataFile.html">DataFile</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>delete_files</b></td></tr>
<tr class="separator:ac2f3fc2dcbb458cb993bddc15ed2f303"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5270b2769cd34e51bc319b31138119e" id="r_ad5270b2769cd34e51bc319b31138119e"><td class="memItemLeft" align="right" valign="top"><a id="ad5270b2769cd34e51bc319b31138119e" name="ad5270b2769cd34e51bc319b31138119e"></a>
<a class="el" href="namespaceiceberg_1_1rest.html#aa87d5beb145c3452177fa4d9f9cf58b5">PlanStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><b>plan_status</b> = PlanStatus::kCompleted</td></tr>
<tr class="separator:ad5270b2769cd34e51bc319b31138119e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aead1e60fca2a40fe3bc53aefd08b0616" id="r_aead1e60fca2a40fe3bc53aefd08b0616"><td class="memItemLeft" align="right" valign="top"><a id="aead1e60fca2a40fe3bc53aefd08b0616" name="aead1e60fca2a40fe3bc53aefd08b0616"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>plan_id</b></td></tr>
<tr class="separator:aead1e60fca2a40fe3bc53aefd08b0616"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc51d4db254a98dea19471a3485ca3f5" id="r_acc51d4db254a98dea19471a3485ca3f5"><td class="memItemLeft" align="right" valign="top"><a id="acc51d4db254a98dea19471a3485ca3f5" name="acc51d4db254a98dea19471a3485ca3f5"></a>
std::optional&lt; <a class="el" href="structiceberg_1_1rest_1_1ErrorResponse.html">ErrorResponse</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>error</b></td></tr>
<tr class="separator:acc51d4db254a98dea19471a3485ca3f5"><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>Response from initiating a scan planning operation, including plan status and initial scan tasks. </p>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>iceberg/catalog/rest/<a class="el" href="types_8h_source.html">types.h</a></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>