| |
| |
| <!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-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.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.SubstitutionTemplateMapping.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.SubstitutionTemplateMapping.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.SubstitutionTemplateMapping.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.SubstitutionTemplateMapping.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.SubstitutionTemplateMapping.requirement_template"> |
| <code class="descname">requirement_template</code><a class="headerlink" href="#aria.modeling.models.SubstitutionTemplateMapping.requirement_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Requirement template to expose (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.SubstitutionTemplateMapping.substitution_template"> |
| <code class="descname">substitution_template</code><a class="headerlink" href="#aria.modeling.models.SubstitutionTemplateMapping.substitution_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing substitution 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.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> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.modeling.models.RequirementTemplate"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">RequirementTemplate</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.RequirementTemplate" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.</p> |
| <p>Note that there is no equivalent “Requirement” instance model. Instead, during instantiation a |
| requirement template is matched with a capability and a <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> is instantiated.</p> |
| <p>A requirement template <em>must</em> target a <code class="xref py py-class docutils literal"><span class="pre">CapabilityType</span></code> or a capability name. It can |
| optionally target a specific <code class="xref py py-class docutils literal"><span class="pre">NodeType</span></code> or <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>.</p> |
| <p>Requirement templates may optionally contain a <a class="reference internal" href="#aria.modeling.models.RelationshipTemplate" title="aria.modeling.models.RelationshipTemplate"><code class="xref py py-class docutils literal"><span class="pre">RelationshipTemplate</span></code></a>. If they do not, |
| a <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> will be instantiated with default values.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.RequirementTemplate.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.RequirementTemplate.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.RequirementTemplate.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.RequirementTemplate.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.RequirementTemplate.node_template"> |
| <code class="descname">node_template</code><a class="headerlink" href="#aria.modeling.models.RequirementTemplate.node_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing node 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.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.RequirementTemplate.relationship_template"> |
| <code class="descname">relationship_template</code><a class="headerlink" href="#aria.modeling.models.RequirementTemplate.relationship_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Associated relationship template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.RelationshipTemplate" title="aria.modeling.models.RelationshipTemplate"><code class="xref py py-class docutils literal"><span class="pre">RelationshipTemplate</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.RequirementTemplate.relationships"> |
| <code class="descname">relationships</code><a class="headerlink" href="#aria.modeling.models.RequirementTemplate.relationships" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Instantiated relationships.</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.Relationship" title="aria.modeling.models.Relationship"><code class="xref py py-class docutils literal"><span class="pre">Relationship</span></code></a>]</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.RequirementTemplate.target_capability_name"> |
| <code class="descname">target_capability_name</code><a class="headerlink" href="#aria.modeling.models.RequirementTemplate.target_capability_name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Target capability name in node template or node type (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.RequirementTemplate.target_capability_type"> |
| <code class="descname">target_capability_type</code><a class="headerlink" href="#aria.modeling.models.RequirementTemplate.target_capability_type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Target capability 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"><code class="xref py py-class docutils literal"><span class="pre">CapabilityType</span></code></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.RequirementTemplate.target_node_template"> |
| <code class="descname">target_node_template</code><a class="headerlink" href="#aria.modeling.models.RequirementTemplate.target_node_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Target node template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.RequirementTemplate.target_node_template_constraints"> |
| <code class="descname">target_node_template_constraints</code><a class="headerlink" href="#aria.modeling.models.RequirementTemplate.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.RequirementTemplate.target_node_type"> |
| <code class="descname">target_node_type</code><a class="headerlink" href="#aria.modeling.models.RequirementTemplate.target_node_type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Target node type (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.RelationshipTemplate"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">RelationshipTemplate</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.RelationshipTemplate" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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>.</p> |
| <p>Note that a relationship template here is not exactly equivalent to a relationship template |
| entity in TOSCA. For example, a TOSCA requirement specifying a relationship type rather than a |
| relationship template would still be represented here as a relationship template.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.RelationshipTemplate.description"> |
| <code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.RelationshipTemplate.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.RelationshipTemplate.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.RelationshipTemplate.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.RelationshipTemplate.interface_templates"> |
| <code class="descname">interface_templates</code><a class="headerlink" href="#aria.modeling.models.RelationshipTemplate.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.RelationshipTemplate.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.RelationshipTemplate.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.RelationshipTemplate.properties"> |
| <code class="descname">properties</code><a class="headerlink" href="#aria.modeling.models.RelationshipTemplate.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.RelationshipTemplate.relationships"> |
| <code class="descname">relationships</code><a class="headerlink" href="#aria.modeling.models.RelationshipTemplate.relationships" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Instantiated relationships.</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.Relationship" title="aria.modeling.models.Relationship"><code class="xref py py-class docutils literal"><span class="pre">Relationship</span></code></a>]</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.RelationshipTemplate.type"> |
| <code class="descname">type</code><a class="headerlink" href="#aria.modeling.models.RelationshipTemplate.type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Relationship 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.CapabilityTemplate"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">CapabilityTemplate</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.CapabilityTemplate" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.CapabilityTemplate.capabilities"> |
| <code class="descname">capabilities</code><a class="headerlink" href="#aria.modeling.models.CapabilityTemplate.capabilities" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Instantiated capabilities.</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.Capability" title="aria.modeling.models.Capability"><code class="xref py py-class docutils literal"><span class="pre">Capability</span></code></a>]</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.CapabilityTemplate.description"> |
| <code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.CapabilityTemplate.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.CapabilityTemplate.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.CapabilityTemplate.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.CapabilityTemplate.max_occurrences"> |
| <code class="descname">max_occurrences</code><a class="headerlink" href="#aria.modeling.models.CapabilityTemplate.max_occurrences" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Maximum number of requirement matches allowed.</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.CapabilityTemplate.min_occurrences"> |
| <code class="descname">min_occurrences</code><a class="headerlink" href="#aria.modeling.models.CapabilityTemplate.min_occurrences" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Minimum number of requirement matches required.</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.CapabilityTemplate.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.CapabilityTemplate.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.CapabilityTemplate.node_template"> |
| <code class="descname">node_template</code><a class="headerlink" href="#aria.modeling.models.CapabilityTemplate.node_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing node 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.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.CapabilityTemplate.properties"> |
| <code class="descname">properties</code><a class="headerlink" href="#aria.modeling.models.CapabilityTemplate.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.CapabilityTemplate.type"> |
| <code class="descname">type</code><a class="headerlink" href="#aria.modeling.models.CapabilityTemplate.type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Capability 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.CapabilityTemplate.valid_source_node_types"> |
| <code class="descname">valid_source_node_types</code><a class="headerlink" href="#aria.modeling.models.CapabilityTemplate.valid_source_node_types" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Reject requirements that are not from these node types.</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.InterfaceTemplate"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">InterfaceTemplate</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.InterfaceTemplate" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.</p> |
| <p>Can be associated with 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>, 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>, or a |
| <a class="reference internal" href="#aria.modeling.models.RelationshipTemplate" title="aria.modeling.models.RelationshipTemplate"><code class="xref py py-class docutils literal"><span class="pre">RelationshipTemplate</span></code></a>.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.InterfaceTemplate.description"> |
| <code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.InterfaceTemplate.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.InterfaceTemplate.group_template"> |
| <code class="descname">group_template</code><a class="headerlink" href="#aria.modeling.models.InterfaceTemplate.group_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing group template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.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.InterfaceTemplate.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.InterfaceTemplate.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.InterfaceTemplate.inputs"> |
| <code class="descname">inputs</code><a class="headerlink" href="#aria.modeling.models.InterfaceTemplate.inputs" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Declarations for externally provided parameters that can be used by all operations of the |
| interface.</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.InterfaceTemplate.interfaces"> |
| <code class="descname">interfaces</code><a class="headerlink" href="#aria.modeling.models.InterfaceTemplate.interfaces" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Instantiated interfaces.</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.Interface" title="aria.modeling.models.Interface"><code class="xref py py-class docutils literal"><span class="pre">Interface</span></code></a>]</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.InterfaceTemplate.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.InterfaceTemplate.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.InterfaceTemplate.node_template"> |
| <code class="descname">node_template</code><a class="headerlink" href="#aria.modeling.models.InterfaceTemplate.node_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing node template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.InterfaceTemplate.operation_templates"> |
| <code class="descname">operation_templates</code><a class="headerlink" href="#aria.modeling.models.InterfaceTemplate.operation_templates" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Associated operation 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.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> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.InterfaceTemplate.relationship_template"> |
| <code class="descname">relationship_template</code><a class="headerlink" href="#aria.modeling.models.InterfaceTemplate.relationship_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing relationship template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.RelationshipTemplate" title="aria.modeling.models.RelationshipTemplate"><code class="xref py py-class docutils literal"><span class="pre">RelationshipTemplate</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.InterfaceTemplate.type"> |
| <code class="descname">type</code><a class="headerlink" href="#aria.modeling.models.InterfaceTemplate.type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Interface 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.OperationTemplate"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">OperationTemplate</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.OperationTemplate" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.OperationTemplate.configurations"> |
| <code class="descname">configurations</code><a class="headerlink" href="#aria.modeling.models.OperationTemplate.configurations" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Configuration parameters for the operation instance Python <a class="reference internal" href="#aria.modeling.models.OperationTemplate.function" title="aria.modeling.models.OperationTemplate.function"><code class="xref py py-attr docutils literal"><span class="pre">function</span></code></a>.</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.Configuration" title="aria.modeling.models.Configuration"><code class="xref py py-class docutils literal"><span class="pre">Configuration</span></code></a>}</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.OperationTemplate.dependencies"> |
| <code class="descname">dependencies</code><a class="headerlink" href="#aria.modeling.models.OperationTemplate.dependencies" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Dependencies (usually names of 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>]</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.OperationTemplate.description"> |
| <code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.OperationTemplate.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.OperationTemplate.executor"> |
| <code class="descname">executor</code><a class="headerlink" href="#aria.modeling.models.OperationTemplate.executor" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Name of executor.</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.OperationTemplate.function"> |
| <code class="descname">function</code><a class="headerlink" href="#aria.modeling.models.OperationTemplate.function" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Full path to Python function.</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.OperationTemplate.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.OperationTemplate.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.OperationTemplate.implementation"> |
| <code class="descname">implementation</code><a class="headerlink" href="#aria.modeling.models.OperationTemplate.implementation" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Implementation (usually the name of an artifact).</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.OperationTemplate.inputs"> |
| <code class="descname">inputs</code><a class="headerlink" href="#aria.modeling.models.OperationTemplate.inputs" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Declarations for parameters provided to the <a class="reference internal" href="#aria.modeling.models.OperationTemplate.implementation" title="aria.modeling.models.OperationTemplate.implementation"><code class="xref py py-attr docutils literal"><span class="pre">implementation</span></code></a>.</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.OperationTemplate.interface_template"> |
| <code class="descname">interface_template</code><a class="headerlink" href="#aria.modeling.models.OperationTemplate.interface_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing interface template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.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.OperationTemplate.max_attempts"> |
| <code class="descname">max_attempts</code><a class="headerlink" href="#aria.modeling.models.OperationTemplate.max_attempts" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Maximum number of attempts allowed in case of task failure.</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.OperationTemplate.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.OperationTemplate.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.OperationTemplate.operations"> |
| <code class="descname">operations</code><a class="headerlink" href="#aria.modeling.models.OperationTemplate.operations" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Instantiated operations.</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.Operation" title="aria.modeling.models.Operation"><code class="xref py py-class docutils literal"><span class="pre">Operation</span></code></a>]</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.OperationTemplate.plugin_specification"> |
| <code class="descname">plugin_specification</code><a class="headerlink" href="#aria.modeling.models.OperationTemplate.plugin_specification" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Associated plugin specification.</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.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.OperationTemplate.relationship_edge"> |
| <code class="descname">relationship_edge</code><a class="headerlink" href="#aria.modeling.models.OperationTemplate.relationship_edge" title="Permalink to this definition">¶</a></dt> |
| <dd><p>When <code class="docutils literal"><span class="pre">True</span></code> specifies that the operation is on the relationship’s target edge; <code class="docutils literal"><span class="pre">False</span></code> is |
| the source edge (only used by operations on relationships)</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#bool" title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">bool</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.OperationTemplate.retry_interval"> |
| <code class="descname">retry_interval</code><a class="headerlink" href="#aria.modeling.models.OperationTemplate.retry_interval" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Interval between task retry attemps (in seconds).</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#float" title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">float</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.OperationTemplate.service_template"> |
| <code class="descname">service_template</code><a class="headerlink" href="#aria.modeling.models.OperationTemplate.service_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing service template (can be <code class="docutils literal"><span class="pre">None</span></code>). For workflow operation 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 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> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.modeling.models.ArtifactTemplate"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">ArtifactTemplate</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.ArtifactTemplate" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ArtifactTemplate.artifacts"> |
| <code class="descname">artifacts</code><a class="headerlink" href="#aria.modeling.models.ArtifactTemplate.artifacts" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Instantiated 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 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>]</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ArtifactTemplate.description"> |
| <code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.ArtifactTemplate.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.ArtifactTemplate.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.ArtifactTemplate.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.ArtifactTemplate.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.ArtifactTemplate.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.ArtifactTemplate.node_template"> |
| <code class="descname">node_template</code><a class="headerlink" href="#aria.modeling.models.ArtifactTemplate.node_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing node 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.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.ArtifactTemplate.properties"> |
| <code class="descname">properties</code><a class="headerlink" href="#aria.modeling.models.ArtifactTemplate.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.ArtifactTemplate.repository_credential"> |
| <code class="descname">repository_credential</code><a class="headerlink" href="#aria.modeling.models.ArtifactTemplate.repository_credential" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Credentials for accessing the repository.</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 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.ArtifactTemplate.repository_url"> |
| <code class="descname">repository_url</code><a class="headerlink" href="#aria.modeling.models.ArtifactTemplate.repository_url" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Repository URL.</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.ArtifactTemplate.source_path"> |
| <code class="descname">source_path</code><a class="headerlink" href="#aria.modeling.models.ArtifactTemplate.source_path" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Source path (in CSAR or repository).</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.ArtifactTemplate.target_path"> |
| <code class="descname">target_path</code><a class="headerlink" href="#aria.modeling.models.ArtifactTemplate.target_path" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Path at which to install at destination.</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.ArtifactTemplate.type"> |
| <code class="descname">type</code><a class="headerlink" href="#aria.modeling.models.ArtifactTemplate.type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Artifact 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.PluginSpecification"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">PluginSpecification</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.PluginSpecification" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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>.</p> |
| <p>The actual plugin to be selected depends on those currently installed in ARIA.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.PluginSpecification.enabled"> |
| <code class="descname">enabled</code><a class="headerlink" href="#aria.modeling.models.PluginSpecification.enabled" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Whether the plugin is enabled.</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#bool" title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">bool</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.PluginSpecification.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.PluginSpecification.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.PluginSpecification.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.PluginSpecification.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.PluginSpecification.plugin"> |
| <code class="descname">plugin</code><a class="headerlink" href="#aria.modeling.models.PluginSpecification.plugin" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Matched plugin.</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.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> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.PluginSpecification.service_template"> |
| <code class="descname">service_template</code><a class="headerlink" href="#aria.modeling.models.PluginSpecification.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.PluginSpecification.version"> |
| <code class="descname">version</code><a class="headerlink" href="#aria.modeling.models.PluginSpecification.version" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Minimum plugin version.</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.Service"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Service</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Service" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.). However, it can also be created |
| programmatically.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Service.created_at"> |
| <code class="descname">created_at</code><a class="headerlink" href="#aria.modeling.models.Service.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.Service.description"> |
| <code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.Service.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.Service.executions"> |
| <code class="descname">executions</code><a class="headerlink" href="#aria.modeling.models.Service.executions" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Executions.</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.Execution" title="aria.modeling.models.Execution"><code class="xref py py-class docutils literal"><span class="pre">Execution</span></code></a>]</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Service.groups"> |
| <code class="descname">groups</code><a class="headerlink" href="#aria.modeling.models.Service.groups" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.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.Service.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Service.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.Service.inputs"> |
| <code class="descname">inputs</code><a class="headerlink" href="#aria.modeling.models.Service.inputs" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.Service.meta_data"> |
| <code class="descname">meta_data</code><a class="headerlink" href="#aria.modeling.models.Service.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.Service.modifications"> |
| <code class="descname">modifications</code><a class="headerlink" href="#aria.modeling.models.Service.modifications" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Service modifications.</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.ServiceModification" title="aria.modeling.models.ServiceModification"><code class="xref py py-class docutils literal"><span class="pre">ServiceModification</span></code></a>]</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Service.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Service.name" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Service.nodes"> |
| <code class="descname">nodes</code><a class="headerlink" href="#aria.modeling.models.Service.nodes" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.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.Service.outputs"> |
| <code class="descname">outputs</code><a class="headerlink" href="#aria.modeling.models.Service.outputs" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Output 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.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.Service.plugins"> |
| <code class="descname">plugins</code><a class="headerlink" href="#aria.modeling.models.Service.plugins" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Associated plugins.</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.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> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Service.policies"> |
| <code class="descname">policies</code><a class="headerlink" href="#aria.modeling.models.Service.policies" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.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.Service.service_template"> |
| <code class="descname">service_template</code><a class="headerlink" href="#aria.modeling.models.Service.service_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Source service template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Service.service_template_name"> |
| <code class="descname">service_template_name</code><a class="headerlink" href="#aria.modeling.models.Service.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.Service.substitution"> |
| <code class="descname">substitution</code><a class="headerlink" href="#aria.modeling.models.Service.substitution" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Exposes the 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.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> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Service.updated_at"> |
| <code class="descname">updated_at</code><a class="headerlink" href="#aria.modeling.models.Service.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.Service.updates"> |
| <code class="descname">updates</code><a class="headerlink" href="#aria.modeling.models.Service.updates" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Service updates.</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.ServiceUpdate" title="aria.modeling.models.ServiceUpdate"><code class="xref py py-class docutils literal"><span class="pre">ServiceUpdate</span></code></a>]</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Service.workflows"> |
| <code class="descname">workflows</code><a class="headerlink" href="#aria.modeling.models.Service.workflows" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.Operation" title="aria.modeling.models.Operation"><code class="xref py py-class docutils literal"><span class="pre">Operation</span></code></a>}</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.modeling.models.Node"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Node</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Node" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Typed vertex in the service topology.</p> |
| <p>Nodes may have zero or more <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 to other nodes, together forming |
| a many-to-many node graph.</p> |
| <p>Usually an instance of 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>.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Node.artifacts"> |
| <code class="descname">artifacts</code><a class="headerlink" href="#aria.modeling.models.Node.artifacts" 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.Artifact" title="aria.modeling.models.Artifact"><code class="xref py py-class docutils literal"><span class="pre">Artifact</span></code></a>}</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Node.attributes"> |
| <code class="descname">attributes</code><a class="headerlink" href="#aria.modeling.models.Node.attributes" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.Node.capabilities"> |
| <code class="descname">capabilities</code><a class="headerlink" href="#aria.modeling.models.Node.capabilities" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Associated exposed capabilities.</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.Capability" title="aria.modeling.models.Capability"><code class="xref py py-class docutils literal"><span class="pre">Capability</span></code></a>}</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Node.description"> |
| <code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.Node.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.Node.host"> |
| <code class="descname">host</code><a class="headerlink" href="#aria.modeling.models.Node.host" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Node in which we are hosted (can be <code class="docutils literal"><span class="pre">None</span></code>).</p> |
| <p>Normally the host node is found by following the relationship graph (relationships with |
| <code class="docutils literal"><span class="pre">host</span></code> roles) to final nodes (with <code class="docutils literal"><span class="pre">host</span></code> roles).</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.Node.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Node.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.Node.inbound_relationships"> |
| <code class="descname">inbound_relationships</code><a class="headerlink" href="#aria.modeling.models.Node.inbound_relationships" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Relationships from 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.Relationship" title="aria.modeling.models.Relationship"><code class="xref py py-class docutils literal"><span class="pre">Relationship</span></code></a>]</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Node.interfaces"> |
| <code class="descname">interfaces</code><a class="headerlink" href="#aria.modeling.models.Node.interfaces" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Associated interfaces.</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.Interface" title="aria.modeling.models.Interface"><code class="xref py py-class docutils literal"><span class="pre">Interface</span></code></a>}</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Node.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Node.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.Node.node_template"> |
| <code class="descname">node_template</code><a class="headerlink" href="#aria.modeling.models.Node.node_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Source node template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Node.node_template_name"> |
| <code class="descname">node_template_name</code><a class="headerlink" href="#aria.modeling.models.Node.node_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.Node.outbound_relationships"> |
| <code class="descname">outbound_relationships</code><a class="headerlink" href="#aria.modeling.models.Node.outbound_relationships" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Relationships to 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.Relationship" title="aria.modeling.models.Relationship"><code class="xref py py-class docutils literal"><span class="pre">Relationship</span></code></a>]</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Node.properties"> |
| <code class="descname">properties</code><a class="headerlink" href="#aria.modeling.models.Node.properties" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.Node.service"> |
| <code class="descname">service</code><a class="headerlink" href="#aria.modeling.models.Node.service" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing 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 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.Node.service_name"> |
| <code class="descname">service_name</code><a class="headerlink" href="#aria.modeling.models.Node.service_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.Node.state"> |
| <code class="descname">state</code><a class="headerlink" href="#aria.modeling.models.Node.state" title="Permalink to this definition">¶</a></dt> |
| <dd><p>TOSCA state.</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.Node.tasks"> |
| <code class="descname">tasks</code><a class="headerlink" href="#aria.modeling.models.Node.tasks" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Associated tasks.</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.Task" title="aria.modeling.models.Task"><code class="xref py py-class docutils literal"><span class="pre">Task</span></code></a>]</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Node.type"> |
| <code class="descname">type</code><a class="headerlink" href="#aria.modeling.models.Node.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.Node.version"> |
| <code class="descname">version</code><a class="headerlink" href="#aria.modeling.models.Node.version" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Used by <code class="xref py py-mod docutils literal"><span class="pre">aria.storage.instrumentation</span></code>.</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> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.modeling.models.Group"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Group</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Group" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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> |
| <p>Usually an instance of 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>.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Group.description"> |
| <code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.Group.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.Group.group_template"> |
| <code class="descname">group_template</code><a class="headerlink" href="#aria.modeling.models.Group.group_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Source group template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.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.Group.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Group.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.Group.interfaces"> |
| <code class="descname">interfaces</code><a class="headerlink" href="#aria.modeling.models.Group.interfaces" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Associated interfaces.</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.Interface" title="aria.modeling.models.Interface"><code class="xref py py-class docutils literal"><span class="pre">Interface</span></code></a>}</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Group.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Group.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.Group.nodes"> |
| <code class="descname">nodes</code><a class="headerlink" href="#aria.modeling.models.Group.nodes" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Member 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.Group.properties"> |
| <code class="descname">properties</code><a class="headerlink" href="#aria.modeling.models.Group.properties" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.Group.service"> |
| <code class="descname">service</code><a class="headerlink" href="#aria.modeling.models.Group.service" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing 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 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.Group.type"> |
| <code class="descname">type</code><a class="headerlink" href="#aria.modeling.models.Group.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.Policy"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Policy</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Policy" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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> |
| <p>Usually an instance of 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>.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Policy.description"> |
| <code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.Policy.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.Policy.groups"> |
| <code class="descname">groups</code><a class="headerlink" href="#aria.modeling.models.Policy.groups" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Policy is enacted on nodes in these 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.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.Policy.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Policy.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.Policy.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Policy.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.Policy.nodes"> |
| <code class="descname">nodes</code><a class="headerlink" href="#aria.modeling.models.Policy.nodes" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Policy is enacted on these 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.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.Policy.policy_template"> |
| <code class="descname">policy_template</code><a class="headerlink" href="#aria.modeling.models.Policy.policy_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Source policy template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.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.Policy.properties"> |
| <code class="descname">properties</code><a class="headerlink" href="#aria.modeling.models.Policy.properties" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.Policy.service"> |
| <code class="descname">service</code><a class="headerlink" href="#aria.modeling.models.Policy.service" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing 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 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.Policy.type"> |
| <code class="descname">type</code><a class="headerlink" href="#aria.modeling.models.Policy.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.Substitution"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Substitution</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Substitution" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Exposes the entire service as a single node.</p> |
| <p>Usually an instance of a <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>.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Substitution.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Substitution.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.Substitution.mappings"> |
| <code class="descname">mappings</code><a class="headerlink" href="#aria.modeling.models.Substitution.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.SubstitutionMapping" title="aria.modeling.models.SubstitutionMapping"><code class="xref py py-class docutils literal"><span class="pre">SubstitutionMapping</span></code></a>}</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Substitution.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Substitution.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.Substitution.node_type"> |
| <code class="descname">node_type</code><a class="headerlink" href="#aria.modeling.models.Substitution.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.Substitution.service"> |
| <code class="descname">service</code><a class="headerlink" href="#aria.modeling.models.Substitution.service" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing 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 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.Substitution.substitution_template"> |
| <code class="descname">substitution_template</code><a class="headerlink" href="#aria.modeling.models.Substitution.substitution_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Source substitution template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.modeling.models.SubstitutionMapping"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">SubstitutionMapping</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.SubstitutionMapping" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.</p> |
| <p>The <a class="reference internal" href="#aria.modeling.models.SubstitutionMapping.name" title="aria.modeling.models.SubstitutionMapping.name"><code class="xref py py-attr docutils literal"><span class="pre">name</span></code></a> field should match the capability or requirement template name on the exposed |
| node’s type.</p> |
| <p>Only one of <a class="reference internal" href="#aria.modeling.models.SubstitutionMapping.capability" title="aria.modeling.models.SubstitutionMapping.capability"><code class="xref py py-attr docutils literal"><span class="pre">capability</span></code></a> and <a class="reference internal" href="#aria.modeling.models.SubstitutionMapping.requirement_template" title="aria.modeling.models.SubstitutionMapping.requirement_template"><code class="xref py py-attr docutils literal"><span class="pre">requirement_template</span></code></a> can be set. If the latter is |
| set, then <a class="reference internal" href="#aria.modeling.models.SubstitutionMapping.node" title="aria.modeling.models.SubstitutionMapping.node"><code class="xref py py-attr docutils literal"><span class="pre">node</span></code></a> must also be set.</p> |
| <p>Usually an instance of a <code class="xref py py-class docutils literal"><span class="pre">SubstitutionMappingTemplate</span></code>.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.SubstitutionMapping.capability"> |
| <code class="descname">capability</code><a class="headerlink" href="#aria.modeling.models.SubstitutionMapping.capability" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Capability to expose (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Capability" title="aria.modeling.models.Capability"><code class="xref py py-class docutils literal"><span class="pre">Capability</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.SubstitutionMapping.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.SubstitutionMapping.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.SubstitutionMapping.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.SubstitutionMapping.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.SubstitutionMapping.node"> |
| <code class="descname">node</code><a class="headerlink" href="#aria.modeling.models.SubstitutionMapping.node" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Node for which to expose <a class="reference internal" href="#aria.modeling.models.SubstitutionMapping.requirement_template" title="aria.modeling.models.SubstitutionMapping.requirement_template"><code class="xref py py-attr docutils literal"><span class="pre">requirement_template</span></code></a> (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.SubstitutionMapping.requirement_template"> |
| <code class="descname">requirement_template</code><a class="headerlink" href="#aria.modeling.models.SubstitutionMapping.requirement_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Requirement template to expose (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.SubstitutionMapping.substitution"> |
| <code class="descname">substitution</code><a class="headerlink" href="#aria.modeling.models.SubstitutionMapping.substitution" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing substitution.</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.Relationship"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Relationship</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Relationship" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.</p> |
| <p>Might be an instance of <a class="reference internal" href="#aria.modeling.models.RelationshipTemplate" title="aria.modeling.models.RelationshipTemplate"><code class="xref py py-class docutils literal"><span class="pre">RelationshipTemplate</span></code></a> and/or <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>.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Relationship.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Relationship.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.Relationship.interfaces"> |
| <code class="descname">interfaces</code><a class="headerlink" href="#aria.modeling.models.Relationship.interfaces" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Associated interfaces.</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.Interface" title="aria.modeling.models.Interface"><code class="xref py py-class docutils literal"><span class="pre">Interface</span></code></a>}</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Relationship.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Relationship.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.Relationship.properties"> |
| <code class="descname">properties</code><a class="headerlink" href="#aria.modeling.models.Relationship.properties" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.Relationship.relationship_template"> |
| <code class="descname">relationship_template</code><a class="headerlink" href="#aria.modeling.models.Relationship.relationship_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Source relationship template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.RelationshipTemplate" title="aria.modeling.models.RelationshipTemplate"><code class="xref py py-class docutils literal"><span class="pre">RelationshipTemplate</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Relationship.requirement_template"> |
| <code class="descname">requirement_template</code><a class="headerlink" href="#aria.modeling.models.Relationship.requirement_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Source requirement template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Relationship.source_node"> |
| <code class="descname">source_node</code><a class="headerlink" href="#aria.modeling.models.Relationship.source_node" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Source 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.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.Relationship.source_node_name"> |
| <code class="descname">source_node_name</code><a class="headerlink" href="#aria.modeling.models.Relationship.source_node_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.Relationship.source_position"> |
| <code class="descname">source_position</code><a class="headerlink" href="#aria.modeling.models.Relationship.source_position" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Position at source.</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.Relationship.target_capability"> |
| <code class="descname">target_capability</code><a class="headerlink" href="#aria.modeling.models.Relationship.target_capability" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Target capability.</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.Capability" title="aria.modeling.models.Capability"><code class="xref py py-class docutils literal"><span class="pre">Capability</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Relationship.target_node"> |
| <code class="descname">target_node</code><a class="headerlink" href="#aria.modeling.models.Relationship.target_node" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Target 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.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.Relationship.target_node_name"> |
| <code class="descname">target_node_name</code><a class="headerlink" href="#aria.modeling.models.Relationship.target_node_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.Relationship.target_position"> |
| <code class="descname">target_position</code><a class="headerlink" href="#aria.modeling.models.Relationship.target_position" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Position at target.</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.Relationship.tasks"> |
| <code class="descname">tasks</code><a class="headerlink" href="#aria.modeling.models.Relationship.tasks" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Associated tasks.</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.Task" title="aria.modeling.models.Task"><code class="xref py py-class docutils literal"><span class="pre">Task</span></code></a>]</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Relationship.type"> |
| <code class="descname">type</code><a class="headerlink" href="#aria.modeling.models.Relationship.type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Relationship 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.Capability"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Capability</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Capability" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.</p> |
| <p>Usually an instance of 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>.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Capability.capability_template"> |
| <code class="descname">capability_template</code><a class="headerlink" href="#aria.modeling.models.Capability.capability_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Source capability template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.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.Capability.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Capability.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.Capability.max_occurrences"> |
| <code class="descname">max_occurrences</code><a class="headerlink" href="#aria.modeling.models.Capability.max_occurrences" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Maximum number of requirement matches allowed.</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.Capability.min_occurrences"> |
| <code class="descname">min_occurrences</code><a class="headerlink" href="#aria.modeling.models.Capability.min_occurrences" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Minimum number of requirement matches required.</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.Capability.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Capability.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.Capability.node"> |
| <code class="descname">node</code><a class="headerlink" href="#aria.modeling.models.Capability.node" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing 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.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.Capability.occurrences"> |
| <code class="descname">occurrences</code><a class="headerlink" href="#aria.modeling.models.Capability.occurrences" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Number of requirement matches.</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.Capability.properties"> |
| <code class="descname">properties</code><a class="headerlink" href="#aria.modeling.models.Capability.properties" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.Capability.type"> |
| <code class="descname">type</code><a class="headerlink" href="#aria.modeling.models.Capability.type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Capability 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.Interface"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Interface</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Interface" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.</p> |
| <p>Can be associated with 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>, 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>, or a <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>.</p> |
| <p>Usually an instance of 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>.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Interface.description"> |
| <code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.Interface.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.Interface.group"> |
| <code class="descname">group</code><a class="headerlink" href="#aria.modeling.models.Interface.group" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing group (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Interface.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Interface.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.Interface.inputs"> |
| <code class="descname">inputs</code><a class="headerlink" href="#aria.modeling.models.Interface.inputs" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Parameters for all operations of the interface.</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.Interface.interface_template"> |
| <code class="descname">interface_template</code><a class="headerlink" href="#aria.modeling.models.Interface.interface_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Source interface template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.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.Interface.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Interface.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.Interface.node"> |
| <code class="descname">node</code><a class="headerlink" href="#aria.modeling.models.Interface.node" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing node (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Interface.operations"> |
| <code class="descname">operations</code><a class="headerlink" href="#aria.modeling.models.Interface.operations" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Associated operations.</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.Operation" title="aria.modeling.models.Operation"><code class="xref py py-class docutils literal"><span class="pre">Operation</span></code></a>}</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Interface.relationship"> |
| <code class="descname">relationship</code><a class="headerlink" href="#aria.modeling.models.Interface.relationship" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing relationship (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Relationship" title="aria.modeling.models.Relationship"><code class="xref py py-class docutils literal"><span class="pre">Relationship</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Interface.type"> |
| <code class="descname">type</code><a class="headerlink" href="#aria.modeling.models.Interface.type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Interface 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.Operation"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Operation</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Operation" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Entry points to Python functions called as part of a workflow execution.</p> |
| <p>The operation signature (its <a class="reference internal" href="#aria.modeling.models.Operation.name" title="aria.modeling.models.Operation.name"><code class="xref py py-attr docutils literal"><span class="pre">name</span></code></a> and its <a class="reference internal" href="#aria.modeling.models.Operation.inputs" title="aria.modeling.models.Operation.inputs"><code class="xref py py-attr docutils literal"><span class="pre">inputs</span></code></a>’s names and types) is declared |
| by the type of the <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>, however each operation can provide its own |
| <a class="reference internal" href="#aria.modeling.models.Operation.implementation" title="aria.modeling.models.Operation.implementation"><code class="xref py py-attr docutils literal"><span class="pre">implementation</span></code></a> as well as additional inputs.</p> |
| <p>The Python <a class="reference internal" href="#aria.modeling.models.Operation.function" title="aria.modeling.models.Operation.function"><code class="xref py py-attr docutils literal"><span class="pre">function</span></code></a> is usually provided by an associated <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>. Its purpose is |
| to execute the implementation, providing it with both the operation’s and interface’s inputs. |
| The <a class="reference internal" href="#aria.modeling.models.Operation.arguments" title="aria.modeling.models.Operation.arguments"><code class="xref py py-attr docutils literal"><span class="pre">arguments</span></code></a> of the function should be set according to the specific signature of the |
| function.</p> |
| <p>Additionally, <code class="xref py py-attr docutils literal"><span class="pre">configuration</span></code> parameters can be provided as hints to configure the |
| function’s behavior. For example, they can be used to configure remote execution credentials.</p> |
| <p>Might be an instance of <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>.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Operation.arguments"> |
| <code class="descname">arguments</code><a class="headerlink" href="#aria.modeling.models.Operation.arguments" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Arguments sent to the Python <a class="reference internal" href="#aria.modeling.models.Operation.function" title="aria.modeling.models.Operation.function"><code class="xref py py-attr docutils literal"><span class="pre">function</span></code></a>.</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.Argument" title="aria.modeling.models.Argument"><code class="xref py py-class docutils literal"><span class="pre">Argument</span></code></a>}</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Operation.configurations"> |
| <code class="descname">configurations</code><a class="headerlink" href="#aria.modeling.models.Operation.configurations" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Configuration parameters for the Python <a class="reference internal" href="#aria.modeling.models.Operation.function" title="aria.modeling.models.Operation.function"><code class="xref py py-attr docutils literal"><span class="pre">function</span></code></a>.</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.Configuration" title="aria.modeling.models.Configuration"><code class="xref py py-class docutils literal"><span class="pre">Configuration</span></code></a>}</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Operation.dependencies"> |
| <code class="descname">dependencies</code><a class="headerlink" href="#aria.modeling.models.Operation.dependencies" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Dependencies (usually names of 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>]</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Operation.description"> |
| <code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.Operation.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.Operation.executor"> |
| <code class="descname">executor</code><a class="headerlink" href="#aria.modeling.models.Operation.executor" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Name of executor.</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.Operation.function"> |
| <code class="descname">function</code><a class="headerlink" href="#aria.modeling.models.Operation.function" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Full path to Python function.</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.Operation.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Operation.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.Operation.implementation"> |
| <code class="descname">implementation</code><a class="headerlink" href="#aria.modeling.models.Operation.implementation" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Implementation (usually the name of an artifact).</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.Operation.inputs"> |
| <code class="descname">inputs</code><a class="headerlink" href="#aria.modeling.models.Operation.inputs" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Parameters provided to the <a class="reference internal" href="#aria.modeling.models.Operation.implementation" title="aria.modeling.models.Operation.implementation"><code class="xref py py-attr docutils literal"><span class="pre">implementation</span></code></a>.</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.Operation.interface"> |
| <code class="descname">interface</code><a class="headerlink" href="#aria.modeling.models.Operation.interface" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing interface (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Interface" title="aria.modeling.models.Interface"><code class="xref py py-class docutils literal"><span class="pre">Interface</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Operation.max_attempts"> |
| <code class="descname">max_attempts</code><a class="headerlink" href="#aria.modeling.models.Operation.max_attempts" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Maximum number of attempts allowed in case of task failure.</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.Operation.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Operation.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.Operation.operation_template"> |
| <code class="descname">operation_template</code><a class="headerlink" href="#aria.modeling.models.Operation.operation_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Source operation template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.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> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Operation.plugin"> |
| <code class="descname">plugin</code><a class="headerlink" href="#aria.modeling.models.Operation.plugin" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Associated plugin.</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.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> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Operation.relationship_edge"> |
| <code class="descname">relationship_edge</code><a class="headerlink" href="#aria.modeling.models.Operation.relationship_edge" title="Permalink to this definition">¶</a></dt> |
| <dd><p>When <code class="docutils literal"><span class="pre">True</span></code> specifies that the operation is on the relationship’s target edge; <code class="docutils literal"><span class="pre">False</span></code> is |
| the source edge (only used by operations on relationships)</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#bool" title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">bool</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Operation.retry_interval"> |
| <code class="descname">retry_interval</code><a class="headerlink" href="#aria.modeling.models.Operation.retry_interval" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Interval between task retry attemps (in seconds).</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#float" title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">float</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Operation.service"> |
| <code class="descname">service</code><a class="headerlink" href="#aria.modeling.models.Operation.service" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing service (can be <code class="docutils literal"><span class="pre">None</span></code>). For workflow operations.</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> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.modeling.models.Artifact"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Artifact</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Artifact" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Typed file, either provided in a CSAR or downloaded from a repository.</p> |
| <p>Usually an instance of <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>.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Artifact.artifact_template"> |
| <code class="descname">artifact_template</code><a class="headerlink" href="#aria.modeling.models.Artifact.artifact_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Source artifact template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.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.Artifact.description"> |
| <code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.Artifact.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.Artifact.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Artifact.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.Artifact.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Artifact.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.Artifact.node"> |
| <code class="descname">node</code><a class="headerlink" href="#aria.modeling.models.Artifact.node" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing 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.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.Artifact.properties"> |
| <code class="descname">properties</code><a class="headerlink" href="#aria.modeling.models.Artifact.properties" title="Permalink to this definition">¶</a></dt> |
| <dd><p>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.Artifact.repository_credential"> |
| <code class="descname">repository_credential</code><a class="headerlink" href="#aria.modeling.models.Artifact.repository_credential" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Credentials for accessing the repository.</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 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.Artifact.repository_url"> |
| <code class="descname">repository_url</code><a class="headerlink" href="#aria.modeling.models.Artifact.repository_url" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Repository URL.</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.Artifact.source_path"> |
| <code class="descname">source_path</code><a class="headerlink" href="#aria.modeling.models.Artifact.source_path" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Source path (in CSAR or repository).</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.Artifact.target_path"> |
| <code class="descname">target_path</code><a class="headerlink" href="#aria.modeling.models.Artifact.target_path" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Path at which to install at destination.</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.Artifact.type"> |
| <code class="descname">type</code><a class="headerlink" href="#aria.modeling.models.Artifact.type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Artifact 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.ServiceUpdate"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">ServiceUpdate</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.ServiceUpdate" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Deployment update model representation.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceUpdate.created_at"> |
| <code class="descname">created_at</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdate.created_at" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceUpdate.execution"> |
| <code class="descname">execution</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdate.execution" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceUpdate.execution_name"> |
| <code class="descname">execution_name</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdate.execution_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.ServiceUpdate.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdate.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.ServiceUpdate.modified_entity_ids"> |
| <code class="descname">modified_entity_ids</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdate.modified_entity_ids" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceUpdate.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdate.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.ServiceUpdate.service"> |
| <code class="descname">service</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdate.service" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceUpdate.service_name"> |
| <code class="descname">service_name</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdate.service_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.ServiceUpdate.service_plan"> |
| <code class="descname">service_plan</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdate.service_plan" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceUpdate.service_update_node_templates"> |
| <code class="descname">service_update_node_templates</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdate.service_update_node_templates" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceUpdate.service_update_nodes"> |
| <code class="descname">service_update_nodes</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdate.service_update_nodes" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceUpdate.service_update_service"> |
| <code class="descname">service_update_service</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdate.service_update_service" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceUpdate.state"> |
| <code class="descname">state</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdate.state" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceUpdate.steps"> |
| <code class="descname">steps</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdate.steps" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.modeling.models.ServiceUpdateStep"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">ServiceUpdateStep</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.ServiceUpdateStep" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Deployment update step model representation.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceUpdateStep.action"> |
| <code class="descname">action</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdateStep.action" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceUpdateStep.entity_id"> |
| <code class="descname">entity_id</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdateStep.entity_id" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceUpdateStep.entity_type"> |
| <code class="descname">entity_type</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdateStep.entity_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceUpdateStep.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdateStep.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.ServiceUpdateStep.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdateStep.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.ServiceUpdateStep.service_update"> |
| <code class="descname">service_update</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdateStep.service_update" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceUpdateStep.service_update_name"> |
| <code class="descname">service_update_name</code><a class="headerlink" href="#aria.modeling.models.ServiceUpdateStep.service_update_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.ServiceModification"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">ServiceModification</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.ServiceModification" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Deployment modification model representation.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceModification.context"> |
| <code class="descname">context</code><a class="headerlink" href="#aria.modeling.models.ServiceModification.context" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceModification.created_at"> |
| <code class="descname">created_at</code><a class="headerlink" href="#aria.modeling.models.ServiceModification.created_at" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceModification.ended_at"> |
| <code class="descname">ended_at</code><a class="headerlink" href="#aria.modeling.models.ServiceModification.ended_at" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceModification.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.ServiceModification.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.ServiceModification.modified_node_templates"> |
| <code class="descname">modified_node_templates</code><a class="headerlink" href="#aria.modeling.models.ServiceModification.modified_node_templates" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceModification.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.ServiceModification.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.ServiceModification.nodes"> |
| <code class="descname">nodes</code><a class="headerlink" href="#aria.modeling.models.ServiceModification.nodes" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceModification.service"> |
| <code class="descname">service</code><a class="headerlink" href="#aria.modeling.models.ServiceModification.service" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.ServiceModification.service_name"> |
| <code class="descname">service_name</code><a class="headerlink" href="#aria.modeling.models.ServiceModification.service_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.ServiceModification.status"> |
| <code class="descname">status</code><a class="headerlink" href="#aria.modeling.models.ServiceModification.status" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.modeling.models.Input"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Input</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Input" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Input parameter or declaration for an input parameter.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Input.description"> |
| <code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.Input.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.Input.execution"> |
| <code class="descname">execution</code><a class="headerlink" href="#aria.modeling.models.Input.execution" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing execution (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Execution" title="aria.modeling.models.Execution"><code class="xref py py-class docutils literal"><span class="pre">Execution</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Input.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Input.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.Input.interface"> |
| <code class="descname">interface</code><a class="headerlink" href="#aria.modeling.models.Input.interface" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing interface (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Interface" title="aria.modeling.models.Interface"><code class="xref py py-class docutils literal"><span class="pre">Interface</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Input.interface_template"> |
| <code class="descname">interface_template</code><a class="headerlink" href="#aria.modeling.models.Input.interface_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing interface template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.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.Input.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Input.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.Input.operation"> |
| <code class="descname">operation</code><a class="headerlink" href="#aria.modeling.models.Input.operation" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing operation (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Operation" title="aria.modeling.models.Operation"><code class="xref py py-class docutils literal"><span class="pre">Operation</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Input.operation_template"> |
| <code class="descname">operation_template</code><a class="headerlink" href="#aria.modeling.models.Input.operation_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing operation template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.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> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Input.service"> |
| <code class="descname">service</code><a class="headerlink" href="#aria.modeling.models.Input.service" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing service (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Input.service_template"> |
| <code class="descname">service_template</code><a class="headerlink" href="#aria.modeling.models.Input.service_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing service template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Input.type_name"> |
| <code class="descname">type_name</code><a class="headerlink" href="#aria.modeling.models.Input.type_name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Type 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> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.modeling.models.Configuration"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Configuration</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Configuration" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Configuration parameter.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Configuration.description"> |
| <code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.Configuration.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.Configuration.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Configuration.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.Configuration.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Configuration.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.Configuration.operation"> |
| <code class="descname">operation</code><a class="headerlink" href="#aria.modeling.models.Configuration.operation" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing operation (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Operation" title="aria.modeling.models.Operation"><code class="xref py py-class docutils literal"><span class="pre">Operation</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Configuration.operation_template"> |
| <code class="descname">operation_template</code><a class="headerlink" href="#aria.modeling.models.Configuration.operation_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing operation template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.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> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Configuration.type_name"> |
| <code class="descname">type_name</code><a class="headerlink" href="#aria.modeling.models.Configuration.type_name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Type 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> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.modeling.models.Output"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Output</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Output" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Output parameter or declaration for an output parameter.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Output.description"> |
| <code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.Output.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.Output.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Output.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.Output.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Output.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.Output.service"> |
| <code class="descname">service</code><a class="headerlink" href="#aria.modeling.models.Output.service" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing service (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Output.service_template"> |
| <code class="descname">service_template</code><a class="headerlink" href="#aria.modeling.models.Output.service_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing service template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Output.type_name"> |
| <code class="descname">type_name</code><a class="headerlink" href="#aria.modeling.models.Output.type_name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Type 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> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.modeling.models.Property"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Property</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Property" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Property parameter or declaration for a property parameter.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Property.artifact"> |
| <code class="descname">artifact</code><a class="headerlink" href="#aria.modeling.models.Property.artifact" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing artifact (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Artifact" title="aria.modeling.models.Artifact"><code class="xref py py-class docutils literal"><span class="pre">Artifact</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Property.artifact_template"> |
| <code class="descname">artifact_template</code><a class="headerlink" href="#aria.modeling.models.Property.artifact_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing artifact template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.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.Property.capability"> |
| <code class="descname">capability</code><a class="headerlink" href="#aria.modeling.models.Property.capability" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing capability (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Capability" title="aria.modeling.models.Capability"><code class="xref py py-class docutils literal"><span class="pre">Capability</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Property.capability_template"> |
| <code class="descname">capability_template</code><a class="headerlink" href="#aria.modeling.models.Property.capability_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing capability template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.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.Property.description"> |
| <code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.Property.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.Property.group"> |
| <code class="descname">group</code><a class="headerlink" href="#aria.modeling.models.Property.group" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing group (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Property.group_template"> |
| <code class="descname">group_template</code><a class="headerlink" href="#aria.modeling.models.Property.group_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing group template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.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.Property.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Property.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.Property.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Property.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.Property.node"> |
| <code class="descname">node</code><a class="headerlink" href="#aria.modeling.models.Property.node" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing node (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Property.node_template"> |
| <code class="descname">node_template</code><a class="headerlink" href="#aria.modeling.models.Property.node_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing node template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Property.policy"> |
| <code class="descname">policy</code><a class="headerlink" href="#aria.modeling.models.Property.policy" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing policy (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Property.policy_template"> |
| <code class="descname">policy_template</code><a class="headerlink" href="#aria.modeling.models.Property.policy_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing policy template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.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.Property.relationship"> |
| <code class="descname">relationship</code><a class="headerlink" href="#aria.modeling.models.Property.relationship" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing relationship (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Relationship" title="aria.modeling.models.Relationship"><code class="xref py py-class docutils literal"><span class="pre">Relationship</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Property.relationship_template"> |
| <code class="descname">relationship_template</code><a class="headerlink" href="#aria.modeling.models.Property.relationship_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing relationship template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.RelationshipTemplate" title="aria.modeling.models.RelationshipTemplate"><code class="xref py py-class docutils literal"><span class="pre">RelationshipTemplate</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Property.type_name"> |
| <code class="descname">type_name</code><a class="headerlink" href="#aria.modeling.models.Property.type_name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Type 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> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.modeling.models.Attribute"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Attribute</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Attribute" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Attribute parameter or declaration for an attribute parameter.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Attribute.description"> |
| <code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.Attribute.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.Attribute.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Attribute.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.Attribute.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Attribute.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.Attribute.node"> |
| <code class="descname">node</code><a class="headerlink" href="#aria.modeling.models.Attribute.node" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing node (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Attribute.node_template"> |
| <code class="descname">node_template</code><a class="headerlink" href="#aria.modeling.models.Attribute.node_template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing node template (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Attribute.type_name"> |
| <code class="descname">type_name</code><a class="headerlink" href="#aria.modeling.models.Attribute.type_name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Type 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> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.modeling.models.Type"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Type</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Type" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Type and its children. Can serve as the root for a type hierarchy.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Type.children"> |
| <code class="descname">children</code><a class="headerlink" href="#aria.modeling.models.Type.children" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Children.</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.Type.description"> |
| <code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.Type.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.Type.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Type.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.Type.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Type.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.Type.parent"> |
| <code class="descname">parent</code><a class="headerlink" href="#aria.modeling.models.Type.parent" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Parent type (will be <code class="docutils literal"><span class="pre">None</span></code> for the root of a 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.Type.variant"> |
| <code class="descname">variant</code><a class="headerlink" href="#aria.modeling.models.Type.variant" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.modeling.models.Metadata"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Metadata</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Metadata" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Custom values associated with the service.</p> |
| <p>This model is used by both service template and service instance elements.</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">Variables:</th><td class="field-body"><ul class="first last simple"> |
| <li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring" title="(in Python v2.7)"><em>basestring</em></a>) – name</li> |
| <li><strong>value</strong> (<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#basestring" title="(in Python v2.7)"><em>basestring</em></a>) – value</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Metadata.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Metadata.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.Metadata.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Metadata.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.Metadata.value"> |
| <code class="descname">value</code><a class="headerlink" href="#aria.modeling.models.Metadata.value" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.modeling.models.Execution"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Execution</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Execution" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Workflow execution.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Execution.created_at"> |
| <code class="descname">created_at</code><a class="headerlink" href="#aria.modeling.models.Execution.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.Execution.ended_at"> |
| <code class="descname">ended_at</code><a class="headerlink" href="#aria.modeling.models.Execution.ended_at" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Ended 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.Execution.error"> |
| <code class="descname">error</code><a class="headerlink" href="#aria.modeling.models.Execution.error" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Error message.</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.Execution.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Execution.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.Execution.inputs"> |
| <code class="descname">inputs</code><a class="headerlink" href="#aria.modeling.models.Execution.inputs" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Execution 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.Execution.logs"> |
| <code class="descname">logs</code><a class="headerlink" href="#aria.modeling.models.Execution.logs" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Log messages for the execution (including log messages for its tasks).</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.Log" title="aria.modeling.models.Log"><code class="xref py py-class docutils literal"><span class="pre">Log</span></code></a>]</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Execution.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Execution.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.Execution.service"> |
| <code class="descname">service</code><a class="headerlink" href="#aria.modeling.models.Execution.service" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Associated 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 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.Execution.service_name"> |
| <code class="descname">service_name</code><a class="headerlink" href="#aria.modeling.models.Execution.service_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.Execution.service_template"> |
| <code class="descname">service_template</code><a class="headerlink" href="#aria.modeling.models.Execution.service_template" 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.Execution.service_template_name"> |
| <code class="descname">service_template_name</code><a class="headerlink" href="#aria.modeling.models.Execution.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.Execution.started_at"> |
| <code class="descname">started_at</code><a class="headerlink" href="#aria.modeling.models.Execution.started_at" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Started 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.Execution.status"> |
| <code class="descname">status</code><a class="headerlink" href="#aria.modeling.models.Execution.status" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Status.</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.Execution.tasks"> |
| <code class="descname">tasks</code><a class="headerlink" href="#aria.modeling.models.Execution.tasks" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Tasks.</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.Task" title="aria.modeling.models.Task"><code class="xref py py-class docutils literal"><span class="pre">Task</span></code></a>]</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Execution.workflow_name"> |
| <code class="descname">workflow_name</code><a class="headerlink" href="#aria.modeling.models.Execution.workflow_name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Workflow 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> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.modeling.models.Plugin"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Plugin</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Plugin" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Installed plugin.</p> |
| <p>Plugins are usually packaged as <a class="reference external" href="https://github.com/cloudify-cosmo/wagon">wagons</a>, which |
| are archives of one or more <a class="reference external" href="https://packaging.python.org/distributing/#wheels">wheels</a>. |
| Most of these fields are indeed extracted from the installed wagon’s metadata.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Plugin.archive_name"> |
| <code class="descname">archive_name</code><a class="headerlink" href="#aria.modeling.models.Plugin.archive_name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Filename (not the full path) of the wagon’s archive, often with a <code class="docutils literal"><span class="pre">.wgn</span></code> extension.</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.Plugin.distribution"> |
| <code class="descname">distribution</code><a class="headerlink" href="#aria.modeling.models.Plugin.distribution" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Name of the operating system on which the wagon was installed (e.g. <code class="docutils literal"><span class="pre">ubuntu</span></code>).</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.Plugin.distribution_release"> |
| <code class="descname">distribution_release</code><a class="headerlink" href="#aria.modeling.models.Plugin.distribution_release" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Release of the operating system on which the wagon was installed (e.g. <code class="docutils literal"><span class="pre">trusty</span></code>).</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.Plugin.distribution_version"> |
| <code class="descname">distribution_version</code><a class="headerlink" href="#aria.modeling.models.Plugin.distribution_version" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Version of the operating system on which the wagon was installed (e.g. <code class="docutils literal"><span class="pre">14.04</span></code>).</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.Plugin.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Plugin.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.Plugin.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Plugin.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.Plugin.package_name"> |
| <code class="descname">package_name</code><a class="headerlink" href="#aria.modeling.models.Plugin.package_name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Primary Python package name used when the wagon was installed, which is one of the wheels in the |
| wagon (e.g. <code class="docutils literal"><span class="pre">cloudify-script-plugin</span></code>).</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.Plugin.package_source"> |
| <code class="descname">package_source</code><a class="headerlink" href="#aria.modeling.models.Plugin.package_source" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Full install string for the primary Python package name used when the wagon was installed (e.g. |
| <code class="docutils literal"><span class="pre">cloudify-script-plugin==1.2</span></code>).</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.Plugin.package_version"> |
| <code class="descname">package_version</code><a class="headerlink" href="#aria.modeling.models.Plugin.package_version" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Version for the primary Python package name used when the wagon was installed (e.g. <code class="docutils literal"><span class="pre">1.2</span></code>).</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.Plugin.supported_platform"> |
| <code class="descname">supported_platform</code><a class="headerlink" href="#aria.modeling.models.Plugin.supported_platform" title="Permalink to this definition">¶</a></dt> |
| <dd><p>If the wheels are <em>all</em> pure Python then this would be “any”, otherwise it would be the |
| installed platform name (e.g. <code class="docutils literal"><span class="pre">linux_x86_64</span></code>).</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.Plugin.supported_py_versions"> |
| <code class="descname">supported_py_versions</code><a class="headerlink" href="#aria.modeling.models.Plugin.supported_py_versions" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Python versions supported by all the wheels (e.g. <code class="docutils literal"><span class="pre">["py26",</span> <span class="pre">"py27"]</span></code>)</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.Plugin.tasks"> |
| <code class="descname">tasks</code><a class="headerlink" href="#aria.modeling.models.Plugin.tasks" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Associated Tasks.</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.Task" title="aria.modeling.models.Task"><code class="xref py py-class docutils literal"><span class="pre">Task</span></code></a>]</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Plugin.uploaded_at"> |
| <code class="descname">uploaded_at</code><a class="headerlink" href="#aria.modeling.models.Plugin.uploaded_at" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Timestamp for when the wagon was installed.</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.Plugin.wheels"> |
| <code class="descname">wheels</code><a class="headerlink" href="#aria.modeling.models.Plugin.wheels" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Filenames of the wheels archived in the wagon, often with a <code class="docutils literal"><span class="pre">.whl</span></code> extension.</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.Task"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Task</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Task" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Represents the smallest unit of stateful execution in ARIA. The task state includes inputs, |
| outputs, as well as an atomic status, ensuring that the task can only be running once at any |
| given time.</p> |
| <p>The Python <a class="reference internal" href="#aria.modeling.models.Task.function" title="aria.modeling.models.Task.function"><code class="xref py py-attr docutils literal"><span class="pre">function</span></code></a> is usually provided by an associated <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>. The |
| <a class="reference internal" href="#aria.modeling.models.Task.arguments" title="aria.modeling.models.Task.arguments"><code class="xref py py-attr docutils literal"><span class="pre">arguments</span></code></a> of the function should be set according to the specific signature of the |
| function.</p> |
| <p>Tasks may be “one shot” or may be configured to run repeatedly in the case of failure.</p> |
| <p>Tasks are often based on <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>, and thus act on either 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> or a |
| <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>, however this is not required.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Task.arguments"> |
| <code class="descname">arguments</code><a class="headerlink" href="#aria.modeling.models.Task.arguments" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Arguments sent to the Python <code class="xref py py-attr docutils literal"><span class="pre">function`</span></code>.</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.Argument" title="aria.modeling.models.Argument"><code class="xref py py-class docutils literal"><span class="pre">Argument</span></code></a>}</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Task.attempts_count"> |
| <code class="descname">attempts_count</code><a class="headerlink" href="#aria.modeling.models.Task.attempts_count" title="Permalink to this definition">¶</a></dt> |
| <dd><p>How many attempts occurred.</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.Task.dependencies"> |
| <code class="descname">dependencies</code><a class="headerlink" href="#aria.modeling.models.Task.dependencies" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Task.due_at"> |
| <code class="descname">due_at</code><a class="headerlink" href="#aria.modeling.models.Task.due_at" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Timestamp to start the task.</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.Task.ended_at"> |
| <code class="descname">ended_at</code><a class="headerlink" href="#aria.modeling.models.Task.ended_at" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Ended 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.Task.execution"> |
| <code class="descname">execution</code><a class="headerlink" href="#aria.modeling.models.Task.execution" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing execution.</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.Execution" title="aria.modeling.models.Execution"><code class="xref py py-class docutils literal"><span class="pre">Execution</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Task.execution_name"> |
| <code class="descname">execution_name</code><a class="headerlink" href="#aria.modeling.models.Task.execution_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.Task.function"> |
| <code class="descname">function</code><a class="headerlink" href="#aria.modeling.models.Task.function" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Full path to Python function.</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.Task.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Task.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.Task.ignore_failure"> |
| <code class="descname">ignore_failure</code><a class="headerlink" href="#aria.modeling.models.Task.ignore_failure" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Set to <code class="docutils literal"><span class="pre">True</span></code> to ignore failures.</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#bool" title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">bool</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Task.interface_name"> |
| <code class="descname">interface_name</code><a class="headerlink" href="#aria.modeling.models.Task.interface_name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Name of interface on node or relationship.</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.Task.logs"> |
| <code class="descname">logs</code><a class="headerlink" href="#aria.modeling.models.Task.logs" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Log messages.</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.Log" title="aria.modeling.models.Log"><code class="xref py py-class docutils literal"><span class="pre">Log</span></code></a>]</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Task.max_attempts"> |
| <code class="descname">max_attempts</code><a class="headerlink" href="#aria.modeling.models.Task.max_attempts" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Maximum number of attempts allowed in case of task failure.</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.Task.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Task.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.Task.node"> |
| <code class="descname">node</code><a class="headerlink" href="#aria.modeling.models.Task.node" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Node actor (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Task.node_name"> |
| <code class="descname">node_name</code><a class="headerlink" href="#aria.modeling.models.Task.node_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.Task.operation_name"> |
| <code class="descname">operation_name</code><a class="headerlink" href="#aria.modeling.models.Task.operation_name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Name of operation in interface on node or relationship.</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.Task.plugin"> |
| <code class="descname">plugin</code><a class="headerlink" href="#aria.modeling.models.Task.plugin" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Associated plugin.</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.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> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Task.relationship"> |
| <code class="descname">relationship</code><a class="headerlink" href="#aria.modeling.models.Task.relationship" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Relationship actor (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Relationship" title="aria.modeling.models.Relationship"><code class="xref py py-class docutils literal"><span class="pre">Relationship</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Task.relationship_name"> |
| <code class="descname">relationship_name</code><a class="headerlink" href="#aria.modeling.models.Task.relationship_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.Task.retry_interval"> |
| <code class="descname">retry_interval</code><a class="headerlink" href="#aria.modeling.models.Task.retry_interval" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Interval between task retry attemps (in seconds).</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#float" title="(in Python v2.7)"><code class="xref py py-obj docutils literal"><span class="pre">float</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Task.started_at"> |
| <code class="descname">started_at</code><a class="headerlink" href="#aria.modeling.models.Task.started_at" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Started 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.Task.status"> |
| <code class="descname">status</code><a class="headerlink" href="#aria.modeling.models.Task.status" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Current atomic status (‘pending’, ‘retrying’, ‘sent’, ‘started’, ‘success’, ‘failed’).</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.Log"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Log</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Log" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Single log message.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Log.created_at"> |
| <code class="descname">created_at</code><a class="headerlink" href="#aria.modeling.models.Log.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.Log.execution"> |
| <code class="descname">execution</code><a class="headerlink" href="#aria.modeling.models.Log.execution" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing execution.</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.Execution" title="aria.modeling.models.Execution"><code class="xref py py-class docutils literal"><span class="pre">Execution</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Log.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Log.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.Log.level"> |
| <code class="descname">level</code><a class="headerlink" href="#aria.modeling.models.Log.level" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Log level.</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.Log.msg"> |
| <code class="descname">msg</code><a class="headerlink" href="#aria.modeling.models.Log.msg" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Log message.</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.Log.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Log.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.Log.task"> |
| <code class="descname">task</code><a class="headerlink" href="#aria.modeling.models.Log.task" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing task (can be <code class="docutils literal"><span class="pre">None</span></code>).</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.Task" title="aria.modeling.models.Task"><code class="xref py py-class docutils literal"><span class="pre">Task</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Log.traceback"> |
| <code class="descname">traceback</code><a class="headerlink" href="#aria.modeling.models.Log.traceback" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Error traceback in case of failure.</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> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="aria.modeling.models.Argument"> |
| <em class="property">class </em><code class="descclassname">aria.modeling.models.</code><code class="descname">Argument</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.modeling.models.Argument" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Python function argument parameter.</p> |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Argument.description"> |
| <code class="descname">description</code><a class="headerlink" href="#aria.modeling.models.Argument.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.Argument.id"> |
| <code class="descname">id</code><a class="headerlink" href="#aria.modeling.models.Argument.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.Argument.name"> |
| <code class="descname">name</code><a class="headerlink" href="#aria.modeling.models.Argument.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.Argument.operation"> |
| <code class="descname">operation</code><a class="headerlink" href="#aria.modeling.models.Argument.operation" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing operation (can be <code class="docutils literal"><span class="pre">None</span></code>);</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.Operation" title="aria.modeling.models.Operation"><code class="xref py py-class docutils literal"><span class="pre">Operation</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Argument.task"> |
| <code class="descname">task</code><a class="headerlink" href="#aria.modeling.models.Argument.task" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Containing task (can be <code class="docutils literal"><span class="pre">None</span></code>);</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.Task" title="aria.modeling.models.Task"><code class="xref py py-class docutils literal"><span class="pre">Task</span></code></a></td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="aria.modeling.models.Argument.type_name"> |
| <code class="descname">type_name</code><a class="headerlink" href="#aria.modeling.models.Argument.type_name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Type 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> |
| |
| </dd></dl> |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| <div class="articleComments"> |
| |
| </div> |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="aria.orchestrator.html" class="btn btn-neutral float-right" title="aria.orchestrator" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="aria.modeling.html" class="btn btn-neutral" title="aria.modeling" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © Copyright 2016-2017, Apache Software Foundation. |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'./', |
| VERSION:'0.1.1', |
| COLLAPSE_INDEX:false, |
| FILE_SUFFIX:'.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt' |
| }; |
| </script> |
| <script type="text/javascript" src="_static/jquery.js"></script> |
| <script type="text/javascript" src="_static/underscore.js"></script> |
| <script type="text/javascript" src="_static/doctools.js"></script> |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="_static/js/theme.js"></script> |
| |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.StickyNav.enable(); |
| }); |
| </script> |
| |
| |
| </body> |
| </html> |
