1
0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 09:39:58 -05:00
vsphere-automation-sdk-python/vsphere/7.0.2.0/vmware.vapi.html
2021-03-17 20:29:47 +05:30

442 lines
20 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>vmware.vapi package &mdash; vSphere Automation SDK for Python. 7.0.2.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<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">
7.0.2.0
</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="#vmware-vapi-core-module">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" class="icon icon-home"></a> &raquo;</li>
<li><a href="vmware.html">vmware package</a> &raquo;</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#vmware-vapi-lib-connect-module">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#vmware-vapi-security-client-security-context-filter-module">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#vmware-vapi-security-session-module">vmware.vapi.security.session module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.security.html#vmware-vapi-security-sso-module">vmware.vapi.security.sso module</a></li>
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.security.html#vmware-vapi-security-user-password-module">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#vmware-vapi-vsphere-client-module">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="vmware-vapi-core-module">
<h2>vmware.vapi.core module<a class="headerlink" href="#vmware-vapi-core-module" title="Permalink to this headline"></a></h2>
</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="py 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"><span class="n">message</span></em>, <em class="sig-param"><span class="n">cause</span><span class="o">=</span><span class="default_value">None</span></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="#vmware.vapi.exception.CoreException.messages" title="vmware.vapi.exception.CoreException.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="py 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="py 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"><span class="n">id_</span></em>, <em class="sig-param"><span class="n">def_msg</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></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="py 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"><span class="n">messages</span></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="py method">
<dt id="vmware.vapi.message.MessageBundle.get">
<code class="sig-name descname">get</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">msg_id</span></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="py 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"><span class="n">msg_bundle</span></em>, <em class="sig-param"><span class="n">formatter</span></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="py 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"><span class="n">id_</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></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="py 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="py 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"><span class="n">msg</span></em>, <em class="sig-param"><span class="n">args</span></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" aria-hidden="true"></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" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, VMware, Inc..
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/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>