Google Git
Sign in
apache / incubator-resilientdb-python-sdk / refs/heads/gh-pages / . / classresdb__driver_1_1driver_1_1BlocksEndpoint.html
blob: 637636ae811d3c1a9208cb316e97e3d906669f1e [file] [log] [blame]
<!-- HTML header for doxygen 1.9.8-->
<!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>ResilientDB SDK: BlocksEndpoint 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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" />
<link href="doxygen_html_style.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="projectlogo"><img alt="Logo" src="logo.png"/></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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classresdb__driver_1_1driver_1_1BlocksEndpoint.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="classresdb__driver_1_1driver_1_1BlocksEndpoint-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">BlocksEndpoint Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Exposes functionality of the <code>'/blocks'</code> endpoint.
<a href="classresdb__driver_1_1driver_1_1BlocksEndpoint.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for BlocksEndpoint:</div>
<div class="dyncontent">
<div class="center">
<img src="classresdb__driver_1_1driver_1_1BlocksEndpoint.png" usemap="#BlocksEndpoint_map" alt=""/>
<map id="BlocksEndpoint_map" name="BlocksEndpoint_map">
<area href="classresdb__driver_1_1driver_1_1NamespacedDriver.html" title="Base class for creating endpoints (namespaced objects) that can be added under the :class:~resdb_driv..." alt="NamespacedDriver" shape="rect" coords="0,0,121,24"/>
</map>
</div></div>
<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:a723c0216ab6987efc1dc23a2d04337f2" id="r_a723c0216ab6987efc1dc23a2d04337f2"><td class="memItemLeft" align="right" valign="top">list[dict]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1BlocksEndpoint.html#a723c0216ab6987efc1dc23a2d04337f2">get</a> (self, *txid, headers=None)</td></tr>
<tr class="memdesc:a723c0216ab6987efc1dc23a2d04337f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">TODO: Add endpoints in nodes. <br /></td></tr>
<tr class="separator:a723c0216ab6987efc1dc23a2d04337f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classresdb__driver_1_1driver_1_1NamespacedDriver"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classresdb__driver_1_1driver_1_1NamespacedDriver')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classresdb__driver_1_1driver_1_1NamespacedDriver.html">NamespacedDriver</a></td></tr>
<tr class="memitem:a2546937b2c011198c7e39541aca153c9 inherit pub_methods_classresdb__driver_1_1driver_1_1NamespacedDriver" id="r_a2546937b2c011198c7e39541aca153c9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1NamespacedDriver.html#a2546937b2c011198c7e39541aca153c9">__init__</a> (self, <a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html">Resdb</a> <a class="el" href="classresdb__driver_1_1driver_1_1NamespacedDriver.html#a5752b9eb2786389fa4eea908e15c39c5">driver</a>)</td></tr>
<tr class="memdesc:a2546937b2c011198c7e39541aca153c9 inherit pub_methods_classresdb__driver_1_1driver_1_1NamespacedDriver"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes an instance of :class:<code>~resdb_driver.driver.NamespacedDriver</code> with the given driver instance. <br /></td></tr>
<tr class="separator:a2546937b2c011198c7e39541aca153c9 inherit pub_methods_classresdb__driver_1_1driver_1_1NamespacedDriver"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37eacece6bd680ede410c8f7b135ff98 inherit pub_methods_classresdb__driver_1_1driver_1_1NamespacedDriver" id="r_a37eacece6bd680ede410c8f7b135ff98"><td class="memItemLeft" align="right" valign="top">str&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1NamespacedDriver.html#a37eacece6bd680ede410c8f7b135ff98">api_prefix</a> (self)</td></tr>
<tr class="separator:a37eacece6bd680ede410c8f7b135ff98 inherit pub_methods_classresdb__driver_1_1driver_1_1NamespacedDriver"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab73e6efc52ce7a21b22cbf9f3465df91 inherit pub_methods_classresdb__driver_1_1driver_1_1NamespacedDriver" id="r_ab73e6efc52ce7a21b22cbf9f3465df91"><td class="memItemLeft" align="right" valign="top">str&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1NamespacedDriver.html#ab73e6efc52ce7a21b22cbf9f3465df91">path</a> (self)</td></tr>
<tr class="separator:ab73e6efc52ce7a21b22cbf9f3465df91 inherit pub_methods_classresdb__driver_1_1driver_1_1NamespacedDriver"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae71d9b898c84d98291d44b27505b00c1 inherit pub_methods_classresdb__driver_1_1driver_1_1NamespacedDriver" id="r_ae71d9b898c84d98291d44b27505b00c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classresdb__driver_1_1transport_1_1Transport.html">Transport</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1NamespacedDriver.html#ae71d9b898c84d98291d44b27505b00c1">transport</a> (self)</td></tr>
<tr class="separator:ae71d9b898c84d98291d44b27505b00c1 inherit pub_methods_classresdb__driver_1_1driver_1_1NamespacedDriver"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a62345317491758a93722c16ba442b023" id="r_a62345317491758a93722c16ba442b023"><td class="memItemLeft" align="right" valign="top">str&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1BlocksEndpoint.html#a62345317491758a93722c16ba442b023">PATH</a> = &quot;/blocks/&quot;</td></tr>
<tr class="separator:a62345317491758a93722c16ba442b023"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_static_attribs_classresdb__driver_1_1driver_1_1NamespacedDriver"><td colspan="2" onclick="javascript:toggleInherit('pub_static_attribs_classresdb__driver_1_1driver_1_1NamespacedDriver')"><img src="closed.png" alt="-"/>&#160;Static Public Attributes inherited from <a class="el" href="classresdb__driver_1_1driver_1_1NamespacedDriver.html">NamespacedDriver</a></td></tr>
<tr class="memitem:a62345317491758a93722c16ba442b023 inherit pub_static_attribs_classresdb__driver_1_1driver_1_1NamespacedDriver" id="r_a62345317491758a93722c16ba442b023"><td class="memItemLeft" align="right" valign="top">str&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1NamespacedDriver.html#a62345317491758a93722c16ba442b023">PATH</a> = &quot;/&quot;</td></tr>
<tr class="separator:a62345317491758a93722c16ba442b023 inherit pub_static_attribs_classresdb__driver_1_1driver_1_1NamespacedDriver"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_attribs_classresdb__driver_1_1driver_1_1NamespacedDriver"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classresdb__driver_1_1driver_1_1NamespacedDriver')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classresdb__driver_1_1driver_1_1NamespacedDriver.html">NamespacedDriver</a></td></tr>
<tr class="memitem:a5752b9eb2786389fa4eea908e15c39c5 inherit pub_attribs_classresdb__driver_1_1driver_1_1NamespacedDriver" id="r_a5752b9eb2786389fa4eea908e15c39c5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1NamespacedDriver.html#a5752b9eb2786389fa4eea908e15c39c5">driver</a></td></tr>
<tr class="separator:a5752b9eb2786389fa4eea908e15c39c5 inherit pub_attribs_classresdb__driver_1_1driver_1_1NamespacedDriver"><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>Exposes functionality of the <code>'/blocks'</code> endpoint. </p>
<p>Attributes: path (str): The path of the endpoint. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a723c0216ab6987efc1dc23a2d04337f2" name="a723c0216ab6987efc1dc23a2d04337f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a723c0216ab6987efc1dc23a2d04337f2">&#9670;&#160;</a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> list[dict] get </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">*&#160;</td>
<td class="paramname"><em>txid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>headers</em> = <code>None</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>TODO: Add endpoints in nodes. </p>
<p>transaction_id is a query parameter here Get the block that contains the given transaction id (<code>txid</code>) else return <code>None</code></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">txid</td><td>(str): Transaction id. </td></tr>
<tr><td class="paramname">headers</td><td>(dict): Optional headers to pass to the request.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>List of block heights. </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a62345317491758a93722c16ba442b023" name="a62345317491758a93722c16ba442b023"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62345317491758a93722c16ba442b023">&#9670;&#160;</a></span>PATH</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">str PATH = &quot;/blocks/&quot;</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/github/workspace/resdb_driver/<a class="el" href="driver_8py.html">driver.py</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceresdb__driver.html">resdb_driver</a></li><li class="navelem"><a class="el" href="namespaceresdb__driver_1_1driver.html">driver</a></li><li class="navelem"><a class="el" href="classresdb__driver_1_1driver_1_1BlocksEndpoint.html">BlocksEndpoint</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
</html>