1
0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-23 01:49:59 -05:00
vsphere-automation-sdk-python/vsphere/6.6.1/vmware.vapi.stdlib.client.html

204 lines
10 KiB
HTML
Raw Normal View History

2018-08-07 19:42:25 -04:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>vmware.vapi.stdlib.client package &mdash; vSphere Automation SDK for Python 6.6.1 documentation</title>
<link rel="stylesheet" href="_static/vapitheme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '6.6.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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>
<link rel="top" title="vSphere Automation SDK for Python 6.6.1 documentation" href="index.html" />
<link rel="up" title="vmware.vapi.stdlib package" href="vmware.vapi.stdlib.html" />
<link rel="prev" title="vmware.vapi.stdlib package" href="vmware.vapi.stdlib.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="vmware.vapi.stdlib.html" title="vmware.vapi.stdlib package"
accesskey="P">previous</a> |</li>
<li><a href="index.html">vSphere Automation SDK for Python 6.6.1 documentation</a> &raquo;</li>
<li><a href="vmware.html" >vmware package</a> &raquo;</li>
<li><a href="vmware.vapi.html" >vmware.vapi package</a> &raquo;</li>
<li><a href="vmware.vapi.stdlib.html" accesskey="U">vmware.vapi.stdlib package</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="vmware-vapi-stdlib-client-package">
<h1>vmware.vapi.stdlib.client package<a class="headerlink" href="#vmware-vapi-stdlib-client-package" title="Permalink to this headline"></a></h1>
<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.stdlib.client.factories">
<span id="vmware-vapi-stdlib-client-factories-module"></span><h2>vmware.vapi.stdlib.client.factories module<a class="headerlink" href="#module-vmware.vapi.stdlib.client.factories" title="Permalink to this headline"></a></h2>
<p>StubConfiguration factory</p>
<dl class="class">
<dt id="vmware.vapi.stdlib.client.factories.StubConfigurationFactory">
<em class="property">class </em><tt class="descclassname">vmware.vapi.stdlib.client.factories.</tt><tt class="descname">StubConfigurationFactory</tt><a class="headerlink" href="#vmware.vapi.stdlib.client.factories.StubConfigurationFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
<p>Factory class for creating stub configuration objects</p>
<dl class="staticmethod">
<dt id="vmware.vapi.stdlib.client.factories.StubConfigurationFactory.new_configuration">
<em class="property">static </em><tt class="descname">new_configuration</tt><big>(</big><em>connector</em>, <em>*errorTypes</em><big>)</big><a class="headerlink" href="#vmware.vapi.stdlib.client.factories.StubConfigurationFactory.new_configuration" title="Permalink to this definition"></a></dt>
<dd><p>Return a stub configuration using the specified connection, with no
registered errors.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>connector</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.client.connector.Connector</span></tt>) &#8211; Connection to be used to talk to the remote
ApiProvider</li>
<li><strong>error_types</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of
<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.ErrorType</span></tt>) &#8211; error types to be registered in the configuration</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="staticmethod">
<dt id="vmware.vapi.stdlib.client.factories.StubConfigurationFactory.new_runtime_configuration">
<em class="property">static </em><tt class="descname">new_runtime_configuration</tt><big>(</big><em>connector</em>, <em>*errorTypes</em><big>)</big><a class="headerlink" href="#vmware.vapi.stdlib.client.factories.StubConfigurationFactory.new_runtime_configuration" title="Permalink to this definition"></a></dt>
<dd><p>Return a stub configuration using the specified connection, with the
errors reported by the vAPI runtime registered.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>connector</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.client.connector.Connector</span></tt>) &#8211; Connection to be used to talk to the remote
ApiProvider</li>
<li><strong>error_types</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of
<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.ErrorType</span></tt>) &#8211; additional error types to be registered in the
configuration</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="staticmethod">
<dt id="vmware.vapi.stdlib.client.factories.StubConfigurationFactory.new_std_configuration">
<em class="property">static </em><tt class="descname">new_std_configuration</tt><big>(</big><em>connector</em>, <em>*errorTypes</em><big>)</big><a class="headerlink" href="#vmware.vapi.stdlib.client.factories.StubConfigurationFactory.new_std_configuration" title="Permalink to this definition"></a></dt>
<dd><p>Return a stub configuration using the specified connection, with all the
standard errors registered.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>connector</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.client.connector.Connector</span></tt>) &#8211; Connection to be used to talk to the remote
ApiProvider</li>
<li><strong>error_types</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of
<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.ErrorType</span></tt>) &#8211; additional error types to be registered in the
configuration</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-vmware.vapi.stdlib.client">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-vmware.vapi.stdlib.client" title="Permalink to this headline"></a></h2>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">vmware.vapi.stdlib.client package</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-vmware.vapi.stdlib.client.factories">vmware.vapi.stdlib.client.factories module</a></li>
<li><a class="reference internal" href="#module-vmware.vapi.stdlib.client">Module contents</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="vmware.vapi.stdlib.html"
title="previous chapter">vmware.vapi.stdlib package</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/vmware.vapi.stdlib.client.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="vmware.vapi.stdlib.html" title="vmware.vapi.stdlib package"
>previous</a> |</li>
<li><a href="index.html">vSphere Automation SDK for Python 6.6.1 documentation</a> &raquo;</li>
<li><a href="vmware.html" >vmware package</a> &raquo;</li>
<li><a href="vmware.vapi.html" >vmware.vapi package</a> &raquo;</li>
<li><a href="vmware.vapi.stdlib.html" >vmware.vapi.stdlib package</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2014-2017, VMware, Inc. All rights reserved.
</div>
</body>
</html>