UNPKG

opennms

Version:

Client API for the OpenNMS network monitoring platform

github.com/OpenNMS/opennms-js

OpenNMS/opennms-js

12 lines (11 loc) • 22.5 kB
1
2
3
4
5
6
7
8
9
10
11
12
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NestedRestriction | OpenNMS.js - v2.5.11</title><meta name="description" content="Documentation for OpenNMS.js"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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 - v2.5.11</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">OpenNMS.js</a></li><li><a href="../modules/API.html">API</a></li><li><a href="API.NestedRestriction.html">NestedRestriction</a></li></ul><h1>Class NestedRestriction</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Nested query restrictions.</p> </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy" data-refl="155"><h4>Hierarchy (<a href="../hierarchy.html#API.NestedRestriction">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">NestedRestriction</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.Filter.html" class="tsd-signature-type tsd-kind-class">Filter</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/api/NestedRestriction.ts#L9">src/api/NestedRestriction.ts:9</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="API.NestedRestriction.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="API.NestedRestriction.html#clauses" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clauses</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="API.NestedRestriction.html#withandrestriction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>And<wbr/>Restriction</span></a> <a href="API.NestedRestriction.html#withorrestriction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Or<wbr/>Restriction</span></a> <a href="API.NestedRestriction.html#fromjson" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Json</span></a> </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructornestedrestriction" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">NestedRestriction</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">clauses</span><span class="tsd-signature-symbol">:</span> <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.Clause.html" class="tsd-signature-type tsd-kind-class">Clause</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.NestedRestriction.html" class="tsd-signature-type tsd-kind-class">NestedRestriction</a><a href="#constructornestedrestriction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">clauses</span>: <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.Clause.html" class="tsd-signature-type tsd-kind-class">Clause</a><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.NestedRestriction.html" class="tsd-signature-type tsd-kind-class">NestedRestriction</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/api/NestedRestriction.ts#L24">src/api/NestedRestriction.ts:24</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="clauses" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clauses</span><a href="#clauses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clauses</span><span class="tsd-signature-symbol">:</span> <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.Clause.html" class="tsd-signature-type tsd-kind-class">Clause</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The clauses containing the nested restrictions and their logical operators.</p> </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/api/NestedRestriction.ts#L22">src/api/NestedRestriction.ts:22</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="withandrestriction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>And<wbr/>Restriction</span><a href="#withandrestriction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withandrestriction-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">withAndRestriction</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">restriction</span><span class="tsd-signature-symbol">:</span> <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.Restriction.html" class="tsd-signature-type tsd-kind-class">Restriction</a> <span class="tsd-signature-symbol">|</span> <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.NestedRestriction.html" class="tsd-signature-type tsd-kind-class">NestedRestriction</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.NestedRestriction.html" class="tsd-signature-type tsd-kind-class">NestedRestriction</a><a href="#withandrestriction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds an additional restriction using the logical AND operator.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">restriction</span>: <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.Restriction.html" class="tsd-signature-type tsd-kind-class">Restriction</a> <span class="tsd-signature-symbol">|</span> <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.NestedRestriction.html" class="tsd-signature-type tsd-kind-class">NestedRestriction</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.NestedRestriction.html" class="tsd-signature-type tsd-kind-class">NestedRestriction</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/api/NestedRestriction.ts#L34">src/api/NestedRestriction.ts:34</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="withorrestriction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>with<wbr/>Or<wbr/>Restriction</span><a href="#withorrestriction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="withorrestriction-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">withOrRestriction</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">restriction</span><span class="tsd-signature-symbol">:</span> <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.Restriction.html" class="tsd-signature-type tsd-kind-class">Restriction</a> <span class="tsd-signature-symbol">|</span> <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.NestedRestriction.html" class="tsd-signature-type tsd-kind-class">NestedRestriction</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.NestedRestriction.html" class="tsd-signature-type tsd-kind-class">NestedRestriction</a><a href="#withorrestriction-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds an additional restriction using the logical OR operator.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">restriction</span>: <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.Restriction.html" class="tsd-signature-type tsd-kind-class">Restriction</a> <span class="tsd-signature-symbol">|</span> <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.NestedRestriction.html" class="tsd-signature-type tsd-kind-class">NestedRestriction</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.NestedRestriction.html" class="tsd-signature-type tsd-kind-class">NestedRestriction</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/api/NestedRestriction.ts#L29">src/api/NestedRestriction.ts:29</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fromjson" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>from<wbr/>Json</span><a href="#fromjson" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromjson-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fromJson</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">nestedRestriction</span><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> <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.NestedRestriction.html" class="tsd-signature-type tsd-kind-class">NestedRestriction</a><a href="#fromjson-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>given a nested restriction JSON structure, return a NestedRestriction object</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nestedRestriction</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../modules/API.html" class="tsd-signature-type tsd-kind-namespace">API</a><span class="tsd-signature-symbol">.</span><a href="API.NestedRestriction.html" class="tsd-signature-type tsd-kind-class">NestedRestriction</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/31b7559abdba43d83073fcaab84ac3e42022dfe6/src/api/NestedRestriction.ts#L11">src/api/NestedRestriction.ts:11</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#clauses" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clauses</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#withandrestriction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>And<wbr/>Restriction</span></a><a href="#withorrestriction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>with<wbr/>Or<wbr/>Restriction</span></a><a href="#fromjson" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Json</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">OpenNMS.js - v2.5.11</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>