Google Git
Sign in
apache / incubator-resilientdb-python-sdk / refs/heads/gh-pages / . / classresdb__driver_1_1driver_1_1Resdb.html
blob: 19357ae8781c02518a1d8e75523b6371d1fa9b79 [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: Resdb 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_1Resdb.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-attribs">Public Attributes</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classresdb__driver_1_1driver_1_1Resdb-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">Resdb Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A :class:<code>~resdb_driver.Resdb</code> driver is able to create, sign, and submit transactions to one or more nodes in a Federation.
<a href="classresdb__driver_1_1driver_1_1Resdb.html#details">More...</a></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:ab6f273f4733f16e78b25755a5c5c78ae" id="r_ab6f273f4733f16e78b25755a5c5c78ae"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html#ab6f273f4733f16e78b25755a5c5c78ae">__init__</a> (self, *list[Union[str, dict]] <a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html#a680e54eb7be0a12d3fbdaec636a83850">nodes</a>, <a class="el" href="classresdb__driver_1_1transport_1_1Transport.html">Transport</a> transport_class=<a class="el" href="classresdb__driver_1_1transport_1_1Transport.html">Transport</a>, headers=None, timeout=20)</td></tr>
<tr class="memdesc:ab6f273f4733f16e78b25755a5c5c78ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize a :class:<code>~resdb_driver.Resdb</code> driver instance. <br /></td></tr>
<tr class="separator:ab6f273f4733f16e78b25755a5c5c78ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29fc88b17d798b9d34dfcc861da69fa1" id="r_a29fc88b17d798b9d34dfcc861da69fa1"><td class="memItemLeft" align="right" valign="top">dict&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html#a29fc88b17d798b9d34dfcc861da69fa1">api_info</a> (self, headers=None)</td></tr>
<tr class="memdesc:a29fc88b17d798b9d34dfcc861da69fa1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves information provided by the API root endpoint <code>'/api/v1'</code>. <br /></td></tr>
<tr class="separator:a29fc88b17d798b9d34dfcc861da69fa1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abce53dcc0062c1d1e857c9a52a3211d2" id="r_abce53dcc0062c1d1e857c9a52a3211d2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html#abce53dcc0062c1d1e857c9a52a3211d2">assets</a> (self)</td></tr>
<tr class="memdesc:abce53dcc0062c1d1e857c9a52a3211d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">:class:<code>~resdb_driver.driver.AssetsEndpoint</code>: Exposes functionalities of the <code>'/assets'</code> endpoint. <br /></td></tr>
<tr class="separator:abce53dcc0062c1d1e857c9a52a3211d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa363cbe6e8b5d28ffba5a8d0320ba4a1" id="r_aa363cbe6e8b5d28ffba5a8d0320ba4a1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html#aa363cbe6e8b5d28ffba5a8d0320ba4a1">blocks</a> (self)</td></tr>
<tr class="memdesc:aa363cbe6e8b5d28ffba5a8d0320ba4a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">:class:<code>~resdb_driver.driver.BlocksEndpoint</code>: Exposes functionalities of the <code>'/blocks'</code> endpoint. <br /></td></tr>
<tr class="separator:aa363cbe6e8b5d28ffba5a8d0320ba4a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54e45c58352cacb6e2fdb4b4c583796f" id="r_a54e45c58352cacb6e2fdb4b4c583796f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html#a54e45c58352cacb6e2fdb4b4c583796f">get_transaction</a> (self, txid)</td></tr>
<tr class="separator:a54e45c58352cacb6e2fdb4b4c583796f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea9b51bc62678cc6ac76333dea554a6c" id="r_aea9b51bc62678cc6ac76333dea554a6c"><td class="memItemLeft" align="right" valign="top">dict&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html#aea9b51bc62678cc6ac76333dea554a6c">info</a> (self, headers=None)</td></tr>
<tr class="memdesc:aea9b51bc62678cc6ac76333dea554a6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves information of the node being connected to via the root endpoint <code>'/'</code>. <br /></td></tr>
<tr class="separator:aea9b51bc62678cc6ac76333dea554a6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a41218c4ecf771cc67234098d7fdcea" id="r_a9a41218c4ecf771cc67234098d7fdcea"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html#a9a41218c4ecf771cc67234098d7fdcea">metadata</a> (self)</td></tr>
<tr class="memdesc:a9a41218c4ecf771cc67234098d7fdcea"><td class="mdescLeft">&#160;</td><td class="mdescRight">:class:<code>~resdb_driver.driver.MetadataEndpoint</code>: Exposes functionalities of the <code>'/metadata'</code> endpoint. <br /></td></tr>
<tr class="separator:a9a41218c4ecf771cc67234098d7fdcea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a680e54eb7be0a12d3fbdaec636a83850" id="r_a680e54eb7be0a12d3fbdaec636a83850"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html#a680e54eb7be0a12d3fbdaec636a83850">nodes</a> (self)</td></tr>
<tr class="memdesc:a680e54eb7be0a12d3fbdaec636a83850"><td class="mdescLeft">&#160;</td><td class="mdescRight">:obj:<code>tuple</code> of :obj:<code>str</code>: URLs of connected nodes. <br /></td></tr>
<tr class="separator:a680e54eb7be0a12d3fbdaec636a83850"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1caf108b3655fb4a0cbec09a6ecca5fc" id="r_a1caf108b3655fb4a0cbec09a6ecca5fc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html#a1caf108b3655fb4a0cbec09a6ecca5fc">outputs</a> (self)</td></tr>
<tr class="memdesc:a1caf108b3655fb4a0cbec09a6ecca5fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">:class:<code>~resdb_driver.driver.OutputsEndpoint</code>: Exposes functionalities of the <code>'/outputs'</code> endpoint. <br /></td></tr>
<tr class="separator:a1caf108b3655fb4a0cbec09a6ecca5fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad339d0c5005cdf7704e40bb324cc4951" id="r_ad339d0c5005cdf7704e40bb324cc4951"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html#ad339d0c5005cdf7704e40bb324cc4951">transactions</a> (self)</td></tr>
<tr class="memdesc:ad339d0c5005cdf7704e40bb324cc4951"><td class="mdescLeft">&#160;</td><td class="mdescRight">:class:<code>~resdb_driver.driver.TransactionsEndpoint</code>: Exposes functionalities of the <code>'/transactions'</code> endpoint. <br /></td></tr>
<tr class="separator:ad339d0c5005cdf7704e40bb324cc4951"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac35f0019f72e41f1203f864d254e4213" id="r_ac35f0019f72e41f1203f864d254e4213"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html#ac35f0019f72e41f1203f864d254e4213">transport</a> (self)</td></tr>
<tr class="memdesc:ac35f0019f72e41f1203f864d254e4213"><td class="mdescLeft">&#160;</td><td class="mdescRight">:class:<code>~resdb_driver.transport.Transport</code>: Object responsible for forwarding requests to a :class:<code>~resdb_driver.connection.Connection</code> instance (node). <br /></td></tr>
<tr class="separator:ac35f0019f72e41f1203f864d254e4213"><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:a2063481ffdb4dc35c3484a13b18a196f" id="r_a2063481ffdb4dc35c3484a13b18a196f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html#a2063481ffdb4dc35c3484a13b18a196f">api_prefix</a></td></tr>
<tr class="separator:a2063481ffdb4dc35c3484a13b18a196f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ad0e05761baf7f53b0b5073bcc39ba4ce" id="r_ad0e05761baf7f53b0b5073bcc39ba4ce"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html#ad0e05761baf7f53b0b5073bcc39ba4ce">_assets</a></td></tr>
<tr class="separator:ad0e05761baf7f53b0b5073bcc39ba4ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7767aae27dfd8bc94b475ff6310a362" id="r_ab7767aae27dfd8bc94b475ff6310a362"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html#ab7767aae27dfd8bc94b475ff6310a362">_blocks</a></td></tr>
<tr class="separator:ab7767aae27dfd8bc94b475ff6310a362"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5ec34776ee45fe7978d51d477fe65a0" id="r_ac5ec34776ee45fe7978d51d477fe65a0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html#ac5ec34776ee45fe7978d51d477fe65a0">_metadata</a></td></tr>
<tr class="separator:ac5ec34776ee45fe7978d51d477fe65a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d071689f4a7251decb11b46025e6d97" id="r_a0d071689f4a7251decb11b46025e6d97"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html#a0d071689f4a7251decb11b46025e6d97">_nodes</a></td></tr>
<tr class="separator:a0d071689f4a7251decb11b46025e6d97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2f7c28b77619bf65e76b97ee1f7557b" id="r_af2f7c28b77619bf65e76b97ee1f7557b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html#af2f7c28b77619bf65e76b97ee1f7557b">_outputs</a></td></tr>
<tr class="separator:af2f7c28b77619bf65e76b97ee1f7557b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec8e95462d909ec980e9295092b2c4f4" id="r_aec8e95462d909ec980e9295092b2c4f4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html#aec8e95462d909ec980e9295092b2c4f4">_transactions</a></td></tr>
<tr class="separator:aec8e95462d909ec980e9295092b2c4f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc2363a669251de6147408a9e21531b0" id="r_abc2363a669251de6147408a9e21531b0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classresdb__driver_1_1driver_1_1Resdb.html#abc2363a669251de6147408a9e21531b0">_transport</a></td></tr>
<tr class="separator:abc2363a669251de6147408a9e21531b0"><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>A :class:<code>~resdb_driver.Resdb</code> driver is able to create, sign, and submit transactions to one or more nodes in a Federation. </p>
<p>If initialized with <code>&gt;1</code> nodes, the driver will send successive requests to different nodes in a round-robin fashion (this will be customizable in the future). </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ab6f273f4733f16e78b25755a5c5c78ae" name="ab6f273f4733f16e78b25755a5c5c78ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6f273f4733f16e78b25755a5c5c78ae">&#9670;&#160;</a></span>__init__()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__init__ </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">*list[Union[str, dict]]&#160;</td>
<td class="paramname"><em>nodes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classresdb__driver_1_1transport_1_1Transport.html">Transport</a> &#160;</td>
<td class="paramname"><em>transport_class</em> = <code><a class="el" href="classresdb__driver_1_1transport_1_1Transport.html">Transport</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>headers</em> = <code>None</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>timeout</em> = <code>20</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a :class:<code>~resdb_driver.Resdb</code> driver instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">*nodes</td><td>(list of (str or dict)): Resdb nodes to connect to. Currently, the full URL must be given. In the absence of any node, the default(<code>'<a href="http://localhost:9984'">http://localhost:9984'</a></code>) will be used. If node is passed as a dict, <code>endpoint</code> is a required key; <code>headers</code> is an optional <code>dict</code> of headers. </td></tr>
<tr><td class="paramname">transport_class</td><td>Optional transport class to use. Defaults to :class:<code>~resdb_driver.transport.Transport</code>. </td></tr>
<tr><td class="paramname">headers</td><td>(dict): Optional headers that will be passed with each request. To pass headers only on a per-request basis, you can pass the headers to the method of choice (e.g. :meth:<code>Resdb().transactions.send_commit() &lt;.TransactionsEndpoint.send_commit&gt;</code>). </td></tr>
<tr><td class="paramname">timeout</td><td>(int): Optional timeout in seconds that will be passed to each request.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An instance of the Resdb class </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a29fc88b17d798b9d34dfcc861da69fa1" name="a29fc88b17d798b9d34dfcc861da69fa1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29fc88b17d798b9d34dfcc861da69fa1">&#9670;&#160;</a></span>api_info()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> dict api_info </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>headers</em> = <code>None</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves information provided by the API root endpoint <code>'/api/v1'</code>. </p>
<p>TODO: implement the endpoint in the node</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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>Details of the HTTP API provided by the Resdb server. </dd></dl>
</div>
</div>
<a id="abce53dcc0062c1d1e857c9a52a3211d2" name="abce53dcc0062c1d1e857c9a52a3211d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abce53dcc0062c1d1e857c9a52a3211d2">&#9670;&#160;</a></span>assets()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">assets </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>:class:<code>~resdb_driver.driver.AssetsEndpoint</code>: Exposes functionalities of the <code>'/assets'</code> endpoint. </p>
<p>TODO: check </p>
</div>
</div>
<a id="aa363cbe6e8b5d28ffba5a8d0320ba4a1" name="aa363cbe6e8b5d28ffba5a8d0320ba4a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa363cbe6e8b5d28ffba5a8d0320ba4a1">&#9670;&#160;</a></span>blocks()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">blocks </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>:class:<code>~resdb_driver.driver.BlocksEndpoint</code>: Exposes functionalities of the <code>'/blocks'</code> endpoint. </p>
<p>TODO: check </p>
</div>
</div>
<a id="a54e45c58352cacb6e2fdb4b4c583796f" name="a54e45c58352cacb6e2fdb4b4c583796f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54e45c58352cacb6e2fdb4b4c583796f">&#9670;&#160;</a></span>get_transaction()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">get_transaction </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>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aea9b51bc62678cc6ac76333dea554a6c" name="aea9b51bc62678cc6ac76333dea554a6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea9b51bc62678cc6ac76333dea554a6c">&#9670;&#160;</a></span>info()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> dict info </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>headers</em> = <code>None</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves information of the node being connected to via the root endpoint <code>'/'</code>. </p>
<p>Note: TODO: implement the endpoint in the node (Single node)</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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>Details of the node that this instance is connected to. Some information that may be interesting - Server version, overview of all the endpoints </dd></dl>
</div>
</div>
<a id="a9a41218c4ecf771cc67234098d7fdcea" name="a9a41218c4ecf771cc67234098d7fdcea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a41218c4ecf771cc67234098d7fdcea">&#9670;&#160;</a></span>metadata()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">metadata </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>:class:<code>~resdb_driver.driver.MetadataEndpoint</code>: Exposes functionalities of the <code>'/metadata'</code> endpoint. </p>
<p>TODO: check </p>
</div>
</div>
<a id="a680e54eb7be0a12d3fbdaec636a83850" name="a680e54eb7be0a12d3fbdaec636a83850"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a680e54eb7be0a12d3fbdaec636a83850">&#9670;&#160;</a></span>nodes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">nodes </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>:obj:<code>tuple</code> of :obj:<code>str</code>: URLs of connected nodes. </p>
</div>
</div>
<a id="a1caf108b3655fb4a0cbec09a6ecca5fc" name="a1caf108b3655fb4a0cbec09a6ecca5fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1caf108b3655fb4a0cbec09a6ecca5fc">&#9670;&#160;</a></span>outputs()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">outputs </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>:class:<code>~resdb_driver.driver.OutputsEndpoint</code>: Exposes functionalities of the <code>'/outputs'</code> endpoint. </p>
<p>TODO: check </p>
</div>
</div>
<a id="ad339d0c5005cdf7704e40bb324cc4951" name="ad339d0c5005cdf7704e40bb324cc4951"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad339d0c5005cdf7704e40bb324cc4951">&#9670;&#160;</a></span>transactions()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">transactions </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>:class:<code>~resdb_driver.driver.TransactionsEndpoint</code>: Exposes functionalities of the <code>'/transactions'</code> endpoint. </p>
<p>TODO: check </p>
</div>
</div>
<a id="ac35f0019f72e41f1203f864d254e4213" name="ac35f0019f72e41f1203f864d254e4213"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac35f0019f72e41f1203f864d254e4213">&#9670;&#160;</a></span>transport()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">transport </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>:class:<code>~resdb_driver.transport.Transport</code>: Object responsible for forwarding requests to a :class:<code>~resdb_driver.connection.Connection</code> instance (node). </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ad0e05761baf7f53b0b5073bcc39ba4ce" name="ad0e05761baf7f53b0b5073bcc39ba4ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0e05761baf7f53b0b5073bcc39ba4ce">&#9670;&#160;</a></span>_assets</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">_assets</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab7767aae27dfd8bc94b475ff6310a362" name="ab7767aae27dfd8bc94b475ff6310a362"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7767aae27dfd8bc94b475ff6310a362">&#9670;&#160;</a></span>_blocks</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">_blocks</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac5ec34776ee45fe7978d51d477fe65a0" name="ac5ec34776ee45fe7978d51d477fe65a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5ec34776ee45fe7978d51d477fe65a0">&#9670;&#160;</a></span>_metadata</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">_metadata</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a0d071689f4a7251decb11b46025e6d97" name="a0d071689f4a7251decb11b46025e6d97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d071689f4a7251decb11b46025e6d97">&#9670;&#160;</a></span>_nodes</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">_nodes</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af2f7c28b77619bf65e76b97ee1f7557b" name="af2f7c28b77619bf65e76b97ee1f7557b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2f7c28b77619bf65e76b97ee1f7557b">&#9670;&#160;</a></span>_outputs</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">_outputs</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aec8e95462d909ec980e9295092b2c4f4" name="aec8e95462d909ec980e9295092b2c4f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec8e95462d909ec980e9295092b2c4f4">&#9670;&#160;</a></span>_transactions</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">_transactions</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="abc2363a669251de6147408a9e21531b0" name="abc2363a669251de6147408a9e21531b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc2363a669251de6147408a9e21531b0">&#9670;&#160;</a></span>_transport</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">_transport</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a2063481ffdb4dc35c3484a13b18a196f" name="a2063481ffdb4dc35c3484a13b18a196f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2063481ffdb4dc35c3484a13b18a196f">&#9670;&#160;</a></span>api_prefix</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">api_prefix</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_1Resdb.html">Resdb</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>