mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 17:39:59 -05:00
925 lines
53 KiB
HTML
925 lines
53 KiB
HTML
|
||
|
||
<!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>vmware.vapi package — vSphere Automation SDK for Python. 6.9.1 documentation</title>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||
|
||
|
||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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/language_data.js"></script>
|
||
|
||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="vmware.vapi.lib package" href="vmware.vapi.lib.html" />
|
||
<link rel="prev" title="vmware package" href="vmware.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
|
||
|
||
<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"> vSphere Automation SDK for Python.
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div class="version">
|
||
6.9.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">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="com.html">com package</a></li>
|
||
<li class="toctree-l1 current"><a class="reference internal" href="vmware.html">vmware package</a><ul class="current">
|
||
<li class="toctree-l2 current"><a class="reference internal" href="vmware.html#subpackages">Subpackages</a><ul class="current">
|
||
<li class="toctree-l3 current"><a class="current reference internal" href="#">vmware.vapi package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#subpackages">Subpackages</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#module-vmware.vapi.core">vmware.vapi.core module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#module-vmware.vapi.exception">vmware.vapi.exception module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#module-vmware.vapi.message">vmware.vapi.message module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
||
|
||
<nav class="wy-nav-top" aria-label="top navigation">
|
||
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">vSphere Automation SDK for Python.</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><a href="vmware.html">vmware package</a> »</li>
|
||
|
||
<li>vmware.vapi package</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
<a href="_sources/vmware.vapi.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-vmware.vapi">
|
||
<span id="vmware-vapi-package"></span><h1>vmware.vapi package<a class="headerlink" href="#module-vmware.vapi" title="Permalink to this headline">¶</a></h1>
|
||
<div class="section" id="subpackages">
|
||
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
||
<div class="toctree-wrapper compound">
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="vmware.vapi.lib.html">vmware.vapi.lib package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.lib.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.lib.html#module-vmware.vapi.lib.connect">vmware.vapi.lib.connect module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="vmware.vapi.security.html">vmware.vapi.security package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.security.html#subpackages">Subpackages</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="vmware.vapi.security.client.html">vmware.vapi.security.client package</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.security.client.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="vmware.vapi.security.client.html#module-vmware.vapi.security.client.security_context_filter">vmware.vapi.security.client.security_context_filter module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.security.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.security.html#module-vmware.vapi.security.session">vmware.vapi.security.session module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.security.html#module-vmware.vapi.security.sso">vmware.vapi.security.sso module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.security.html#module-vmware.vapi.security.user_password">vmware.vapi.security.user_password module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="vmware.vapi.vsphere.html">vmware.vapi.vsphere package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.vsphere.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.vsphere.html#module-vmware.vapi.vsphere.client">vmware.vapi.vsphere.client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="submodules">
|
||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
<div class="section" id="module-vmware.vapi.core">
|
||
<span id="vmware-vapi-core-module"></span><h2>vmware.vapi.core module<a class="headerlink" href="#module-vmware.vapi.core" title="Permalink to this headline">¶</a></h2>
|
||
<p>Core Protocol Definition classes</p>
|
||
<dl class="class">
|
||
<dt id="vmware.vapi.core.ApiInterface">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vapi.core.</code><code class="sig-name descname">ApiInterface</code><a class="headerlink" href="#vmware.vapi.core.ApiInterface" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>The ApiInterface interface provides introspection APIs for a
|
||
vAPI interface; it is implemented by API providers.</p>
|
||
<p>Initialize the Api Interface instance</p>
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.ApiInterface.get_definition">
|
||
<code class="sig-name descname">get_definition</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.ApiInterface.get_definition" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns interface definition</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#vmware.vapi.core.InterfaceDefinition" title="vmware.vapi.core.InterfaceDefinition"><code class="xref py py-class docutils literal notranslate"><span class="pre">InterfaceDefinition</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Interface definition</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.ApiInterface.get_identifier">
|
||
<code class="sig-name descname">get_identifier</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.ApiInterface.get_identifier" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns interface identifier</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#vmware.vapi.core.InterfaceIdentifier" title="vmware.vapi.core.InterfaceIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">InterfaceIdentifier</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Interface identifier</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.ApiInterface.get_method_definition">
|
||
<code class="sig-name descname">get_method_definition</code><span class="sig-paren">(</span><em class="sig-param">method_id</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.ApiInterface.get_method_definition" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the method definition</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#vmware.vapi.core.MethodDefinition" title="vmware.vapi.core.MethodDefinition"><code class="xref py py-class docutils literal notranslate"><span class="pre">MethodDefinition</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Method definition</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.ApiInterface.invoke">
|
||
<code class="sig-name descname">invoke</code><span class="sig-paren">(</span><em class="sig-param">ctx</em>, <em class="sig-param">method_id</em>, <em class="sig-param">input_value</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.ApiInterface.invoke" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Invokes the specified method using the execution context and
|
||
the input provided</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>ctx</strong> (<a class="reference internal" href="#vmware.vapi.core.ExecutionContext" title="vmware.vapi.core.ExecutionContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExecutionContext</span></code></a>) – Execution context for this method</p></li>
|
||
<li><p><strong>method_id</strong> (<a class="reference internal" href="#vmware.vapi.core.MethodIdentifier" title="vmware.vapi.core.MethodIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">MethodIdentifier</span></code></a>) – Method identifier</p></li>
|
||
<li><p><strong>input_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.value.StructValue</span></code>) – Method input parameters</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#vmware.vapi.core.MethodResult" title="vmware.vapi.core.MethodResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">MethodResult</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Result of the method invocation</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="vmware.vapi.core.ApiProvider">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vapi.core.</code><code class="sig-name descname">ApiProvider</code><a class="headerlink" href="#vmware.vapi.core.ApiProvider" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>The ApiProvider interface is used for invocation of operations</p>
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.ApiProvider.invoke">
|
||
<em class="property">abstract </em><code class="sig-name descname">invoke</code><span class="sig-paren">(</span><em class="sig-param">service_id</em>, <em class="sig-param">operation_id</em>, <em class="sig-param">input_value</em>, <em class="sig-param">ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.ApiProvider.invoke" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Invokes the specified method using the input value and the
|
||
the execution context provided</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Service identifier</p></li>
|
||
<li><p><strong>operation_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Operation identifier</p></li>
|
||
<li><p><strong>input_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.value.StructValue</span></code>) – Input parameters for the method</p></li>
|
||
<li><p><strong>ctx</strong> (<a class="reference internal" href="#vmware.vapi.core.ExecutionContext" title="vmware.vapi.core.ExecutionContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExecutionContext</span></code></a>) – Execution context for the method</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#vmware.vapi.core.MethodResult" title="vmware.vapi.core.MethodResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">MethodResult</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Result of the method invocation</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="vmware.vapi.core.ApplicationContext">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vapi.core.</code><code class="sig-name descname">ApplicationContext</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.ApplicationContext" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.core.CustomDict" title="vmware.vapi.core.CustomDict"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.CustomDict</span></code></a></p>
|
||
<p>Interface representing additional data associated with the request for
|
||
method execution represented by this ExecutionContext.
|
||
The additional data format is key-value pairs of String.</p>
|
||
<p>This additional data is provided by the client initiating the
|
||
execution, it is then transported as is over the wire and is
|
||
available for the provider-side service implementations on the server.
|
||
This extra data is completely opaque for the infrastructure, in other
|
||
words it is a contract between the client and the service implementation
|
||
only.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="vmware.vapi.core.CustomDict">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vapi.core.</code><code class="sig-name descname">CustomDict</code><a class="headerlink" href="#vmware.vapi.core.CustomDict" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></p>
|
||
<p>Interface for implementing Custom dict classes with additional constraints.</p>
|
||
<p>Overriding __setitem__ as not enough for adding additional constraints on
|
||
key/value pairs of dictionaries. We also have to override update and
|
||
setdefault, so that even they use __setitem__.</p>
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.CustomDict.setdefault">
|
||
<code class="sig-name descname">setdefault</code><span class="sig-paren">(</span><em class="sig-param">k</em><span class="optional">[</span>, <em class="sig-param">d</em><span class="optional">]</span><span class="sig-paren">)</span> → D.get(k,d), also set D[k]=d if k not in D<a class="headerlink" href="#vmware.vapi.core.CustomDict.setdefault" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.CustomDict.update">
|
||
<code class="sig-name descname">update</code><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param">E</em>, <span class="optional">]</span><em class="sig-param">**F</em><span class="sig-paren">)</span> → None. Update D from dict/iterable E and F.<a class="headerlink" href="#vmware.vapi.core.CustomDict.update" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>If E is present and has a .keys() method, then does: for k in E: D[k] = E[k]
|
||
If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v
|
||
In either case, this is followed by: for k in F: D[k] = F[k]</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="vmware.vapi.core.ExecutionContext">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vapi.core.</code><code class="sig-name descname">ExecutionContext</code><span class="sig-paren">(</span><em class="sig-param">application_context=None</em>, <em class="sig-param">security_context=None</em>, <em class="sig-param">runtime_data=None</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.ExecutionContext" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>This class provides out-of-band context information that is passed along
|
||
with a method invocation</p>
|
||
<p>Initialize Execution Context</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="vmware.vapi.core.InterfaceDefinition">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vapi.core.</code><code class="sig-name descname">InterfaceDefinition</code><span class="sig-paren">(</span><em class="sig-param">id_</em>, <em class="sig-param">method_ids</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.InterfaceDefinition" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>The InterfaceDefinition class contains detailed information about a
|
||
vAPI interface. This should contain all the information required
|
||
to address an interface in the vAPI runtime.</p>
|
||
<p>Initialize the InterfaceDefinition</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<a class="reference internal" href="#vmware.vapi.core.InterfaceIdentifier" title="vmware.vapi.core.InterfaceIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">InterfaceIdentifier</span></code></a>) – InterfaceIdentifier of this interface</p></li>
|
||
<li><p><strong>method_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#vmware.vapi.core.MethodIdentifier" title="vmware.vapi.core.MethodIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">MethodIdentifier</span></code></a>) – List of method identifiers of the methods exposed by
|
||
this interface</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.InterfaceDefinition.get_identifier">
|
||
<code class="sig-name descname">get_identifier</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.InterfaceDefinition.get_identifier" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the interface identifier</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#vmware.vapi.core.InterfaceIdentifier" title="vmware.vapi.core.InterfaceIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">InterfaceIdentifier</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Returns the interface identifer of this interface</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.InterfaceDefinition.get_method_identifiers">
|
||
<code class="sig-name descname">get_method_identifiers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.InterfaceDefinition.get_method_identifiers" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the list of method identifiers of the methods exposed by this
|
||
interface. Each method identifier is unique within an interface. The
|
||
method identifiers returned are unordered</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#vmware.vapi.core.MethodIdentifier" title="vmware.vapi.core.MethodIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">MethodIdentifier</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>List of method identifiers of the methods exposed by this
|
||
interface</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="vmware.vapi.core.InterfaceIdentifier">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vapi.core.</code><code class="sig-name descname">InterfaceIdentifier</code><span class="sig-paren">(</span><em class="sig-param">iface</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.InterfaceIdentifier" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>InterfaceIdentifier has the information required to uniquely
|
||
address a vAPI interface</p>
|
||
<p>Initialize an InterfaceIdentifier</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>iface</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String identifier of the interface</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.InterfaceIdentifier.get_name">
|
||
<code class="sig-name descname">get_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.InterfaceIdentifier.get_name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the string identifier of the interface</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>String identifier of the interface</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="vmware.vapi.core.MethodDefinition">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vapi.core.</code><code class="sig-name descname">MethodDefinition</code><span class="sig-paren">(</span><em class="sig-param">id_</em>, <em class="sig-param">input_</em>, <em class="sig-param">output</em>, <em class="sig-param">errors</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.MethodDefinition" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>This class contains detailed information about a vAPI method. This should
|
||
contain all the information required to address a method in the vAPI
|
||
runtime.</p>
|
||
<p>Initialize MethodDefinition</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<a class="reference internal" href="#vmware.vapi.core.MethodIdentifier" title="vmware.vapi.core.MethodIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">MethodIdentifier</span></code></a>) – MethodIdentifier of this method</p></li>
|
||
<li><p><strong>input</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.definition.StructDefinition</span></code>) – Struct definition corresponding to the method’s input
|
||
parameters</p></li>
|
||
<li><p><strong>output</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.definition.DataDefinition</span></code>) – Data definition of the method’s output</p></li>
|
||
<li><p><strong>errors</strong> (iterable of
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.definition.ErrorDefinition</span></code>) – Error definitions describing the errors that this method
|
||
can report</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.MethodDefinition.get_error_definition">
|
||
<code class="sig-name descname">get_error_definition</code><span class="sig-paren">(</span><em class="sig-param">error_name</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.MethodDefinition.get_error_definition" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the error definition with the specified name reported by this
|
||
method or None if this method doesn’t report an error with the specified
|
||
name.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>error_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the error definition to return</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.definition.ErrorDefinition</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Error definition with the specified name reported by this
|
||
method or None if this method doesn’t report an error with the
|
||
specified name.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.MethodDefinition.get_error_definitions">
|
||
<code class="sig-name descname">get_error_definitions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.MethodDefinition.get_error_definitions" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns a set of error definitions describing the errors that this
|
||
method can report</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.definition.ErrorDefinition</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Set of error definitions describing the errors that this
|
||
method can report</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.MethodDefinition.get_identifier">
|
||
<code class="sig-name descname">get_identifier</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.MethodDefinition.get_identifier" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the method identifier</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#vmware.vapi.core.MethodIdentifier" title="vmware.vapi.core.MethodIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">MethodIdentifier</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>MethodIdentifier of this method</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.MethodDefinition.get_input_definition">
|
||
<code class="sig-name descname">get_input_definition</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.MethodDefinition.get_input_definition" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the struct definition corresponding to the method’s input
|
||
parameters. The field names in the struct definition are the parameter
|
||
names and the field values correspond to the data definition of the
|
||
respective fields.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.definition.StructDefinition</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>StructDefinition correspoding to the method’s input</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.MethodDefinition.get_output_definition">
|
||
<code class="sig-name descname">get_output_definition</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.MethodDefinition.get_output_definition" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the data definition of the method’s output</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.definition.DataDefinition</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Data definition of the method’s output</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="vmware.vapi.core.MethodIdentifier">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vapi.core.</code><code class="sig-name descname">MethodIdentifier</code><span class="sig-paren">(</span><em class="sig-param">iface</em>, <em class="sig-param">method</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.MethodIdentifier" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>This class identifies a <code class="xref py py-class docutils literal notranslate"><span class="pre">ApiMethod</span></code> instance</p>
|
||
<p>Initialize the MethodIdentifier</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>iface</strong> (<a class="reference internal" href="#vmware.vapi.core.InterfaceIdentifier" title="vmware.vapi.core.InterfaceIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">InterfaceIdentifier</span></code></a>) – InterfaceIdentifier of this method</p></li>
|
||
<li><p><strong>method</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String identifier of this method</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.MethodIdentifier.get_interface_identifier">
|
||
<code class="sig-name descname">get_interface_identifier</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.MethodIdentifier.get_interface_identifier" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the interface identifier of the method</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#vmware.vapi.core.InterfaceIdentifier" title="vmware.vapi.core.InterfaceIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">InterfaceIdentifier</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>InterfaceIdentifier of this method</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.MethodIdentifier.get_name">
|
||
<code class="sig-name descname">get_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.MethodIdentifier.get_name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the string identifier of the method</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>String identifier of the method</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="vmware.vapi.core.MethodResult">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vapi.core.</code><code class="sig-name descname">MethodResult</code><span class="sig-paren">(</span><em class="sig-param">output=None</em>, <em class="sig-param">error=None</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.MethodResult" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>The MethodResult class contains the result of a method call.
|
||
It contains either the output of the method invocation or
|
||
an error reported by the method invocation. These are mutually
|
||
exclusive.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Variables</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><a class="reference internal" href="#vmware.vapi.core.MethodResult.output" title="vmware.vapi.core.MethodResult.output"><strong>output</strong></a> – Method output</p></li>
|
||
<li><p><a class="reference internal" href="#vmware.vapi.core.MethodResult.error" title="vmware.vapi.core.MethodResult.error"><strong>error</strong></a> – Method error</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<p>Initialize MethodResult</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>output</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.value.DataValue</span></code>) – Method output</p></li>
|
||
<li><p><strong>error</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.value.ErrorValue</span></code>) – Method error</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.MethodResult.error">
|
||
<em class="property">property </em><code class="sig-name descname">error</code><a class="headerlink" href="#vmware.vapi.core.MethodResult.error" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.value.ErrorValue</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Method error</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.MethodResult.output">
|
||
<em class="property">property </em><code class="sig-name descname">output</code><a class="headerlink" href="#vmware.vapi.core.MethodResult.output" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.data.value.DataValue</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Method output</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.MethodResult.success">
|
||
<code class="sig-name descname">success</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.MethodResult.success" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Check if the method completed successfully.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>False if the method reported an error, True otherwise</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="vmware.vapi.core.ProviderDefinition">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vapi.core.</code><code class="sig-name descname">ProviderDefinition</code><span class="sig-paren">(</span><em class="sig-param">name</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.ProviderDefinition" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>The ProviderDefinition class contains details information about a
|
||
vAPI provider</p>
|
||
<p>Initialize the ProviderDefinition</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the provider</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.core.ProviderDefinition.get_identifier">
|
||
<code class="sig-name descname">get_identifier</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.ProviderDefinition.get_identifier" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the provider identifier.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Provider identifier</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="vmware.vapi.core.RuntimeData">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vapi.core.</code><code class="sig-name descname">RuntimeData</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.RuntimeData" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.core.CustomDict" title="vmware.vapi.core.CustomDict"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.CustomDict</span></code></a></p>
|
||
<p>Implementations of this interface will provide custom runtime data.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="vmware.vapi.core.SecurityContext">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vapi.core.</code><code class="sig-name descname">SecurityContext</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.core.SecurityContext" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.core.CustomDict" title="vmware.vapi.core.CustomDict"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.core.CustomDict</span></code></a></p>
|
||
<p>Implementations of this interface will provide all needed data for
|
||
authentication for the given invocation.</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vapi.exception">
|
||
<span id="vmware-vapi-exception-module"></span><h2>vmware.vapi.exception module<a class="headerlink" href="#module-vmware.vapi.exception" title="Permalink to this headline">¶</a></h2>
|
||
<p>vAPI CoreException Class</p>
|
||
<dl class="exception">
|
||
<dt id="vmware.vapi.exception.CoreException">
|
||
<em class="property">exception </em><code class="sig-prename descclassname">vmware.vapi.exception.</code><code class="sig-name descname">CoreException</code><span class="sig-paren">(</span><em class="sig-param">message</em>, <em class="sig-param">cause=None</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.exception.CoreException" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
|
||
<p>This exception is raised by various components of the vAPI runtime
|
||
infrastructure to indicate failures in that infrastructure.</p>
|
||
<p>Server-side the exception is caught by specific components and an
|
||
internal_server_error is reported to the client that invoked the
|
||
request. Client-side the exception may be raised for certain failures
|
||
before a request was sent to the server or after the response was
|
||
received from the server. Similarly, server-side the exception may
|
||
be raised for failures that occur when a provider implementation
|
||
invokes the vAPI runtime.</p>
|
||
<p>This exception is not part of the vAPI message protocol, and it must
|
||
never be raised by provider implementations.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Variables</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.html#com.vmware.appliance_client.Health.messages" title="com.vmware.appliance_client.Health.messages"><strong>messages</strong></a> – Generator of error messages describing why the Exception
|
||
was raised</p>
|
||
</dd>
|
||
</dl>
|
||
<p>Initialize CoreException</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>message</strong> (<a class="reference internal" href="#vmware.vapi.message.Message" title="vmware.vapi.message.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.message.Message</span></code></a>) – Description regarding why the Exception was raised</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.exception.CoreException.messages">
|
||
<em class="property">property </em><code class="sig-name descname">messages</code><a class="headerlink" href="#vmware.vapi.exception.CoreException.messages" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p>generator of <a class="reference internal" href="#vmware.vapi.message.Message" title="vmware.vapi.message.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.message.Message</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Generator of error messages describing why the Exception
|
||
was raised</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-vmware.vapi.message">
|
||
<span id="vmware-vapi-message-module"></span><h2>vmware.vapi.message module<a class="headerlink" href="#module-vmware.vapi.message" title="Permalink to this headline">¶</a></h2>
|
||
<p>vAPI Message class</p>
|
||
<dl class="class">
|
||
<dt id="vmware.vapi.message.Message">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vapi.message.</code><code class="sig-name descname">Message</code><span class="sig-paren">(</span><em class="sig-param">id_</em>, <em class="sig-param">def_msg</em>, <em class="sig-param">*args</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.message.Message" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>This class encapsulates the concept of a localizable message.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Variables</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> – The unique message identifier</p></li>
|
||
<li><p><strong>def_msg</strong> – An english language default</p></li>
|
||
<li><p><strong>args</strong> – The arguments to be used for the messsage</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<p>Initializes the message object</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">string</span></code>) – The unique message identifier</p></li>
|
||
<li><p><strong>def_msg</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">string</span></code>) – An english language default</p></li>
|
||
<li><p><strong>args</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">string</span></code>) – The arguments to be used for the messsage</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="vmware.vapi.message.MessageBundle">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vapi.message.</code><code class="sig-name descname">MessageBundle</code><span class="sig-paren">(</span><em class="sig-param">messages</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.message.MessageBundle" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Base class for all message bundle classes.</p>
|
||
<p>Initialize MessageBundle.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Dictionary with message identifiers as keys and
|
||
message templates as values.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.message.MessageBundle.get">
|
||
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param">msg_id</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.message.MessageBundle.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the message template for the given message identifier</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>msg_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Message identifier</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Message template</p>
|
||
</dd>
|
||
<dt class="field-even">Raises</dt>
|
||
<dd class="field-even"><p><strong>KeyError</strong> – If the message identifier is not found</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="vmware.vapi.message.MessageFactory">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vapi.message.</code><code class="sig-name descname">MessageFactory</code><span class="sig-paren">(</span><em class="sig-param">msg_bundle</em>, <em class="sig-param">formatter</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.message.MessageFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>A factory class to generate localizable messages</p>
|
||
<p>Initializes the message object</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>messages</strong> – The message dictionary for the message factory</p></li>
|
||
<li><p><strong>formatter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.formatter.MessageFormatter</span></code>) – Formatter for the message</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.message.MessageFactory.get_message">
|
||
<code class="sig-name descname">get_message</code><span class="sig-paren">(</span><em class="sig-param">id_</em>, <em class="sig-param">*args</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.message.MessageFactory.get_message" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return a message object for the given id with the given args.
|
||
If the message is not found, a default unknown message is returned.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>id</strong> (<em>string</em>) – The unique message identifier</p></li>
|
||
<li><p><strong>args</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code>) – The arguments to be used for constructing this message</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#vmware.vapi.message.Message" title="vmware.vapi.message.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">Message</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The message object constructed using the given arguments</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="vmware.vapi.message.MessageFormatter">
|
||
<em class="property">class </em><code class="sig-prename descclassname">vmware.vapi.message.</code><code class="sig-name descname">MessageFormatter</code><a class="headerlink" href="#vmware.vapi.message.MessageFormatter" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Base class for all message formatter classes</p>
|
||
<dl class="method">
|
||
<dt id="vmware.vapi.message.MessageFormatter.format_msg">
|
||
<em class="property">classmethod </em><code class="sig-name descname">format_msg</code><span class="sig-paren">(</span><em class="sig-param">msg</em>, <em class="sig-param">args</em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vapi.message.MessageFormatter.format_msg" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Format the message using the specified arguments</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>msg</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Message template</p></li>
|
||
<li><p><strong>args</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code>) – Arguments for the message</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Localized message</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="vmware.vapi.lib.html" class="btn btn-neutral float-right" title="vmware.vapi.lib package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="vmware.html" class="btn btn-neutral float-left" title="vmware package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2019, VMware, Inc.
|
||
|
||
</p>
|
||
</div>
|
||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/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">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |