http://git-wip-us.apache.org/repos/asf/incubator-ariatosca-website/blob/4c010d53/_site/docs/html/aria.modeling.models.html ---------------------------------------------------------------------- diff --git a/_site/docs/html/aria.modeling.models.html b/_site/docs/html/aria.modeling.models.html new file mode 100644 index 0000000..e234b3b --- /dev/null +++ b/_site/docs/html/aria.modeling.models.html @@ -0,0 +1,6395 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>aria.modeling.models — ARIA TOSCA 0.1.1 documentation</title> + + + + + + + + + + + + + + + + + + <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> + + + + + + <link rel="index" title="Index" + href="genindex.html"/> + <link rel="search" title="Search" href="search.html"/> + <link rel="top" title="ARIA TOSCA 0.1.1 documentation" href="index.html"/> + <link rel="next" title="aria.orchestrator" href="aria.orchestrator.html"/> + <link rel="prev" title="aria.modeling" href="aria.modeling.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-scroll"> + <div class="wy-side-nav-search"> + + + + <a href="index.html" class="icon icon-home"> ARIA TOSCA + + + + </a> + + + + + <div class="version"> + 0.1.1 + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="cli.html">CLI</a></li> +<li class="toctree-l1"><a class="reference internal" href="rest.html">REST</a></li> +</ul> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="aria.html"><code class="docutils literal"><span class="pre">aria</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria.cli.html"><code class="docutils literal"><span class="pre">aria.cli</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria.modeling.html"><code class="docutils literal"><span class="pre">aria.modeling</span></code></a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">aria.modeling.models</span></code></a><ul> +<li class="toctree-l2"><a class="reference internal" href="#service-template-models">Service template models</a></li> +<li class="toctree-l2"><a class="reference internal" href="#service-instance-models">Service instance models</a></li> +<li class="toctree-l2"><a class="reference internal" href="#common-models">Common models</a></li> +<li class="toctree-l2"><a class="reference internal" href="#orchestration-models">Orchestration models</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.html"><code class="docutils literal"><span class="pre">aria.orchestrator</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.context.html"><code class="docutils literal"><span class="pre">aria.orchestrator.context</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.execution_plugin.html"><code class="docutils literal"><span class="pre">aria.orchestrator.execution_plugin</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.execution_plugin.ctx_proxy.html"><code class="docutils literal"><span class="pre">aria.orchestrator.execution_plugin.ctx_proxy</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.execution_plugin.ssh.html"><code class="docutils literal"><span class="pre">aria.orchestrator.execution_plugin.ssh</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.workflows.html"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.workflows.api.html"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows.api</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.workflows.builtin.html"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows.builtin</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.workflows.executor.html"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows.executor</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria.parser.html"><code class="docutils literal"><span class="pre">aria.parser</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria.parser.consumption.html"><code class="docutils literal"><span class="pre">aria.parser.consumption</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria.parser.loading.html"><code class="docutils literal"><span class="pre">aria.parser.loading</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria.parser.modeling.html"><code class="docutils literal"><span class="pre">aria.parser.modeling</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria.parser.presentation.html"><code class="docutils literal"><span class="pre">aria.parser.presentation</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria.parser.reading.html"><code class="docutils literal"><span class="pre">aria.parser.reading</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria.parser.validation.html"><code class="docutils literal"><span class="pre">aria.parser.validation</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria.storage.html"><code class="docutils literal"><span class="pre">aria.storage</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria.utils.html"><code class="docutils literal"><span class="pre">aria.utils</span></code></a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="aria_extension_tosca.simple_v1_0.html"><code class="docutils literal"><span class="pre">aria_extension_tosca.simple_v1_0</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria_extension_tosca.simple_v1_0.modeling.html"><code class="docutils literal"><span class="pre">aria_extension_tosca.simple_v1_0.modeling</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria_extension_tosca.simple_v1_0.presentation.html"><code class="docutils literal"><span class="pre">aria_extension_tosca.simple_v1_0.presentation</span></code></a></li> +<li class="toctree-l1"><a class="reference internal" href="aria_extension_tosca.simple_nfv_v1_0.html"><code class="docutils literal"><span class="pre">aria_extension_tosca.simple_nfv_v1_0</span></code></a></li> +</ul> + + + + </div> + </div> + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">ARIA TOSCA</a> + + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + + + + + + + + + + + + + + + + +<div role="navigation" aria-label="breadcrumbs navigation"> + + <ul class="wy-breadcrumbs"> + + <li><a href="index.html">Docs</a> »</li> + + <li><code class="docutils literal"><span class="pre">aria.modeling.models</span></code></li> + + + <li class="wy-breadcrumbs-aside"> + + + <a href="_sources/aria.modeling.models.rst.txt" rel="nofollow"> View page source</a> + + + </li> + + </ul> + + + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> + <div itemprop="articleBody"> + + <div class="section" id="module-aria.modeling.models"> +<span id="aria-modeling-models"></span><h1><a class="reference internal" href="#module-aria.modeling.models" title="aria.modeling.models"><code class="xref py py-mod docutils literal"><span class="pre">aria.modeling.models</span></code></a><a class="headerlink" href="#module-aria.modeling.models" title="Permalink to this headline">¶</a></h1> +<p>Data models.</p> +<div class="section" id="service-template-models"> +<h2>Service template models<a class="headerlink" href="#service-template-models" title="Permalink to this headline">¶</a></h2> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference internal" href="#aria.modeling.models.ServiceTemplate" title="aria.modeling.models.ServiceTemplate"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.ServiceTemplate</span></code></a></td> +<td>Template for creating <a class="reference internal" href="#aria.modeling.models.Service" title="aria.modeling.models.Service"><code class="xref py py-class docutils literal"><span class="pre">Service</span></code></a> instances.</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#aria.modeling.models.NodeTemplate" title="aria.modeling.models.NodeTemplate"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.NodeTemplate</span></code></a></td> +<td>Template for creating zero or more <a class="reference internal" href="#aria.modeling.models.Node" title="aria.modeling.models.Node"><code class="xref py py-class docutils literal"><span class="pre">Node</span></code></a> instances, which are typed vertices in the service topology.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#aria.modeling.models.GroupTemplate" title="aria.modeling.models.GroupTemplate"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.GroupTemplate</span></code></a></td> +<td>Template for creating a <a class="reference internal" href="#aria.modeling.models.Group" title="aria.modeling.models.Group"><code class="xref py py-class docutils literal"><span class="pre">Group</span></code></a> instance, which is a typed logical container for zero or more <a class="reference internal" href="#aria.modeling.models.Node" title="aria.modeling.models.Node"><code class="xref py py-class docutils literal"><span class="pre">Node</span></code></a> instances.</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#aria.modeling.models.PolicyTemplate" title="aria.modeling.models.PolicyTemplate"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.PolicyTemplate</span></code></a></td> +<td>Template for creating a <a class="reference internal" href="#aria.modeling.models.Policy" title="aria.modeling.models.Policy"><code class="xref py py-class docutils literal"><span class="pre">Policy</span></code></a> instance, which is a typed set of orchestration hints applied to zero or more <a class="reference internal" href="#aria.modeling.models.Node" title="aria.modeling.models.Node"><code class="xref py py-class docutils literal"><span class="pre">Node</span></code></a> or <a class="reference internal" href="#aria.modeling.models.Group" title="aria.modeling.models.Group"><code class="xref py py-class docutils literal"><span class="pre">Group</span></code></a> instances.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#aria.modeling.models.SubstitutionTemplate" title="aria.modeling.models.SubstitutionTemplate"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.SubstitutionTemplate</span></code></a></td> +<td>Template for creating a <a class="reference internal" href="#aria.modeling.models.Substitution" title="aria.modeling.models.Substitution"><code class="xref py py-class docutils literal"><span class="pre">Substitution</span></code></a> instance, which exposes an entire instantiated service as a single node.</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#aria.modeling.models.SubstitutionTemplateMapping" title="aria.modeling.models.SubstitutionTemplateMapping"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.SubstitutionTemplateMapping</span></code></a></td> +<td>Used by <a class="reference internal" href="#aria.modeling.models.SubstitutionTemplate" title="aria.modeling.models.SubstitutionTemplate"><code class="xref py py-class docutils literal"><span class="pre">SubstitutionTemplate</span></code></a> to map a capability template or a requirement template to the exposed node.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#aria.modeling.models.RequirementTemplate" title="aria.modeling.models.RequirementTemplate"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.RequirementTemplate</span></code></a></td> +<td>Template for creating <a class="reference internal" href="#aria.modeling.models.Relationship" title="aria.modeling.models.Relationship"><code class="xref py py-class docutils literal"><span class="pre">Relationship</span></code></a> instances, which are optionally-typed edges in the service topology, connecting a <a class="reference internal" href="#aria.modeling.models.Node" title="aria.modeling.models.Node"><code class="xref py py-class docutils literal"><span class="pre">Node</span></code></a> to a <a class="reference internal" href="#aria.modeling.models.Capability" title="aria.modeling.models.Capability"><code class="xref py py-class docutils literal"><span class="pre">Capability</span></code></a> of another node.</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#aria.modeling.models.RelationshipTemplate" title="aria.modeling.models.RelationshipTemplate"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.RelationshipTemplate</span></code></a></td> +<td>Optional addition to a <a class="reference internal" href="#aria.modeling.models.RequirementTemplate" title="aria.modeling.models.RequirementTemplate"><code class="xref py py-class docutils literal"><span class="pre">RequirementTemplate</span></code></a>.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#aria.modeling.models.CapabilityTemplate" title="aria.modeling.models.CapabilityTemplate"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.CapabilityTemplate</span></code></a></td> +<td>Template for creating <a class="reference internal" href="#aria.modeling.models.Capability" title="aria.modeling.models.Capability"><code class="xref py py-class docutils literal"><span class="pre">Capability</span></code></a> instances, typed attachments which serve two purposes: to provide extra properties and attributes to <a class="reference internal" href="#aria.modeling.models.Node" title="aria.modeling.models.Node"><code class="xref py py-class docutils literal"><span class="pre">Node</span></code></a> instances, and to expose targets for <a class="reference internal" href="#aria.modeling.models.Relationship" title="aria.modeling.models.Relationship"><code class="xref py py-class docutils literal"><span class="pre">Relationship</span></code></a> instances from other nodes.</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#aria.modeling.models.InterfaceTemplate" title="aria.modeling.models.InterfaceTemplate"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.InterfaceTemplate</span></code></a></td> +<td>Template for creating <a class="reference internal" href="#aria.modeling.models.Interface" title="aria.modeling.models.Interface"><code class="xref py py-class docutils literal"><span class="pre">Interface</span></code></a> instances, which are typed bundles of <a class="reference internal" href="#aria.modeling.models.Operation" title="aria.modeling.models.Operation"><code class="xref py py-class docutils literal"><span class="pre">Operation</span></code></a> instances.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#aria.modeling.models.OperationTemplate" title="aria.modeling.models.OperationTemplate"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.OperationTemplate</span></code></a></td> +<td>Template for creating <a class="reference internal" href="#aria.modeling.models.Operation" title="aria.modeling.models.Operation"><code class="xref py py-class docutils literal"><span class="pre">Operation</span></code></a> instances, which are entry points to Python functions called as part of a workflow execution.</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#aria.modeling.models.ArtifactTemplate" title="aria.modeling.models.ArtifactTemplate"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.ArtifactTemplate</span></code></a></td> +<td>Template for creating an <a class="reference internal" href="#aria.modeling.models.Artifact" title="aria.modeling.models.Artifact"><code class="xref py py-class docutils literal"><span class="pre">Artifact</span></code></a> instance, which is a typed file, either provided in a CSAR or downloaded from a repository.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#aria.modeling.models.PluginSpecification" title="aria.modeling.models.PluginSpecification"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.PluginSpecification</span></code></a></td> +<td>Requirement for a <a class="reference internal" href="#aria.modeling.models.Plugin" title="aria.modeling.models.Plugin"><code class="xref py py-class docutils literal"><span class="pre">Plugin</span></code></a>.</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="service-instance-models"> +<h2>Service instance models<a class="headerlink" href="#service-instance-models" title="Permalink to this headline">¶</a></h2> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference internal" href="#aria.modeling.models.Service" title="aria.modeling.models.Service"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Service</span></code></a></td> +<td>Usually an instance of a <a class="reference internal" href="#aria.modeling.models.ServiceTemplate" title="aria.modeling.models.ServiceTemplate"><code class="xref py py-class docutils literal"><span class="pre">ServiceTemplate</span></code></a> and its many associated templates (node templates, group templates, policy templates, etc.).</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#aria.modeling.models.Node" title="aria.modeling.models.Node"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Node</span></code></a></td> +<td>Typed vertex in the service topology.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#aria.modeling.models.Group" title="aria.modeling.models.Group"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Group</span></code></a></td> +<td>Typed logical container for zero or more <a class="reference internal" href="#aria.modeling.models.Node" title="aria.modeling.models.Node"><code class="xref py py-class docutils literal"><span class="pre">Node</span></code></a> instances.</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#aria.modeling.models.Policy" title="aria.modeling.models.Policy"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Policy</span></code></a></td> +<td>Typed set of orchestration hints applied to zero or more <a class="reference internal" href="#aria.modeling.models.Node" title="aria.modeling.models.Node"><code class="xref py py-class docutils literal"><span class="pre">Node</span></code></a> or <a class="reference internal" href="#aria.modeling.models.Group" title="aria.modeling.models.Group"><code class="xref py py-class docutils literal"><span class="pre">Group</span></code></a> instances.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#aria.modeling.models.Substitution" title="aria.modeling.models.Substitution"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Substitution</span></code></a></td> +<td>Exposes the entire service as a single node.</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#aria.modeling.models.SubstitutionMapping" title="aria.modeling.models.SubstitutionMapping"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.SubstitutionMapping</span></code></a></td> +<td>Used by <a class="reference internal" href="#aria.modeling.models.Substitution" title="aria.modeling.models.Substitution"><code class="xref py py-class docutils literal"><span class="pre">Substitution</span></code></a> to map a capability or a requirement to the exposed node.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#aria.modeling.models.Relationship" title="aria.modeling.models.Relationship"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Relationship</span></code></a></td> +<td>Optionally-typed edge in the service topology, connecting a <a class="reference internal" href="#aria.modeling.models.Node" title="aria.modeling.models.Node"><code class="xref py py-class docutils literal"><span class="pre">Node</span></code></a> to a <a class="reference internal" href="#aria.modeling.models.Capability" title="aria.modeling.models.Capability"><code class="xref py py-class docutils literal"><span class="pre">Capability</span></code></a> of another node.</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#aria.modeling.models.Capability" title="aria.modeling.models.Capability"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Capability</span></code></a></td> +<td>Typed attachment serving two purposes: to provide extra properties and attributes to a <a class="reference internal" href="#aria.modeling.models.Node" title="aria.modeling.models.Node"><code class="xref py py-class docutils literal"><span class="pre">Node</span></code></a>, and to expose targets for <a class="reference internal" href="#aria.modeling.models.Relationship" title="aria.modeling.models.Relationship"><code class="xref py py-class docutils literal"><span class="pre">Relationship</span></code></a> instances from other nodes.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#aria.modeling.models.Interface" title="aria.modeling.models.Interface"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Interface</span></code></a></td> +<td>Typed bundle of <a class="reference internal" href="#aria.modeling.models.Operation" title="aria.modeling.models.Operation"><code class="xref py py-class docutils literal"><span class="pre">Operation</span></code></a> instances.</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#aria.modeling.models.Operation" title="aria.modeling.models.Operation"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Operation</span></code></a></td> +<td>Entry points to Python functions called as part of a workflow execution.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#aria.modeling.models.Artifact" title="aria.modeling.models.Artifact"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Artifact</span></code></a></td> +<td>Typed file, either provided in a CSAR or downloaded from a repository.</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="common-models"> +<h2>Common models<a class="headerlink" href="#common-models" title="Permalink to this headline">¶</a></h2> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference internal" href="#aria.modeling.models.Output" title="aria.modeling.models.Output"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Output</span></code></a></td> +<td>Output parameter or declaration for an output parameter.</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#aria.modeling.models.Input" title="aria.modeling.models.Input"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Input</span></code></a></td> +<td>Input parameter or declaration for an input parameter.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#aria.modeling.models.Configuration" title="aria.modeling.models.Configuration"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Configuration</span></code></a></td> +<td>Configuration parameter.</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#aria.modeling.models.Property" title="aria.modeling.models.Property"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Property</span></code></a></td> +<td>Property parameter or declaration for a property parameter.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#aria.modeling.models.Attribute" title="aria.modeling.models.Attribute"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Attribute</span></code></a></td> +<td>Attribute parameter or declaration for an attribute parameter.</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#aria.modeling.models.Type" title="aria.modeling.models.Type"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Type</span></code></a></td> +<td>Type and its children.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#aria.modeling.models.Metadata" title="aria.modeling.models.Metadata"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Metadata</span></code></a></td> +<td>Custom values associated with the service.</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="orchestration-models"> +<h2>Orchestration models<a class="headerlink" href="#orchestration-models" title="Permalink to this headline">¶</a></h2> +<table border="1" class="longtable docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<tbody valign="top"> +<tr class="row-odd"><td><a class="reference internal" href="#aria.modeling.models.Execution" title="aria.modeling.models.Execution"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Execution</span></code></a></td> +<td>Workflow execution.</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#aria.modeling.models.Task" title="aria.modeling.models.Task"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Task</span></code></a></td> +<td>Represents the smallest unit of stateful execution in ARIA.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#aria.modeling.models.Log" title="aria.modeling.models.Log"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Log</span></code></a></td> +<td>Single log message.</td> +</tr> +<tr class="row-even"><td><a class="reference internal" href="#aria.modeling.models.Plugin" title="aria.modeling.models.Plugin"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Plugin</span></code></a></td> +<td>Installed plugin.</td> +</tr> +<tr class="row-odd"><td><a class="reference internal" href="#aria.modeling.models.Argument" title="aria.modeling.models.Argument"><code class="xref py py-obj docutils literal"><span class="pre">aria.modeling.models.Argument</span></code></a></td> +<td>Python function argument parameter.</td> +</tr> +</tbody> +</table> +<dl class="class"> +<dt id="aria.modeling.models.ServiceTemplate"> +<em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">ServiceTemplate</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.ServiceTemplate" title="Permalink to this definition">¶</a></dt> +<dd><p>Template for creating <a class="reference internal" href="#aria.modeling.models.Service" title="aria.modeling.models.Service"><code class="xref py py-class docutils literal"><span class="pre">Service</span></code></a> instances.</p> +<p>Usually created by various DSL parsers, such as ARIAâs TOSCA extension. However, it can also be +created programmatically.</p> +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.artifact_types"> +<code class="descname">artifact_types</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.artifact_types" title="Permalink to this definition">¶</a></dt> +<dd><p>Base for the artifact type hierarchy,</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference internal" href="#aria.modeling.models.Type" title="aria.modeling.models.Type"><code class="xref py py-class docutils literal"><span class="pre">Type</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.capability_types"> +<code class="descname">capability_types</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.capability_types" title="Permalink to this definition">¶</a></dt> +<dd><p>Base for the capability type hierarchy,</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference internal" href="#aria.modeling.models.Type" title="aria.modeling.models.Type"><code class="xref py py-class docutils literal"><span class="pre">Type</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.created_at"> +<code class="descname">created_at</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.created_at" title="Permalink to this definition">¶</a></dt> +<dd><p>Creation timestamp.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/datetime.html#datetime.datetime"; title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">datetime</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.description"> +<code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.description" title="Permalink to this definition">¶</a></dt> +<dd><p>Human-readable description.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.group_templates"> +<code class="descname">group_templates</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.group_templates" title="Permalink to this definition">¶</a></dt> +<dd><p>Templates for creating groups.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">{<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a>, <a class="reference internal" href="#aria.modeling.models.GroupTemplate" title="aria.modeling.models.GroupTemplate"><code class="xref py py-class docutils literal"><span class="pre">GroupTemplate</span></code></a>}</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.group_types"> +<code class="descname">group_types</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.group_types" title="Permalink to this definition">¶</a></dt> +<dd><p>Base for the group type hierarchy,</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference internal" href="#aria.modeling.models.Type" title="aria.modeling.models.Type"><code class="xref py py-class docutils literal"><span class="pre">Type</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.id"> +<code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.id" title="Permalink to this definition">¶</a></dt> +<dd><p>Unique ID.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/functions.html#int"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">int</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.inputs"> +<code class="descname">inputs</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.inputs" title="Permalink to this definition">¶</a></dt> +<dd><p>Declarations for externally provided parameters.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">{<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a>: <a class="reference internal" href="#aria.modeling.models.Input" title="aria.modeling.models.Input"><code class="xref py py-class docutils literal"><span class="pre">Input</span></code></a>}</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.interface_types"> +<code class="descname">interface_types</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.interface_types" title="Permalink to this definition">¶</a></dt> +<dd><p>Base for the interface type hierarchy,</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference internal" href="#aria.modeling.models.Type" title="aria.modeling.models.Type"><code class="xref py py-class docutils literal"><span class="pre">Type</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.main_file_name"> +<code class="descname">main_file_name</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.main_file_name" title="Permalink to this definition">¶</a></dt> +<dd><p>Filename of CSAR or YAML file from which this service template was parsed.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.meta_data"> +<code class="descname">meta_data</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.meta_data" title="Permalink to this definition">¶</a></dt> +<dd><p>Associated metadata.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">{<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a>: <a class="reference internal" href="#aria.modeling.models.Metadata" title="aria.modeling.models.Metadata"><code class="xref py py-class docutils literal"><span class="pre">Metadata</span></code></a>}</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.name"> +<code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.name" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.node_templates"> +<code class="descname">node_templates</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.node_templates" title="Permalink to this definition">¶</a></dt> +<dd><p>Templates for creating nodes.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">{<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a>, <a class="reference internal" href="#aria.modeling.models.NodeTemplate" title="aria.modeling.models.NodeTemplate"><code class="xref py py-class docutils literal"><span class="pre">NodeTemplate</span></code></a>}</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.node_types"> +<code class="descname">node_types</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.node_types" title="Permalink to this definition">¶</a></dt> +<dd><p>Base for the node type hierarchy,</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference internal" href="#aria.modeling.models.Type" title="aria.modeling.models.Type"><code class="xref py py-class docutils literal"><span class="pre">Type</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.outputs"> +<code class="descname">outputs</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.outputs" title="Permalink to this definition">¶</a></dt> +<dd><p>Declarations for output parameters are filled in after service installation.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">{<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a>: <a class="reference internal" href="#aria.modeling.models.Output" title="aria.modeling.models.Output"><code class="xref py py-class docutils literal"><span class="pre">Output</span></code></a>}</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.plugin_specifications"> +<code class="descname">plugin_specifications</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.plugin_specifications" title="Permalink to this definition">¶</a></dt> +<dd><p>Required plugins for instantiated services.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">{<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a>: <a class="reference internal" href="#aria.modeling.models.PluginSpecification" title="aria.modeling.models.PluginSpecification"><code class="xref py py-class docutils literal"><span class="pre">PluginSpecification</span></code></a>}</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.policy_templates"> +<code class="descname">policy_templates</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.policy_templates" title="Permalink to this definition">¶</a></dt> +<dd><p>Templates for creating policies.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">{<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a>, <a class="reference internal" href="#aria.modeling.models.PolicyTemplate" title="aria.modeling.models.PolicyTemplate"><code class="xref py py-class docutils literal"><span class="pre">PolicyTemplate</span></code></a>}</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.policy_types"> +<code class="descname">policy_types</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.policy_types" title="Permalink to this definition">¶</a></dt> +<dd><p>Base for the policy type hierarchy,</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference internal" href="#aria.modeling.models.Type" title="aria.modeling.models.Type"><code class="xref py py-class docutils literal"><span class="pre">Type</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.relationship_types"> +<code class="descname">relationship_types</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.relationship_types" title="Permalink to this definition">¶</a></dt> +<dd><p>Base for the relationship type hierarchy,</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference internal" href="#aria.modeling.models.Type" title="aria.modeling.models.Type"><code class="xref py py-class docutils literal"><span class="pre">Type</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.services"> +<code class="descname">services</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.services" title="Permalink to this definition">¶</a></dt> +<dd><p>Instantiated services.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">[<a class="reference internal" href="#aria.modeling.models.Service" title="aria.modeling.models.Service"><code class="xref py py-class docutils literal"><span class="pre">Service</span></code></a>]</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.substitution_template"> +<code class="descname">substitution_template</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.substitution_template" title="Permalink to this definition">¶</a></dt> +<dd><p>Exposes an entire service as a single node.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference internal" href="#aria.modeling.models.SubstitutionTemplate" title="aria.modeling.models.SubstitutionTemplate"><code class="xref py py-class docutils literal"><span class="pre">SubstitutionTemplate</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.updated_at"> +<code class="descname">updated_at</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.updated_at" title="Permalink to this definition">¶</a></dt> +<dd><p>Update timestamp.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/datetime.html#datetime.datetime"; title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">datetime</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.ServiceTemplate.workflow_templates"> +<code class="descname">workflow_templates</code><a class="headerlink" href="#aria.modeling.models.ServiceTemplate.workflow_templates" title="Permalink to this definition">¶</a></dt> +<dd><p>Templates for creating workflows.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">{<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a>, <a class="reference internal" href="#aria.modeling.models.OperationTemplate" title="aria.modeling.models.OperationTemplate"><code class="xref py py-class docutils literal"><span class="pre">OperationTemplate</span></code></a>}</td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +<dl class="class"> +<dt id="aria.modeling.models.NodeTemplate"> +<em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">NodeTemplate</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.NodeTemplate" title="Permalink to this definition">¶</a></dt> +<dd><p>Template for creating zero or more <a class="reference internal" href="#aria.modeling.models.Node" title="aria.modeling.models.Node"><code class="xref py py-class docutils literal"><span class="pre">Node</span></code></a> instances, which are typed vertices in the +service topology.</p> +<dl class="attribute"> +<dt id="aria.modeling.models.NodeTemplate.artifact_templates"> +<code class="descname">artifact_templates</code><a class="headerlink" href="#aria.modeling.models.NodeTemplate.artifact_templates" title="Permalink to this definition">¶</a></dt> +<dd><p>Associated artifacts.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">{<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a>: <a class="reference internal" href="#aria.modeling.models.ArtifactTemplate" title="aria.modeling.models.ArtifactTemplate"><code class="xref py py-class docutils literal"><span class="pre">ArtifactTemplate</span></code></a>}</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.NodeTemplate.attributes"> +<code class="descname">attributes</code><a class="headerlink" href="#aria.modeling.models.NodeTemplate.attributes" title="Permalink to this definition">¶</a></dt> +<dd><p>Declarations for associated mutable parameters.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">{<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a>: <a class="reference internal" href="#aria.modeling.models.Attribute" title="aria.modeling.models.Attribute"><code class="xref py py-class docutils literal"><span class="pre">Attribute</span></code></a>}</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.NodeTemplate.capability_templates"> +<code class="descname">capability_templates</code><a class="headerlink" href="#aria.modeling.models.NodeTemplate.capability_templates" title="Permalink to this definition">¶</a></dt> +<dd><p>Associated exposed capability templates.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">{<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a>: <a class="reference internal" href="#aria.modeling.models.CapabilityTemplate" title="aria.modeling.models.CapabilityTemplate"><code class="xref py py-class docutils literal"><span class="pre">CapabilityTemplate</span></code></a>}</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.NodeTemplate.default_instances"> +<code class="descname">default_instances</code><a class="headerlink" href="#aria.modeling.models.NodeTemplate.default_instances" title="Permalink to this definition">¶</a></dt> +<dd><p>Default number nodes that will appear in the service.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/functions.html#int"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">int</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.NodeTemplate.description"> +<code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.NodeTemplate.description" title="Permalink to this definition">¶</a></dt> +<dd><p>Human-readable description.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.NodeTemplate.id"> +<code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.NodeTemplate.id" title="Permalink to this definition">¶</a></dt> +<dd><p>Unique ID.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/functions.html#int"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">int</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.NodeTemplate.interface_templates"> +<code class="descname">interface_templates</code><a class="headerlink" href="#aria.modeling.models.NodeTemplate.interface_templates" title="Permalink to this definition">¶</a></dt> +<dd><p>Associated interface templates.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">{<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a>: <a class="reference internal" href="#aria.modeling.models.InterfaceTemplate" title="aria.modeling.models.InterfaceTemplate"><code class="xref py py-class docutils literal"><span class="pre">InterfaceTemplate</span></code></a>}</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.NodeTemplate.max_instances"> +<code class="descname">max_instances</code><a class="headerlink" href="#aria.modeling.models.NodeTemplate.max_instances" title="Permalink to this definition">¶</a></dt> +<dd><p>Maximum number nodes that will appear in the service.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/functions.html#int"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">int</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.NodeTemplate.min_instances"> +<code class="descname">min_instances</code><a class="headerlink" href="#aria.modeling.models.NodeTemplate.min_instances" title="Permalink to this definition">¶</a></dt> +<dd><p>Minimum number nodes that will appear in the service.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/functions.html#int"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">int</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.NodeTemplate.name"> +<code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.NodeTemplate.name" title="Permalink to this definition">¶</a></dt> +<dd><p>Model name.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.NodeTemplate.nodes"> +<code class="descname">nodes</code><a class="headerlink" href="#aria.modeling.models.NodeTemplate.nodes" title="Permalink to this definition">¶</a></dt> +<dd><p>Instantiated nodes.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">[<a class="reference internal" href="#aria.modeling.models.Node" title="aria.modeling.models.Node"><code class="xref py py-class docutils literal"><span class="pre">Node</span></code></a>]</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.NodeTemplate.properties"> +<code class="descname">properties</code><a class="headerlink" href="#aria.modeling.models.NodeTemplate.properties" title="Permalink to this definition">¶</a></dt> +<dd><p>Declarations for associated immutable parameters.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">{<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a>: <a class="reference internal" href="#aria.modeling.models.Property" title="aria.modeling.models.Property"><code class="xref py py-class docutils literal"><span class="pre">Property</span></code></a>}</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.NodeTemplate.requirement_templates"> +<code class="descname">requirement_templates</code><a class="headerlink" href="#aria.modeling.models.NodeTemplate.requirement_templates" title="Permalink to this definition">¶</a></dt> +<dd><p>Associated potential relationships with other nodes.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">[<a class="reference internal" href="#aria.modeling.models.RequirementTemplate" title="aria.modeling.models.RequirementTemplate"><code class="xref py py-class docutils literal"><span class="pre">RequirementTemplate</span></code></a>]</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.NodeTemplate.service_template"> +<code class="descname">service_template</code><a class="headerlink" href="#aria.modeling.models.NodeTemplate.service_template" title="Permalink to this definition">¶</a></dt> +<dd><p>Containing service template.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference internal" href="#aria.modeling.models.ServiceTemplate" title="aria.modeling.models.ServiceTemplate"><code class="xref py py-class docutils literal"><span class="pre">ServiceTemplate</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.NodeTemplate.service_template_name"> +<code class="descname">service_template_name</code><a class="headerlink" href="#aria.modeling.models.NodeTemplate.service_template_name" title="Permalink to this definition">¶</a></dt> +<dd><p>Internal. For use in SQLAlchemy queries.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.NodeTemplate.target_node_template_constraints"> +<code class="descname">target_node_template_constraints</code><a class="headerlink" href="#aria.modeling.models.NodeTemplate.target_node_template_constraints" title="Permalink to this definition">¶</a></dt> +<dd><p>Constraints for filtering relationship targets.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">[<code class="xref py py-class docutils literal"><span class="pre">NodeTemplateConstraint</span></code>]</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.NodeTemplate.type"> +<code class="descname">type</code><a class="headerlink" href="#aria.modeling.models.NodeTemplate.type" title="Permalink to this definition">¶</a></dt> +<dd><p>Node type.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference internal" href="#aria.modeling.models.Type" title="aria.modeling.models.Type"><code class="xref py py-class docutils literal"><span class="pre">Type</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.NodeTemplate.type_name"> +<code class="descname">type_name</code><a class="headerlink" href="#aria.modeling.models.NodeTemplate.type_name" title="Permalink to this definition">¶</a></dt> +<dd><p>Internal. For use in SQLAlchemy queries.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +<dl class="class"> +<dt id="aria.modeling.models.GroupTemplate"> +<em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">GroupTemplate</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.GroupTemplate" title="Permalink to this definition">¶</a></dt> +<dd><p>Template for creating a <a class="reference internal" href="#aria.modeling.models.Group" title="aria.modeling.models.Group"><code class="xref py py-class docutils literal"><span class="pre">Group</span></code></a> instance, which is a typed logical container for zero or +more <a class="reference internal" href="#aria.modeling.models.Node" title="aria.modeling.models.Node"><code class="xref py py-class docutils literal"><span class="pre">Node</span></code></a> instances.</p> +<dl class="attribute"> +<dt id="aria.modeling.models.GroupTemplate.description"> +<code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.GroupTemplate.description" title="Permalink to this definition">¶</a></dt> +<dd><p>Human-readable description.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.GroupTemplate.groups"> +<code class="descname">groups</code><a class="headerlink" href="#aria.modeling.models.GroupTemplate.groups" title="Permalink to this definition">¶</a></dt> +<dd><p>Instantiated groups.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">[<a class="reference internal" href="#aria.modeling.models.Group" title="aria.modeling.models.Group"><code class="xref py py-class docutils literal"><span class="pre">Group</span></code></a>]</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.GroupTemplate.id"> +<code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.GroupTemplate.id" title="Permalink to this definition">¶</a></dt> +<dd><p>Unique ID.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/functions.html#int"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">int</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.GroupTemplate.interface_templates"> +<code class="descname">interface_templates</code><a class="headerlink" href="#aria.modeling.models.GroupTemplate.interface_templates" title="Permalink to this definition">¶</a></dt> +<dd><p>Associated interface templates.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">{<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a>: <a class="reference internal" href="#aria.modeling.models.InterfaceTemplate" title="aria.modeling.models.InterfaceTemplate"><code class="xref py py-class docutils literal"><span class="pre">InterfaceTemplate</span></code></a>}</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.GroupTemplate.name"> +<code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.GroupTemplate.name" title="Permalink to this definition">¶</a></dt> +<dd><p>Model name.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.GroupTemplate.node_templates"> +<code class="descname">node_templates</code><a class="headerlink" href="#aria.modeling.models.GroupTemplate.node_templates" title="Permalink to this definition">¶</a></dt> +<dd><p>Nodes instantiated by these templates will be members of the group.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">[<a class="reference internal" href="#aria.modeling.models.NodeTemplate" title="aria.modeling.models.NodeTemplate"><code class="xref py py-class docutils literal"><span class="pre">NodeTemplate</span></code></a>]</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.GroupTemplate.properties"> +<code class="descname">properties</code><a class="headerlink" href="#aria.modeling.models.GroupTemplate.properties" title="Permalink to this definition">¶</a></dt> +<dd><p>Declarations for associated immutable parameters.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">{<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a>: <a class="reference internal" href="#aria.modeling.models.Property" title="aria.modeling.models.Property"><code class="xref py py-class docutils literal"><span class="pre">Property</span></code></a>}</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.GroupTemplate.service_template"> +<code class="descname">service_template</code><a class="headerlink" href="#aria.modeling.models.GroupTemplate.service_template" title="Permalink to this definition">¶</a></dt> +<dd><p>Containing service template.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference internal" href="#aria.modeling.models.ServiceTemplate" title="aria.modeling.models.ServiceTemplate"><code class="xref py py-class docutils literal"><span class="pre">ServiceTemplate</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.GroupTemplate.type"> +<code class="descname">type</code><a class="headerlink" href="#aria.modeling.models.GroupTemplate.type" title="Permalink to this definition">¶</a></dt> +<dd><p>Group type.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference internal" href="#aria.modeling.models.Type" title="aria.modeling.models.Type"><code class="xref py py-class docutils literal"><span class="pre">Type</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +<dl class="class"> +<dt id="aria.modeling.models.PolicyTemplate"> +<em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">PolicyTemplate</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.PolicyTemplate" title="Permalink to this definition">¶</a></dt> +<dd><p>Template for creating a <a class="reference internal" href="#aria.modeling.models.Policy" title="aria.modeling.models.Policy"><code class="xref py py-class docutils literal"><span class="pre">Policy</span></code></a> instance, which is a typed set of orchestration hints +applied to zero or more <a class="reference internal" href="#aria.modeling.models.Node" title="aria.modeling.models.Node"><code class="xref py py-class docutils literal"><span class="pre">Node</span></code></a> or <a class="reference internal" href="#aria.modeling.models.Group" title="aria.modeling.models.Group"><code class="xref py py-class docutils literal"><span class="pre">Group</span></code></a> instances.</p> +<dl class="attribute"> +<dt id="aria.modeling.models.PolicyTemplate.description"> +<code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.PolicyTemplate.description" title="Permalink to this definition">¶</a></dt> +<dd><p>Human-readable description.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.PolicyTemplate.group_templates"> +<code class="descname">group_templates</code><a class="headerlink" href="#aria.modeling.models.PolicyTemplate.group_templates" title="Permalink to this definition">¶</a></dt> +<dd><p>Policy will be enacted on all nodes in all groups instantiated by these templates.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">{<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a>: <a class="reference internal" href="#aria.modeling.models.GroupTemplate" title="aria.modeling.models.GroupTemplate"><code class="xref py py-class docutils literal"><span class="pre">GroupTemplate</span></code></a>}</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.PolicyTemplate.id"> +<code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.PolicyTemplate.id" title="Permalink to this definition">¶</a></dt> +<dd><p>Unique ID.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/functions.html#int"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">int</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.PolicyTemplate.name"> +<code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.PolicyTemplate.name" title="Permalink to this definition">¶</a></dt> +<dd><p>Model name.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.PolicyTemplate.node_templates"> +<code class="descname">node_templates</code><a class="headerlink" href="#aria.modeling.models.PolicyTemplate.node_templates" title="Permalink to this definition">¶</a></dt> +<dd><p>Policy will be enacted on all nodes instantiated by these templates.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">{<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a>: <a class="reference internal" href="#aria.modeling.models.NodeTemplate" title="aria.modeling.models.NodeTemplate"><code class="xref py py-class docutils literal"><span class="pre">NodeTemplate</span></code></a>}</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.PolicyTemplate.policies"> +<code class="descname">policies</code><a class="headerlink" href="#aria.modeling.models.PolicyTemplate.policies" title="Permalink to this definition">¶</a></dt> +<dd><p>Instantiated policies.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">[<a class="reference internal" href="#aria.modeling.models.Policy" title="aria.modeling.models.Policy"><code class="xref py py-class docutils literal"><span class="pre">Policy</span></code></a>]</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.PolicyTemplate.properties"> +<code class="descname">properties</code><a class="headerlink" href="#aria.modeling.models.PolicyTemplate.properties" title="Permalink to this definition">¶</a></dt> +<dd><p>Declarations for associated immutable parameters.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">{<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a>: <a class="reference internal" href="#aria.modeling.models.Property" title="aria.modeling.models.Property"><code class="xref py py-class docutils literal"><span class="pre">Property</span></code></a>}</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.PolicyTemplate.service_template"> +<code class="descname">service_template</code><a class="headerlink" href="#aria.modeling.models.PolicyTemplate.service_template" title="Permalink to this definition">¶</a></dt> +<dd><p>Containing service template.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference internal" href="#aria.modeling.models.ServiceTemplate" title="aria.modeling.models.ServiceTemplate"><code class="xref py py-class docutils literal"><span class="pre">ServiceTemplate</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.PolicyTemplate.type"> +<code class="descname">type</code><a class="headerlink" href="#aria.modeling.models.PolicyTemplate.type" title="Permalink to this definition">¶</a></dt> +<dd><p>Policy type.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference internal" href="#aria.modeling.models.Type" title="aria.modeling.models.Type"><code class="xref py py-class docutils literal"><span class="pre">Type</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +<dl class="class"> +<dt id="aria.modeling.models.SubstitutionTemplate"> +<em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">SubstitutionTemplate</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.SubstitutionTemplate" title="Permalink to this definition">¶</a></dt> +<dd><p>Template for creating a <a class="reference internal" href="#aria.modeling.models.Substitution" title="aria.modeling.models.Substitution"><code class="xref py py-class docutils literal"><span class="pre">Substitution</span></code></a> instance, which exposes an entire instantiated +service as a single node.</p> +<dl class="attribute"> +<dt id="aria.modeling.models.SubstitutionTemplate.id"> +<code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.SubstitutionTemplate.id" title="Permalink to this definition">¶</a></dt> +<dd><p>Unique ID.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/functions.html#int"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">int</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.SubstitutionTemplate.mappings"> +<code class="descname">mappings</code><a class="headerlink" href="#aria.modeling.models.SubstitutionTemplate.mappings" title="Permalink to this definition">¶</a></dt> +<dd><p>Map requirement and capabilities to exposed node.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">{<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a>: <a class="reference internal" href="#aria.modeling.models.SubstitutionTemplateMapping" title="aria.modeling.models.SubstitutionTemplateMapping"><code class="xref py py-class docutils literal"><span class="pre">SubstitutionTemplateMapping</span></code></a>}</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.SubstitutionTemplate.name"> +<code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.SubstitutionTemplate.name" title="Permalink to this definition">¶</a></dt> +<dd><p>Model name.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring"; title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">basestring</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.SubstitutionTemplate.node_type"> +<code class="descname">node_type</code><a class="headerlink" href="#aria.modeling.models.SubstitutionTemplate.node_type" title="Permalink to this definition">¶</a></dt> +<dd><p>Exposed node type.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body"><a class="reference internal" href="#aria.modeling.models.Type" title="aria.modeling.models.Type"><code class="xref py py-class docutils literal"><span class="pre">Type</span></code></a></td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="attribute"> +<dt id="aria.modeling.models.SubstitutionTemplate.substitutions"> +<code class="descname">substitutions</code><a class="headerlink" href="#aria.modeling.models.SubstitutionTemplate.substitutions" title="Permalink to this definition">¶</a></dt> +<dd><p>Instantiated substitutions.</p> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">[<a class="reference internal" href="#aria.modeling.models.Substitution" title="aria.modeling.models.Substitution"><code class="xref py py-class docutils literal"><span class="pre">Substitution</span></code></a>]</td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +<dl class="class"> +<dt id="aria.modeling.models.SubstitutionTemplateMapping"> +<em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">SubstitutionTemplateMapping</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.SubstitutionTemplateMapping" title="Permalink to this definition">¶</a></dt> +<dd><p>Used by <a class="reference internal" href="#aria.modeling.models.SubstitutionTemplate" title="aria.modeling.models.SubstitutionTemplate"><code class="xref py py-class docutils literal"><span class="pre">SubstitutionTemplate</span></code></a> to map a capability template or a requirement template to +the exposed node.</p> +<p>The <a class="reference internal" href="#aria.modeling.models.SubstitutionTemplateMapping.name" title="aria.modeling.models.SubstitutionTemplateMapping.name"><code class="xref py py-attr docutils literal"><span class="pre">name</span></code></a> field should match the capability or requirement name on the exposed nodeâs +type.</p> +<p>Only one of <a class="reference internal" href="#aria.modeling.models.SubstitutionTemplateMapping.capability_template" title="aria.modeling.models.SubstitutionTemplateMapping.capability_template"><code class="xref py py-attr docutils literal"><span class="pre">capability_template</span></code></a> and <a class="reference internal" href="#aria.modeling.models.SubstitutionTemplateMapping.requirement_template" title="aria.modeling.models.SubstitutionTemplateMapping.requirement_template"><code class="xref py py-attr docutils literal"><span class="pre">requirement_template</span></code></a> can be set.</p> +<dl class="attribute"> +<dt id="aria.modeling.models.SubstitutionTemplateMapping.capability_template"> +<code class="descname">capability_template</code><a class="headerlink" href="#aria.modeling.models.SubstitutionTemplateMapping.capability_template" title="Permalink to this definition">¶</a></dt> +<dd><p>Capability template to expose (can be <code class="docutils literal"><span class="pre">None</span></code>).</p> +<table class="docutils field-li
<TRUNCATED>
