UNPKG

opennms

Version:

Client API for the OpenNMS network monitoring platform

821 lines 48.6 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>FlowDAO | OpenNMS.js</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">OpenNMS.js</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="flowdao.html">FlowDAO</a> </li> </ul> <h1>Class FlowDAO</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>DAO for accessing flow (Netflow/IPFIX/sFlow) data.</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <a href="basedao.html" class="tsd-signature-type">BaseDAO</a> <ul class="tsd-hierarchy"> <li> <span class="target">FlowDAO</span> </li> </ul> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section tsd-is-inherited"> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="flowdao.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section tsd-is-inherited"> <h3>Accessors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><a href="flowdao.html#http" class="tsd-kind-icon">http</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="flowdao.html#getcount" class="tsd-kind-icon">get<wbr>Count</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="flowdao.html#getexporter" class="tsd-kind-icon">get<wbr>Exporter</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="flowdao.html#getexporters" class="tsd-kind-icon">get<wbr>Exporters</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="flowdao.html#getseriesfortopnapplications" class="tsd-kind-icon">get<wbr>Series<wbr>For<wbr>TopNApplications</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="flowdao.html#getseriesfortopnconversations" class="tsd-kind-icon">get<wbr>Series<wbr>For<wbr>TopNConversations</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="flowdao.html#getsummaryfortopnapplications" class="tsd-kind-icon">get<wbr>Summary<wbr>For<wbr>TopNApplications</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="flowdao.html#getsummaryfortopnconversations" class="tsd-kind-icon">get<wbr>Summary<wbr>For<wbr>TopNConversations</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="flowdao.html#todate" class="tsd-kind-icon">to<wbr>Date</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="flowdao.html#tonumber" class="tsd-kind-icon">to<wbr>Number</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="flowdao.html#usejson" class="tsd-kind-icon">use<wbr>Json</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-static"><a href="flowdao.html#getoptions" class="tsd-kind-icon">get<wbr>Options</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-inherited"> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">new <wbr>FlowDAO<span class="tsd-signature-symbol">(</span>impl<span class="tsd-signature-symbol">: </span><a href="../interfaces/ionmshttp.html" class="tsd-signature-type">IOnmsHTTP</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ihashttp.html" class="tsd-signature-type">IHasHTTP</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="flowdao.html" class="tsd-signature-type">FlowDAO</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="basedao.html">BaseDAO</a>.<a href="basedao.html#constructor">constructor</a></p> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/BaseDAO.ts#L39">dao/BaseDAO.ts:39</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Construct a DAO instance.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>impl: <a href="../interfaces/ionmshttp.html" class="tsd-signature-type">IOnmsHTTP</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ihashttp.html" class="tsd-signature-type">IHasHTTP</a></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The HTTP implementation to use. It is also legal to pass any object conforming to the <a href="../interfaces/ihashttp.html">IHasHTTP</a> interface (like a <a href="client.html">Client</a>).</p> </div> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="flowdao.html" class="tsd-signature-type">FlowDAO</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-inherited"> <h2>Accessors</h2> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"> <a name="http" class="tsd-anchor"></a> <h3>http</h3> <ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> http<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ionmshttp.html" class="tsd-signature-type">IOnmsHTTP</a></li> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> http<span class="tsd-signature-symbol">(</span>impl<span class="tsd-signature-symbol">: </span><a href="../interfaces/ionmshttp.html" class="tsd-signature-type">IOnmsHTTP</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="basedao.html">BaseDAO</a>.<a href="basedao.html#http">http</a></p> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/BaseDAO.ts#L57">dao/BaseDAO.ts:57</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The HTTP implementation to use internally when making DAO requests.</p> </div> </div> <h4 class="tsd-returns-title">Returns <a href="../interfaces/ionmshttp.html" class="tsd-signature-type">IOnmsHTTP</a></h4> </li> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="basedao.html">BaseDAO</a>.<a href="basedao.html#http">http</a></p> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/BaseDAO.ts#L61">dao/BaseDAO.ts:61</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The HTTP implementation to use internally when making DAO requests.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>impl: <a href="../interfaces/ionmshttp.html" class="tsd-signature-type">IOnmsHTTP</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <a name="getcount" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> get<wbr>Count</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">get<wbr>Count<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="basedao.html">BaseDAO</a>.<a href="basedao.html#getcount">getCount</a></p> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/BaseDAO.ts#L79">dao/BaseDAO.ts:79</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A convenience method to make it easy for implementers to extract the count (or totalCount) values from response data.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>data: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getexporter" class="tsd-anchor"></a> <h3>get<wbr>Exporter</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Exporter<span class="tsd-signature-symbol">(</span>criteria<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, limit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, start<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, end<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="onmsflowexporter.html" class="tsd-signature-type">OnmsFlowExporter</a><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/FlowDAO.ts#L74">dao/FlowDAO.ts:74</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get detailed information about a specific node.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>criteria: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>the node ID or foreignSource:foreignId tuple</p> </div> </li> <li> <h5>limit: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>maximum number of interfaces to return (those with the most flows will be returned if the results are truncated)</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> start: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>the start of the timespan to query (defaults to 4 hours ago)</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> end: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>the end of the timespan to query (defaults to now)</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="onmsflowexporter.html" class="tsd-signature-type">OnmsFlowExporter</a><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getexporters" class="tsd-anchor"></a> <h3>get<wbr>Exporters</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Exporters<span class="tsd-signature-symbol">(</span>limit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, start<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, end<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="onmsflowexportersummary.html" class="tsd-signature-type">OnmsFlowExporterSummary</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/FlowDAO.ts#L45">dao/FlowDAO.ts:45</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get a summary of the nodes that have exported flows.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>limit: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>maximum number of exporters to return (those with the most flows will be returned if the results are truncated)</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> start: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>the start of the timespan to query (defaults to 4 hours ago)</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> end: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>the end of the timespan to query (defaults to now)</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="onmsflowexportersummary.html" class="tsd-signature-type">OnmsFlowExporterSummary</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getseriesfortopnapplications" class="tsd-anchor"></a> <h3>get<wbr>Series<wbr>For<wbr>TopNApplications</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Series<wbr>For<wbr>TopNApplications<span class="tsd-signature-symbol">(</span>N<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, start<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, end<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, step<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, includeOther<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, exporterNodeCriteria<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, ifIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="onmsflowseries.html" class="tsd-signature-type">OnmsFlowSeries</a><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/FlowDAO.ts#L146">dao/FlowDAO.ts:146</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get time series data for the top N applications/protocols based on parameters.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> N: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>how many applications&#39; series to return</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> start: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>the start of the timespan to query (defaults to 4 hours ago)</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> end: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>the end of the timespan to query (defaults to now)</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> step: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>the requested time interval between rows</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> includeOther: <span class="tsd-signature-type">boolean</span></h5> <div class="tsd-comment tsd-typography"> <p>include an additional &quot;other&quot; result that represents everything that does not match the top N</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> exporterNodeCriteria: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>the node ID or foreignSource:foreignId tuple</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> ifIndex: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>filter for flows that came through this SNMP interface</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="onmsflowseries.html" class="tsd-signature-type">OnmsFlowSeries</a><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getseriesfortopnconversations" class="tsd-anchor"></a> <h3>get<wbr>Series<wbr>For<wbr>TopNConversations</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Series<wbr>For<wbr>TopNConversations<span class="tsd-signature-symbol">(</span>N<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, start<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, end<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, step<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, exporterNodeCriteria<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, ifIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="onmsflowseries.html" class="tsd-signature-type">OnmsFlowSeries</a><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/FlowDAO.ts#L173">dao/FlowDAO.ts:173</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get time series data for the top N conversations based on parameters.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> N: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>how many conversations&#39; series to return</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> start: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>the start of the timespan to query (defaults to 4 hours ago)</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> end: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>the end of the timespan to query (defaults to now)</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> step: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>the requested time interval between rows</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> exporterNodeCriteria: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>the node ID or foreignSource:foreignId tuple</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> ifIndex: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>filter for flows that came through this SNMP interface</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="onmsflowseries.html" class="tsd-signature-type">OnmsFlowSeries</a><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getsummaryfortopnapplications" class="tsd-anchor"></a> <h3>get<wbr>Summary<wbr>For<wbr>TopNApplications</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Summary<wbr>For<wbr>TopNApplications<span class="tsd-signature-symbol">(</span>N<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, start<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, end<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, includeOther<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, exporterNodeCriteria<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, ifIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="onmsflowtable.html" class="tsd-signature-type">OnmsFlowTable</a><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/FlowDAO.ts#L95">dao/FlowDAO.ts:95</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Summarize the top N applications/protocols based on parameters.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> N: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>how many applications to return</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> start: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>the start of the timespan to query (defaults to 4 hours ago)</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> end: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>the end of the timespan to query (defaults to now)</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> includeOther: <span class="tsd-signature-type">boolean</span></h5> <div class="tsd-comment tsd-typography"> <p>include an additional &quot;other&quot; result that represents everything that does not match the top N</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> exporterNodeCriteria: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>the node ID or foreignSource:foreignId tuple</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> ifIndex: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>filter for flows that came through this SNMP interface</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="onmsflowtable.html" class="tsd-signature-type">OnmsFlowTable</a><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getsummaryfortopnconversations" class="tsd-anchor"></a> <h3>get<wbr>Summary<wbr>For<wbr>TopNConversations</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Summary<wbr>For<wbr>TopNConversations<span class="tsd-signature-symbol">(</span>N<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, start<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, end<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, exporterNodeCriteria<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, ifIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="onmsflowtable.html" class="tsd-signature-type">OnmsFlowTable</a><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/FlowDAO.ts#L120">dao/FlowDAO.ts:120</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Summarize the top N conversations based on parameters.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> N: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>how many conversations to return</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> start: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>the start of the timespan to query (defaults to 4 hours ago)</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> end: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>the end of the timespan to query (defaults to now)</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> exporterNodeCriteria: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>the node ID or foreignSource:foreignId tuple</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> ifIndex: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>filter for flows that came through this SNMP interface</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="onmsflowtable.html" class="tsd-signature-type">OnmsFlowTable</a><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <a name="todate" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> to<wbr>Date</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">to<wbr>Date<span class="tsd-signature-symbol">(</span>from<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Moment</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="basedao.html">BaseDAO</a>.<a href="basedao.html#todate">toDate</a></p> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/BaseDAO.ts#L96">dao/BaseDAO.ts:96</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Convert the given value to a date, or undefined if it cannot be converted.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>from: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Moment</span> <span class="tsd-signature-symbol"> | </span> <span class="tsd-signature-type">undefined</span> </h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <a name="tonumber" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> to<wbr>Number</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">to<wbr>Number<span class="tsd-signature-symbol">(</span>from<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="basedao.html">BaseDAO</a>.<a href="basedao.html#tonumber">toNumber</a></p> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/BaseDAO.ts#L106">dao/BaseDAO.ts:106</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Convert the given value to a number, or undefined if it cannot be converted.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>from: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol"> | </span> <span class="tsd-signature-type">undefined</span> </h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <a name="usejson" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> use<wbr>Json</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">use<wbr>Json<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="basedao.html">BaseDAO</a>.<a href="basedao.html#usejson">useJson</a></p> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/BaseDAO.ts#L68">dao/BaseDAO.ts:68</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Whether or not to use JSON when making ReST requests.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-static"> <a name="getoptions" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagProtected">Protected</span> get<wbr>Options</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-static"> <li class="tsd-signature tsd-kind-icon">get<wbr>Options<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="onmshttpoptions.html" class="tsd-signature-type">OnmsHTTPOptions</a><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/FlowDAO.ts#L30">dao/FlowDAO.ts:30</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Create an <a href="onmshttpoptions.html">OnmsHTTPOptions</a> object for DAO calls.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="onmshttpoptions.html" class="tsd-signature-type">OnmsHTTPOptions</a><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class"> <a href="flowdao.html" class="tsd-kind-icon">FlowDAO</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"> <a href="flowdao.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"> <a href="flowdao.html#http" class="tsd-kind-icon">http</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <a href="flowdao.html#getcount" class="tsd-kind-icon">get<wbr>Count</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="flowdao.html#getexporter" class="tsd-kind-icon">get<wbr>Exporter</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="flowdao.html#getexporters" class="tsd-kind-icon">get<wbr>Exporters</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="flowdao.html#getseriesfortopnapplications" class="tsd-kind-icon">get<wbr>Series<wbr>For<wbr>TopNApplications</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="flowdao.html#getseriesfortopnconversations" class="tsd-kind-icon">get<wbr>Series<wbr>For<wbr>TopNConversations</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="flowdao.html#getsummaryfortopnapplications" class="tsd-kind-icon">get<wbr>Summary<wbr>For<wbr>TopNApplications</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="flowdao.html#getsummaryfortopnconversations" class="tsd-kind-icon">get<wbr>Summary<wbr>For<wbr>TopNConversations</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <a href="flowdao.html#todate" class="tsd-kind-icon">to<wbr>Date</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <a href="flowdao.html#tonumber" class="tsd-kind-icon">to<wbr>Number</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"> <a href="flowdao.html#usejson" class="tsd-kind-icon">use<wbr>Json</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-static"> <a href="flowdao.html#getoptions" class="tsd-kind-icon">get<wbr>Options</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>