mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-29 12:00:00 -05:00
3720 lines
309 KiB
HTML
3720 lines
309 KiB
HTML
|
|
||
|
|
|
||
|
|
<!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>bindings Package — vCloud Suite SDK for Python 6.0.0 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.0.0',
|
||
|
|
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="vCloud Suite SDK for Python 6.0.0 documentation" href="index.html" />
|
||
|
|
<link rel="up" title="vapi Package" href="vmware.vapi.html" />
|
||
|
|
<link rel="next" title="data Package" href="vmware.vapi.data.html" />
|
||
|
|
<link rel="prev" title="vapi Package" href="vmware.vapi.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.data.html" title="data Package"
|
||
|
|
accesskey="N">next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="vmware.vapi.html" title="vapi Package"
|
||
|
|
accesskey="P">previous</a> |</li>
|
||
|
|
<li><a href="index.html">vCloud Suite SDK for Python 6.0.0 documentation</a> »</li>
|
||
|
|
<li><a href="vmware.html" >vmware Package</a> »</li>
|
||
|
|
<li><a href="vmware.vapi.html" accesskey="U">vapi Package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="document">
|
||
|
|
<div class="documentwrapper">
|
||
|
|
<div class="bodywrapper">
|
||
|
|
<div class="body">
|
||
|
|
|
||
|
|
<div class="section" id="bindings-package">
|
||
|
|
<h1>bindings Package<a class="headerlink" href="#bindings-package" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<div class="section" id="id1">
|
||
|
|
<h2><tt class="xref py py-mod docutils literal"><span class="pre">bindings</span></tt> Package<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<span class="target" id="module-vmware.vapi.bindings"></span></div>
|
||
|
|
<div class="section" id="module-vmware.vapi.bindings.common">
|
||
|
|
<span id="common-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">common</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.bindings.common" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Bindings common module that contains common code for skeletons and stubs</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.common.NameToTypeResolver">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.common.</tt><tt class="descname">NameToTypeResolver</tt><big>(</big><em>type_map</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/common.html#NameToTypeResolver"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.common.NameToTypeResolver" 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>Helper class that resolves a fully qualified canonical type name to a type
|
||
|
|
descriptor. The type name can be a structure name or an error name.</p>
|
||
|
|
<p>Initialize NameToTypeResolver</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>type_map</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> and <tt class="xref py py-class docutils literal"><span class="pre">VapiStruct</span></tt>) – Type map that contains the canonical names and the
|
||
|
|
references to the binding classes for these types.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.common.NameToTypeResolver.resolve">
|
||
|
|
<tt class="descname">resolve</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/common.html#NameToTypeResolver.resolve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.common.NameToTypeResolver.resolve" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Type name to be resolved</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.bindings.common.raise_core_exception">
|
||
|
|
<tt class="descclassname">vmware.vapi.bindings.common.</tt><tt class="descname">raise_core_exception</tt><big>(</big><em>msg_list</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/common.html#raise_core_exception"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.common.raise_core_exception" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Create and raise a CoreException from a list of 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">Parameters:</th><td class="field-body"><strong>msg_list</strong> (<a class="reference internal" href="vmware.vapi.html#vmware.vapi.message.Message" title="vmware.vapi.message.Message"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.message.Message</span></tt></a>) – List of messages</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body">CoreException if msg list is not empty</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-vmware.vapi.bindings.converter">
|
||
|
|
<span id="converter-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">converter</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.bindings.converter" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Type converter to/from vAPI runtime data model to Python native data model</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.PythonToVapiVisitor">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.converter.</tt><tt class="descname">PythonToVapiVisitor</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#PythonToVapiVisitor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.PythonToVapiVisitor" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingTypeVisitor" title="vmware.vapi.bindings.type.BindingTypeVisitor"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingTypeVisitor</span></tt></a></p>
|
||
|
|
<p>Visitor to convert from Python native value to vAPI DataValue</p>
|
||
|
|
<p>Initialize PythonToVapiVisitor</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>value</strong> (<tt class="xref py py-class docutils literal"><span class="pre">object</span></tt>) – Native python value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.PythonToVapiVisitor.get_out_value">
|
||
|
|
<tt class="descname">get_out_value</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#PythonToVapiVisitor.get_out_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.PythonToVapiVisitor.get_out_value" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the vAPI DataValue converted from the Python native value</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.DataValue" title="vmware.vapi.data.value.DataValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.DataValue</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">vAPI DataValue</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.PythonToVapiVisitor.visit">
|
||
|
|
<tt class="descname">visit</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#PythonToVapiVisitor.visit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.PythonToVapiVisitor.visit" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_any_error">
|
||
|
|
<tt class="descname">visit_any_error</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#PythonToVapiVisitor.visit_any_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_any_error" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit any error value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.AnyErrorType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_date_time">
|
||
|
|
<tt class="descname">visit_date_time</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#PythonToVapiVisitor.visit_date_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_date_time" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a datetime value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.DateTimeType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_dynamic_struct">
|
||
|
|
<tt class="descname">visit_dynamic_struct</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#PythonToVapiVisitor.visit_dynamic_struct"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_dynamic_struct" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit any struct value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.DynamicStructType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_enum">
|
||
|
|
<tt class="descname">visit_enum</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#PythonToVapiVisitor.visit_enum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_enum" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a enum type python value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.EnumType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_error">
|
||
|
|
<tt class="descname">visit_error</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#PythonToVapiVisitor.visit_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_error" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit an error value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.ErrorType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_list">
|
||
|
|
<tt class="descname">visit_list</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#PythonToVapiVisitor.visit_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a list value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.ListType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_map">
|
||
|
|
<tt class="descname">visit_map</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#PythonToVapiVisitor.visit_map"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_map" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a python dict</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.MapType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_opaque">
|
||
|
|
<tt class="descname">visit_opaque</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#PythonToVapiVisitor.visit_opaque"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_opaque" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit an opaque value. Don’t do any conversion.</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.OpaqueType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_optional">
|
||
|
|
<tt class="descname">visit_optional</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#PythonToVapiVisitor.visit_optional"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_optional" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit an optional value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.OptionalType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_primitive">
|
||
|
|
<tt class="descname">visit_primitive</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#PythonToVapiVisitor.visit_primitive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_primitive" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a primitive type python value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.BindingType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_reference">
|
||
|
|
<tt class="descname">visit_reference</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#PythonToVapiVisitor.visit_reference"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_reference" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a reference 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">Parameters:</th><td class="field-body"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.ReferenceType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_set">
|
||
|
|
<tt class="descname">visit_set</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#PythonToVapiVisitor.visit_set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_set" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a python set</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.SetType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_struct">
|
||
|
|
<tt class="descname">visit_struct</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#PythonToVapiVisitor.visit_struct"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_struct" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a struct value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.StructType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_uri">
|
||
|
|
<tt class="descname">visit_uri</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#PythonToVapiVisitor.visit_uri"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_uri" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit an URI value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.UriType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_void">
|
||
|
|
<tt class="descname">visit_void</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#PythonToVapiVisitor.visit_void"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.PythonToVapiVisitor.visit_void" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a void value (i.e. None)</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.VoidType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.TypeConverter">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.converter.</tt><tt class="descname">TypeConverter</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#TypeConverter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.TypeConverter" 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>Converter class that converts values from vAPI data model to Python native
|
||
|
|
data model</p>
|
||
|
|
<dl class="staticmethod">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.TypeConverter.convert_to_python">
|
||
|
|
<em class="property">static </em><tt class="descname">convert_to_python</tt><big>(</big><em>vapi_val</em>, <em>binding_type</em>, <em>resolver=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#TypeConverter.convert_to_python"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.TypeConverter.convert_to_python" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Converts vAPI DataValue to Python native value</p>
|
||
|
|
<table class="docutils field-list" 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 simple">
|
||
|
|
<li><strong>vapi_val</strong> (<a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.DataValue" title="vmware.vapi.data.value.DataValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.DataValue</span></tt></a>) – vAPI DataValue to be converted</li>
|
||
|
|
<li><strong>binding_type</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a>) – BindingType for the value</li>
|
||
|
|
<li><strong>resolver</strong> (<a class="reference internal" href="#vmware.vapi.bindings.common.NameToTypeResolver" title="vmware.vapi.bindings.common.NameToTypeResolver"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.common.NameToTypeResolver</span></tt></a> or
|
||
|
|
<tt class="docutils literal"><span class="pre">None</span></tt>) – Type resolver</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Python native value</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="staticmethod">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.TypeConverter.convert_to_vapi">
|
||
|
|
<em class="property">static </em><tt class="descname">convert_to_vapi</tt><big>(</big><em>py_val</em>, <em>binding_type</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#TypeConverter.convert_to_vapi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.TypeConverter.convert_to_vapi" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Converts Python native value to vAPI DataValue</p>
|
||
|
|
<table class="docutils field-list" 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 simple">
|
||
|
|
<li><strong>py_val</strong> (<tt class="xref py py-class docutils literal"><span class="pre">object</span></tt>) – Python native value to be converted</li>
|
||
|
|
<li><strong>binding_type</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a>) – BindingType for the value</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.DataValue" title="vmware.vapi.data.value.DataValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.DataValue</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">vAPI DataValue</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.VapiToPythonVisitor">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.converter.</tt><tt class="descname">VapiToPythonVisitor</tt><big>(</big><em>value</em>, <em>resolver</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#VapiToPythonVisitor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.VapiToPythonVisitor" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingTypeVisitor" title="vmware.vapi.bindings.type.BindingTypeVisitor"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingTypeVisitor</span></tt></a></p>
|
||
|
|
<p>Visitor to convert from vAPI DataValue to Python native value</p>
|
||
|
|
<p>Initialize VapiToPythonVisitor</p>
|
||
|
|
<table class="docutils field-list" 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>value</strong> (<a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.DataValue" title="vmware.vapi.data.value.DataValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.DataValue</span></tt></a>) – vAPI DataValue to be converted</li>
|
||
|
|
<li><strong>resolver</strong> (<a class="reference internal" href="#vmware.vapi.bindings.common.NameToTypeResolver" title="vmware.vapi.bindings.common.NameToTypeResolver"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.common.NameToTypeResolver</span></tt></a> or
|
||
|
|
<tt class="docutils literal"><span class="pre">None</span></tt>) – Type resolver</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.VapiToPythonVisitor.get_out_value">
|
||
|
|
<tt class="descname">get_out_value</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#VapiToPythonVisitor.get_out_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.VapiToPythonVisitor.get_out_value" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the Python native value converted from the vAPI DataValue</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Native python value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.VapiToPythonVisitor.visit">
|
||
|
|
<tt class="descname">visit</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#VapiToPythonVisitor.visit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.VapiToPythonVisitor.visit" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_any_error">
|
||
|
|
<tt class="descname">visit_any_error</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#VapiToPythonVisitor.visit_any_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_any_error" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit ErrorValue to convert it into the base VapiError</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.AnyErrorType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_date_time">
|
||
|
|
<tt class="descname">visit_date_time</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#VapiToPythonVisitor.visit_date_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_date_time" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a datetime value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.DateTimeType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_dynamic_struct">
|
||
|
|
<tt class="descname">visit_dynamic_struct</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#VapiToPythonVisitor.visit_dynamic_struct"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_dynamic_struct" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit StructValue to convert it into the base VapiStruct</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.DynamicStructType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_enum">
|
||
|
|
<tt class="descname">visit_enum</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#VapiToPythonVisitor.visit_enum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_enum" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit an Enum value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.EnumType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_error">
|
||
|
|
<tt class="descname">visit_error</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#VapiToPythonVisitor.visit_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_error" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit ErrorValue</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.ErrorType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_list">
|
||
|
|
<tt class="descname">visit_list</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#VapiToPythonVisitor.visit_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a ListValue</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.ListType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_map">
|
||
|
|
<tt class="descname">visit_map</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#VapiToPythonVisitor.visit_map"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_map" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a List Value. This ListValue must represent a map. Each element
|
||
|
|
of the ListValue is a StructValue with two fields, namely ‘key’ and ‘value’.
|
||
|
|
The ‘key’ field represents the key of the map and the ‘value’ field
|
||
|
|
represents the value of the map. Also, since this represents a map, there
|
||
|
|
should not be duplicate keys.</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.MapType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_opaque">
|
||
|
|
<tt class="descname">visit_opaque</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#VapiToPythonVisitor.visit_opaque"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_opaque" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Since there is no OpaqueValue, don’t do any conversion</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.OpaqueType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_optional">
|
||
|
|
<tt class="descname">visit_optional</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#VapiToPythonVisitor.visit_optional"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_optional" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit OptionalValue</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.OptionalType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_primitive">
|
||
|
|
<tt class="descname">visit_primitive</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#VapiToPythonVisitor.visit_primitive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_primitive" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit one of the primitive DataValues</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.BindingType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_reference">
|
||
|
|
<tt class="descname">visit_reference</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#VapiToPythonVisitor.visit_reference"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_reference" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a reference 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">Parameters:</th><td class="field-body"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.ReferenceType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_set">
|
||
|
|
<tt class="descname">visit_set</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#VapiToPythonVisitor.visit_set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_set" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a List Value. This ListValue must represent a set i.e. there must not be any duplicate 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">Parameters:</th><td class="field-body"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.SetType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_string">
|
||
|
|
<tt class="descname">visit_string</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#VapiToPythonVisitor.visit_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_string" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit StringValue</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.StringType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_struct">
|
||
|
|
<tt class="descname">visit_struct</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#VapiToPythonVisitor.visit_struct"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_struct" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit StructValue</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.StructType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_uri">
|
||
|
|
<tt class="descname">visit_uri</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#VapiToPythonVisitor.visit_uri"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_uri" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit an URI value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.UriType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_void">
|
||
|
|
<tt class="descname">visit_void</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/converter.html#VapiToPythonVisitor.visit_void"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.converter.VapiToPythonVisitor.visit_void" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Since there is no VoidValue, just return None</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.VoidType</span></tt>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-vmware.vapi.bindings.datetime_helper">
|
||
|
|
<span id="datetime-helper-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">datetime_helper</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.bindings.datetime_helper" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Utility library for converting to/from datetime objects in Python Bindings</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.datetime_helper.DateTimeConverter">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.datetime_helper.</tt><tt class="descname">DateTimeConverter</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/datetime_helper.html#DateTimeConverter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.datetime_helper.DateTimeConverter" 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>Helper class to convert to/from Python datetime strings to
|
||
|
|
datetime objects.</p>
|
||
|
|
<p>Datetime is represented as <a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.StringValue" title="vmware.vapi.data.value.StringValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.StringValue</span></tt></a> in the
|
||
|
|
vAPI Runtime. Datetime is a primitive string that follows a subset of
|
||
|
|
ISO 8601. DateTime string represents a complete date plus hours, minutes,
|
||
|
|
seconds and a decimal fraction of a second:</p>
|
||
|
|
<blockquote>
|
||
|
|
<div><p>YYYY-MM-DDThh:mm:ss.sssZ (e.g. 1878-03-03T19:20:30.000Z)
|
||
|
|
where:</p>
|
||
|
|
<blockquote>
|
||
|
|
<div><dl class="docutils">
|
||
|
|
<dt>YYYY = four-digit year (years BC are not supported;</dt>
|
||
|
|
<dd>0001 = 1 AD is the first valid year,
|
||
|
|
0000 = 1 BC is not allowed)</dd>
|
||
|
|
</dl>
|
||
|
|
<p>MM = two-digit month (01=January, ..., 12=December)
|
||
|
|
DD = two-digit day of month (01 through 31)
|
||
|
|
“T” = separator; appears literally in the string
|
||
|
|
hh = two digits of hour (00 through 23; 24 NOT allowed;</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>am/pm NOT allowed)</div></blockquote>
|
||
|
|
<p>mm = two digits of minute (00 through 59)
|
||
|
|
ss = two digits of second (00 through 59)
|
||
|
|
sss = exactly three digits representing milliseconds
|
||
|
|
“Z” = UTC time zone designator; appears literally in the string</p>
|
||
|
|
</div></blockquote>
|
||
|
|
</div></blockquote>
|
||
|
|
<dl class="staticmethod">
|
||
|
|
<dt id="vmware.vapi.bindings.datetime_helper.DateTimeConverter.convert_from_datetime">
|
||
|
|
<em class="property">static </em><tt class="descname">convert_from_datetime</tt><big>(</big><em>datetime_obj</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/datetime_helper.html#DateTimeConverter.convert_from_datetime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.datetime_helper.DateTimeConverter.convert_from_datetime" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Convert from Python native datetime object to the datetime format in
|
||
|
|
vAPI Runtime i.e. YYYY-MM-DDThh:mm:ss.sssZ.</p>
|
||
|
|
<p>datetime objects returned by datetime.now() or datetime.utcnow() does
|
||
|
|
not contain any timezone information. The caller to this method should
|
||
|
|
only pass datetime objects that have time in UTC timezone.</p>
|
||
|
|
<p>datetime objects have microsecond precision but the vAPI datetime
|
||
|
|
string format has millisecond precision. The method will truncate the
|
||
|
|
microsecond to millisecond and won’t do any rounding of the value.</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>datetime_obj</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt>) – Datetime object with UTC time</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">String representation of the input datetime object</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="staticmethod">
|
||
|
|
<dt id="vmware.vapi.bindings.datetime_helper.DateTimeConverter.convert_to_datetime">
|
||
|
|
<em class="property">static </em><tt class="descname">convert_to_datetime</tt><big>(</big><em>datetime_str</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/datetime_helper.html#DateTimeConverter.convert_to_datetime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.datetime_helper.DateTimeConverter.convert_to_datetime" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Parse ISO 8601 date time from string.</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>datetime_str</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Datetime in string representation that is in
|
||
|
|
YYYY-MM-DDThh:mm:ss.sssZ format</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Datetime object</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.datetime_helper.UTC">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.datetime_helper.</tt><tt class="descname">UTC</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/datetime_helper.html#UTC"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.datetime_helper.UTC" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">datetime.tzinfo</span></tt></p>
|
||
|
|
<p>tzinfo class for UTC timezone</p>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.datetime_helper.UTC.dst">
|
||
|
|
<tt class="descname">dst</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/datetime_helper.html#UTC.dst"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.datetime_helper.UTC.dst" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.datetime_helper.UTC.tzname">
|
||
|
|
<tt class="descname">tzname</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/datetime_helper.html#UTC.tzname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.datetime_helper.UTC.tzname" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.datetime_helper.UTC.utcoffset">
|
||
|
|
<tt class="descname">utcoffset</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/datetime_helper.html#UTC.utcoffset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.datetime_helper.UTC.utcoffset" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="function">
|
||
|
|
<dt id="vmware.vapi.bindings.datetime_helper.convert_to_utc">
|
||
|
|
<tt class="descclassname">vmware.vapi.bindings.datetime_helper.</tt><tt class="descname">convert_to_utc</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/datetime_helper.html#convert_to_utc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.datetime_helper.convert_to_utc" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Convert a given datetime object to UTC timezone</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-vmware.vapi.bindings.enum">
|
||
|
|
<span id="enum-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">enum</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.bindings.enum" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Bindings data classes</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.enum.Enum">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.enum.</tt><tt class="descname">Enum</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/enum.html#Enum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.enum.Enum" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></p>
|
||
|
|
<p>Representation of IDL Enum in python language bindings</p>
|
||
|
|
<dl class="classmethod">
|
||
|
|
<dt id="vmware.vapi.bindings.enum.Enum.get_binding_type">
|
||
|
|
<em class="property">classmethod </em><tt class="descname">get_binding_type</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/enum.html#Enum.get_binding_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.enum.Enum.get_binding_type" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the corresponding BindingType for the VapiStruct class</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.BindingType</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">BindingType for this VapiStruct</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-vmware.vapi.bindings.error">
|
||
|
|
<span id="error-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">error</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.bindings.error" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Error classes and factory</p>
|
||
|
|
<dl class="exception">
|
||
|
|
<dt id="vmware.vapi.bindings.error.UnresolvedError">
|
||
|
|
<em class="property">exception </em><tt class="descclassname">vmware.vapi.bindings.error.</tt><tt class="descname">UnresolvedError</tt><big>(</big><em>mappings=None</em>, <em>error_value=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/error.html#UnresolvedError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.error.UnresolvedError" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.error.VapiError" title="vmware.vapi.bindings.error.VapiError"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.error.VapiError</span></tt></a></p>
|
||
|
|
<p>VapiError which represents a VMODL2 error that was reported but couldn’t
|
||
|
|
be resolved</p>
|
||
|
|
<p>Initialize VapiError</p>
|
||
|
|
<table class="docutils field-list" 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>mappings</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> or <tt class="xref py py-class docutils literal"><span class="pre">None</span></tt>) – A mapping for all field names whose IDL name does
|
||
|
|
not match PEP8 standard name</li>
|
||
|
|
<li><strong>error_value</strong> (<a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.ErrorValue" title="vmware.vapi.data.value.ErrorValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.ErrorValue</span></tt></a> or
|
||
|
|
<tt class="xref py py-class docutils literal"><span class="pre">None</span></tt>) – ErrorValue to be used for VapiError</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="exception">
|
||
|
|
<dt id="vmware.vapi.bindings.error.VapiError">
|
||
|
|
<em class="property">exception </em><tt class="descclassname">vmware.vapi.bindings.error.</tt><tt class="descname">VapiError</tt><big>(</big><em>mappings=None</em>, <em>error_value=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/error.html#VapiError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.error.VapiError" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>, <tt class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></tt></p>
|
||
|
|
<p>Representation of VMODL Error in python language bindings</p>
|
||
|
|
<p>Initialize VapiError</p>
|
||
|
|
<table class="docutils field-list" 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>mappings</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> or <tt class="xref py py-class docutils literal"><span class="pre">None</span></tt>) – A mapping for all field names whose IDL name does
|
||
|
|
not match PEP8 standard name</li>
|
||
|
|
<li><strong>error_value</strong> (<a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.ErrorValue" title="vmware.vapi.data.value.ErrorValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.ErrorValue</span></tt></a> or
|
||
|
|
<tt class="xref py py-class docutils literal"><span class="pre">None</span></tt>) – ErrorValue to be used for VapiError</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.error.VapiError.get_error_value">
|
||
|
|
<tt class="descname">get_error_value</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/error.html#VapiError.get_error_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.error.VapiError.get_error_value" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the corresponding ErrorValue for the VapiError class</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.ErrorValue" title="vmware.vapi.data.value.ErrorValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.ErrorValue</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ErrorValue for this VapiError</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-vmware.vapi.bindings.message">
|
||
|
|
<span id="message-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">message</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.bindings.message" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Message Factory import for the bindings to use</p>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-vmware.vapi.bindings.skeleton">
|
||
|
|
<span id="skeleton-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">skeleton</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.bindings.skeleton" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Skeleton helper classes</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.skeleton.</tt><tt class="descname">ApiInterfaceSkeleton</tt><big>(</big><em>iface_name</em>, <em>impl</em>, <em>operations</em>, <em>error_types</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/skeleton.html#ApiInterfaceSkeleton"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.ApiInterface" title="vmware.vapi.core.ApiInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.core.ApiInterface</span></tt></a></p>
|
||
|
|
<p>Skeleton class for <tt class="xref py py-class docutils literal"><span class="pre">ApiInterface</span></tt>. This class implements the
|
||
|
|
<tt class="xref py py-class docutils literal"><span class="pre">ApiInterface</span></tt> interface.</p>
|
||
|
|
<p>Initialize the ApiInterface skeleton class</p>
|
||
|
|
<table class="docutils field-list" 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>iface_name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Interface name</li>
|
||
|
|
<li><strong>impl</strong> (<a class="reference internal" href="#vmware.vapi.bindings.skeleton.VapiInterface" title="vmware.vapi.bindings.skeleton.VapiInterface"><tt class="xref py py-class docutils literal"><span class="pre">VapiInterface</span></tt></a>) – Class that implements this interface</li>
|
||
|
|
<li><strong>operations</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt>) – Description of the operations in this service</li>
|
||
|
|
<li><strong>error_types</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#vmware.vapi.bindings.type.ErrorType" title="vmware.vapi.bindings.type.ErrorType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.ErrorType</span></tt></a>) – error types to be registered in this configuration</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="classmethod">
|
||
|
|
<dt id="vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton.check_for_unknown_fields">
|
||
|
|
<em class="property">classmethod </em><tt class="descname">check_for_unknown_fields</tt><big>(</big><em>value_type</em>, <em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/skeleton.html#ApiInterfaceSkeleton.check_for_unknown_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton.check_for_unknown_fields" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Check if the StructValues inside the input DataValue has any
|
||
|
|
unknown fields</p>
|
||
|
|
<table class="docutils field-list" 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 simple">
|
||
|
|
<li><strong>value_type</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a>) – Binding Type</li>
|
||
|
|
<li><strong>value</strong> (<a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.DataValue" title="vmware.vapi.data.value.DataValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.DataValue</span></tt></a>) – DataValue</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.ErrorValue" title="vmware.vapi.data.value.ErrorValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.ErrorValue</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">ErrorValue describing the unknown fields or None if no
|
||
|
|
unknown fields were found</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton.get_definition">
|
||
|
|
<tt class="descname">get_definition</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/skeleton.html#ApiInterfaceSkeleton.get_definition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton.get_definition" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton.get_identifier">
|
||
|
|
<tt class="descname">get_identifier</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/skeleton.html#ApiInterfaceSkeleton.get_identifier"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton.get_identifier" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton.get_method_definition">
|
||
|
|
<tt class="descname">get_method_definition</tt><big>(</big><em>method_id</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/skeleton.html#ApiInterfaceSkeleton.get_method_definition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton.get_method_definition" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton.invoke">
|
||
|
|
<tt class="descname">invoke</tt><big>(</big><em>ctx</em>, <em>method_id</em>, <em>input_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/skeleton.html#ApiInterfaceSkeleton.invoke"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton.invoke" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Invokes the specified method using the execution context and
|
||
|
|
the input provided</p>
|
||
|
|
<table class="docutils field-list" 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 simple">
|
||
|
|
<li><strong>ctx</strong> (<a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.ExecutionContext" title="vmware.vapi.core.ExecutionContext"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.core.ExecutionContext</span></tt></a>) – Execution context for this method</li>
|
||
|
|
<li><strong>input_value</strong> (<a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.StructValue" title="vmware.vapi.data.value.StructValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.StructValue</span></tt></a>) – Method input parameters</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.MethodResult" title="vmware.vapi.core.MethodResult"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.core.MethodResult</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Result of the method invocation</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.skeleton.VapiFilter">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.skeleton.</tt><tt class="descname">VapiFilter</tt><big>(</big><em>name=''</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/skeleton.html#VapiFilter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.skeleton.VapiFilter" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">logging.Filter</span></tt></p>
|
||
|
|
<p>This is a filter that injects request context into the log</p>
|
||
|
|
<p>Initialize a filter.</p>
|
||
|
|
<p>Initialize with the name of the logger which, together with its
|
||
|
|
children, will have its events allowed through the filter. If no
|
||
|
|
name is specified, allow every event.</p>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.skeleton.VapiFilter.filter">
|
||
|
|
<tt class="descname">filter</tt><big>(</big><em>record</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/skeleton.html#VapiFilter.filter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.skeleton.VapiFilter.filter" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.skeleton.VapiInterface">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.skeleton.</tt><tt class="descname">VapiInterface</tt><big>(</big><em>api_interface</em>, <em>error_types=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/skeleton.html#VapiInterface"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.skeleton.VapiInterface" 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>vAPI Interface class is used by the python server side bindings. This
|
||
|
|
encapsulates the <a class="reference internal" href="#vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton" title="vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton</span></tt></a> class.</p>
|
||
|
|
<p>Initialize the VapiInterface class</p>
|
||
|
|
<table class="docutils field-list" 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>api_interface</strong> (<a class="reference internal" href="#vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton" title="vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton</span></tt></a>) – Api Interface skeleton class for this interface</li>
|
||
|
|
<li><strong>error_types</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#vmware.vapi.bindings.type.ErrorType" title="vmware.vapi.bindings.type.ErrorType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.ErrorType</span></tt></a>) – error types to be registered in this configuration</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.skeleton.VapiInterface.api_interface">
|
||
|
|
<tt class="descname">api_interface</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/skeleton.html#VapiInterface.api_interface"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.skeleton.VapiInterface.api_interface" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the ApiInterfaceSkeleton instance. Local Provider uses this
|
||
|
|
method to discover the ApiInterface so that it can route method calls
|
||
|
|
for the methods implemented by this 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">Return type:</th><td class="field-body"><a class="reference internal" href="#vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton" title="vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.skeleton.ApiInterfaceSkeleton</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Api Interface skeleton class for this interface</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.skeleton.VapiInterface.execution_context">
|
||
|
|
<tt class="descname">execution_context</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/skeleton.html#VapiInterface.execution_context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.skeleton.VapiInterface.execution_context" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the execution context of a method invocation</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.ExecutionContext" title="vmware.vapi.core.ExecutionContext"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.core.ExecutionContext</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Execution context of a method invocation</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-vmware.vapi.bindings.struct">
|
||
|
|
<span id="struct-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">struct</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.bindings.struct" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Bindings data classes</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.struct.PrettyPrinter">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.struct.</tt><tt class="descname">PrettyPrinter</tt><big>(</big><em>stream=<open file '<stdout>'</em>, <em>mode 'w' at 0xf65bd070></em>, <em>indent=2</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/struct.html#PrettyPrinter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.struct.PrettyPrinter" 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>Helper class to Pretty print VapiStruct objects</p>
|
||
|
|
<p>Initialize PrettyPrinter</p>
|
||
|
|
<table class="docutils field-list" 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>stream</strong> (<tt class="xref py py-class docutils literal"><span class="pre">object</span></tt>) – A stream object that implements File protocol’s
|
||
|
|
write operation</li>
|
||
|
|
<li><strong>indent</strong> (<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) – Indentation to be used for new lines</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.struct.PrettyPrinter.pprint">
|
||
|
|
<tt class="descname">pprint</tt><big>(</big><em>value</em>, <em>level=0</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/struct.html#PrettyPrinter.pprint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.struct.PrettyPrinter.pprint" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Print a vAPI native struct value</p>
|
||
|
|
<table class="docutils field-list" 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>value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – VapiStruct to be pretty printed</li>
|
||
|
|
<li><strong>level</strong> (<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt>) – Indentation level</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.struct.VapiStruct">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.struct.</tt><tt class="descname">VapiStruct</tt><big>(</big><em>mappings=None</em>, <em>struct_value=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/struct.html#VapiStruct"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.struct.VapiStruct" 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>Representation of IDL Structure in python language bindings</p>
|
||
|
|
<p>Initialize VapiStruct</p>
|
||
|
|
<table class="docutils field-list" 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>mappings</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> or <tt class="xref py py-class docutils literal"><span class="pre">None</span></tt>) – A mapping for all field names whose IDL name does
|
||
|
|
not match PEP8 standard name</li>
|
||
|
|
<li><strong>struct_value</strong> (<a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.StructValue" title="vmware.vapi.data.value.StructValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.StructValue</span></tt></a>) – StructValue to be used for VapiStruct or <tt class="xref py py-class docutils literal"><span class="pre">None</span></tt></li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.struct.VapiStruct.convert_to">
|
||
|
|
<tt class="descname">convert_to</tt><big>(</big><em>cls</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/struct.html#VapiStruct.convert_to"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.struct.VapiStruct.convert_to" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Convert the underlying StructValue to an instance of the provided class
|
||
|
|
if possible. Conversion will be possible if the StructValue contains
|
||
|
|
all the fields expected by the provided class and the type of the value
|
||
|
|
in each fields matches the type of the field expected by the provided
|
||
|
|
class.</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>cls</strong> (<a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.StructValue" title="vmware.vapi.data.value.StructValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.StructValue</span></tt></a>) – The type to convert to</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">:class:’vmware.vapi.bindings.struct.VapiStruct’</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The converted value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="classmethod">
|
||
|
|
<dt id="vmware.vapi.bindings.struct.VapiStruct.get_binding_type">
|
||
|
|
<em class="property">classmethod </em><tt class="descname">get_binding_type</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/struct.html#VapiStruct.get_binding_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.struct.VapiStruct.get_binding_type" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the corresponding BindingType for the VapiStruct class</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">BindingType for this VapiStruct</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.struct.VapiStruct.get_field">
|
||
|
|
<tt class="descname">get_field</tt><big>(</big><em>attr</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/struct.html#VapiStruct.get_field"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.struct.VapiStruct.get_field" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the struct field value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>attr</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Field name as defined in IDL</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Field value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.struct.VapiStruct.get_struct_value">
|
||
|
|
<tt class="descname">get_struct_value</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/struct.html#VapiStruct.get_struct_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.struct.VapiStruct.get_struct_value" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the corresponding StructValue for the VapiStruct class</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.StructValue" title="vmware.vapi.data.value.StructValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.StructValue</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">StructValue for this VapiStruct</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.struct.VapiStruct.validate_constraints">
|
||
|
|
<tt class="descname">validate_constraints</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/struct.html#VapiStruct.validate_constraints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.struct.VapiStruct.validate_constraints" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Validate if the current VapiStruct instance satisfies all the
|
||
|
|
constraints of this VapiStruct type.</p>
|
||
|
|
<dl class="docutils">
|
||
|
|
<dt>:raise <a class="reference internal" href="vmware.vapi.html#vmware.vapi.exception.CoreException" title="vmware.vapi.exception.CoreException"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.exception.CoreException</span></tt></a> if a constraint is</dt>
|
||
|
|
<dd>not satisfied</dd>
|
||
|
|
</dl>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="classmethod">
|
||
|
|
<dt id="vmware.vapi.bindings.struct.VapiStruct.validate_struct_value">
|
||
|
|
<em class="property">classmethod </em><tt class="descname">validate_struct_value</tt><big>(</big><em>struct_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/struct.html#VapiStruct.validate_struct_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.struct.VapiStruct.validate_struct_value" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Validate if the given struct value satisfies all
|
||
|
|
the constraints of this VapiStruct.</p>
|
||
|
|
<table class="docutils field-list" 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>struct_value</strong> (<a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.StructValue" title="vmware.vapi.data.value.StructValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.StructValue</span></tt></a>) – StructValue to be validated</li>
|
||
|
|
<li><strong>validators</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.validator.Validator" title="vmware.vapi.data.validator.Validator"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.validator.Validator</span></tt></a>) – List of validators</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="docutils">
|
||
|
|
<dt>:raise <a class="reference internal" href="vmware.vapi.html#vmware.vapi.exception.CoreException" title="vmware.vapi.exception.CoreException"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.exception.CoreException</span></tt></a> if a constraint is</dt>
|
||
|
|
<dd>not satisfied</dd>
|
||
|
|
</dl>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-vmware.vapi.bindings.stub">
|
||
|
|
<span id="stub-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">stub</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.bindings.stub" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Stub helper classes</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.stub.ApiInterfaceStub">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.stub.</tt><tt class="descname">ApiInterfaceStub</tt><big>(</big><em>iface_name</em>, <em>config</em>, <em>operations</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/stub.html#ApiInterfaceStub"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.stub.ApiInterfaceStub" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.ApiInterface" title="vmware.vapi.core.ApiInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.core.ApiInterface</span></tt></a></p>
|
||
|
|
<p>Stub class for Api Interface</p>
|
||
|
|
<p>Initialize the ApiMethod skeleton object</p>
|
||
|
|
<table class="docutils field-list" 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>iface_name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Interface name</li>
|
||
|
|
<li><strong>config</strong> (<a class="reference internal" href="#vmware.vapi.bindings.stub.StubConfiguration" title="vmware.vapi.bindings.stub.StubConfiguration"><tt class="xref py py-class docutils literal"><span class="pre">StubConfiguration</span></tt></a>) – Configuration data for vAPI stubs</li>
|
||
|
|
<li><strong>operations</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt>) – Dictionary of operation name to operation information</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.stub.ApiInterfaceStub.get_definition">
|
||
|
|
<tt class="descname">get_definition</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/stub.html#ApiInterfaceStub.get_definition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.stub.ApiInterfaceStub.get_definition" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns interface definition</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">InterfaceDefinition</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Interface definition</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.stub.ApiInterfaceStub.get_identifier">
|
||
|
|
<tt class="descname">get_identifier</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/stub.html#ApiInterfaceStub.get_identifier"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.stub.ApiInterfaceStub.get_identifier" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns interface identifier</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">InterfaceIdentifier</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Interface identifier</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.stub.ApiInterfaceStub.get_method_definition">
|
||
|
|
<tt class="descname">get_method_definition</tt><big>(</big><em>method_id</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/stub.html#ApiInterfaceStub.get_method_definition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.stub.ApiInterfaceStub.get_method_definition" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.stub.ApiInterfaceStub.invoke">
|
||
|
|
<tt class="descname">invoke</tt><big>(</big><em>ctx</em>, <em>method_id</em>, <em>input_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/stub.html#ApiInterfaceStub.invoke"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.stub.ApiInterfaceStub.invoke" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Invokes the specified method using the execution context and
|
||
|
|
the input provided</p>
|
||
|
|
<table class="docutils field-list" 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 simple">
|
||
|
|
<li><strong>ctx</strong> (<a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.ExecutionContext" title="vmware.vapi.core.ExecutionContext"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.core.ExecutionContext</span></tt></a>) – Execution context for this method</li>
|
||
|
|
<li><strong>method_id</strong> (<a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.MethodIdentifier" title="vmware.vapi.core.MethodIdentifier"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.core.MethodIdentifier</span></tt></a>) – Method identifier</li>
|
||
|
|
<li><strong>input_value</strong> (<a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.StructValue" title="vmware.vapi.data.value.StructValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.StructValue</span></tt></a>) – Method input parameters</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="vmware.vapi.html#vmware.vapi.core.MethodResult" title="vmware.vapi.core.MethodResult"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.core.MethodResult</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Result of the method invocation</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.stub.ApiInterfaceStub.native_invoke">
|
||
|
|
<tt class="descname">native_invoke</tt><big>(</big><em>ctx</em>, <em>method_name</em>, <em>kwargs</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/stub.html#ApiInterfaceStub.native_invoke"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.stub.ApiInterfaceStub.native_invoke" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Invokes the method corresponding to the given method name
|
||
|
|
with the kwargs.</p>
|
||
|
|
<p>In this method, python native values are converted to vAPI runtime values,
|
||
|
|
operation is invoked and the result are converted back to python native
|
||
|
|
values</p>
|
||
|
|
<table class="docutils field-list" 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 simple">
|
||
|
|
<li><strong>method_name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Method name</li>
|
||
|
|
<li><strong>kwargs</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt>) – arguments to be passed to the method</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Method result</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.stub.StubConfiguration">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.stub.</tt><tt class="descname">StubConfiguration</tt><big>(</big><em>connector</em>, <em>*error_types</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/stub.html#StubConfiguration"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.stub.StubConfiguration" 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>Configuration data for vAPI stub classes</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>connector</strong> – Connection to be used to talk to the remote ApiProvider</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>Initialize the stub configuration</p>
|
||
|
|
<table class="docutils field-list" 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> (<a class="reference internal" href="vmware.vapi.protocol.client.html#vmware.vapi.protocol.client.connector.Connector" title="vmware.vapi.protocol.client.connector.Connector"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.client.connector.Connector</span></tt></a>) – 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 <a class="reference internal" href="#vmware.vapi.bindings.type.ErrorType" title="vmware.vapi.bindings.type.ErrorType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.ErrorType</span></tt></a>) – error types to be registered in this configuration</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.stub.StubConfiguration.connector">
|
||
|
|
<tt class="descname">connector</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/stub.html#StubConfiguration.connector"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.stub.StubConfiguration.connector" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="vmware.vapi.protocol.client.html#vmware.vapi.protocol.client.connector.Connector" title="vmware.vapi.protocol.client.connector.Connector"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.protocol.client.connector.Connector</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Connection to be used to talk to the remote ApiProvider</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.stub.StubConfiguration.resolver">
|
||
|
|
<tt class="descname">resolver</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/stub.html#StubConfiguration.resolver"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.stub.StubConfiguration.resolver" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Type resolver that can resolve canonical names to its binding 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">Return type:</th><td class="field-body"><a class="reference internal" href="#vmware.vapi.bindings.common.NameToTypeResolver" title="vmware.vapi.bindings.common.NameToTypeResolver"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.common.NameToTypeResolver</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Type resolver</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.stub.StubFactory">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.stub.</tt><tt class="descname">StubFactory</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/stub.html#StubFactory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.stub.StubFactory" 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 for client-side vAPI stubs</p>
|
||
|
|
<p>Initialize the stub factory</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>config</strong> (<a class="reference internal" href="#vmware.vapi.bindings.stub.StubConfiguration" title="vmware.vapi.bindings.stub.StubConfiguration"><tt class="xref py py-class docutils literal"><span class="pre">StubConfiguration</span></tt></a>) – Configuration data for vAPI stubs</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.stub.StubFactory.create_stub">
|
||
|
|
<tt class="descname">create_stub</tt><big>(</big><em>service_name</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/stub.html#StubFactory.create_stub"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.stub.StubFactory.create_stub" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Create a stub corresponding to the specified service 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">Parameters:</th><td class="field-body"><strong>service_name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the service</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#vmware.vapi.bindings.stub.VapiInterface" title="vmware.vapi.bindings.stub.VapiInterface"><tt class="xref py py-class docutils literal"><span class="pre">VapiInterface</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The stub correspoding to the specified service name</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.stub.VapiInterface">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.stub.</tt><tt class="descname">VapiInterface</tt><big>(</big><em>config</em>, <em>api_interface</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/stub.html#VapiInterface"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.stub.VapiInterface" 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>vAPI Interface class is used by the python client side bindings. This
|
||
|
|
encapsulates the ApiInterfaceStub instance</p>
|
||
|
|
<p>Initialize VapiInterface object</p>
|
||
|
|
<table class="docutils field-list" 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>config</strong> (<a class="reference internal" href="#vmware.vapi.bindings.stub.StubConfiguration" title="vmware.vapi.bindings.stub.StubConfiguration"><tt class="xref py py-class docutils literal"><span class="pre">StubConfiguration</span></tt></a>) – Configuration data for vAPI stubs</li>
|
||
|
|
<li><strong>api_interface</strong> (<a class="reference internal" href="#vmware.vapi.bindings.stub.ApiInterfaceStub" title="vmware.vapi.bindings.stub.ApiInterfaceStub"><tt class="xref py py-class docutils literal"><span class="pre">ApiInterfaceStub</span></tt></a>) – Instance of ApiInterfaceStub class that can
|
||
|
|
execute the ApiMethods</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-vmware.vapi.bindings.type">
|
||
|
|
<span id="type-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">type</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.bindings.type" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Representation of an IDL type for the use of the Python language bindings.</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.AnyErrorType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">AnyErrorType</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#AnyErrorType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.AnyErrorType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a></p>
|
||
|
|
<p>Representation of Exception type in Python Binding</p>
|
||
|
|
<p>Initialize AnyErrorType</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">BindingType</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingType" 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>Representation of an IDL type for the use of the Python language bindings</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>definition</strong> (<a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.definition.DataDefinition" title="vmware.vapi.data.definition.DataDefinition"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.definition.DataDefinition</span></tt></a>) – Data definition corresponding to this binding type</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingType.accept">
|
||
|
|
<tt class="descname">accept</tt><big>(</big><em>visitor</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingType.accept"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingType.accept" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Applies a visitor to this BindingType</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>visitor</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.BindingTypeVisitor" title="vmware.vapi.bindings.type.BindingTypeVisitor"><tt class="xref py py-class docutils literal"><span class="pre">BindingTypeVisitor</span></tt></a>) – visitor operating on the BindingType</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingType.definition">
|
||
|
|
<tt class="descname">definition</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingType.definition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingType.definition" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Generate the data defintion corresponding to this binding type</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingTypeVisitor">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">BindingTypeVisitor</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingTypeVisitor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingTypeVisitor" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.lib.html#vmware.vapi.lib.visitor.VapiVisitor" title="vmware.vapi.lib.visitor.VapiVisitor"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.lib.visitor.VapiVisitor</span></tt></a></p>
|
||
|
|
<p>Base no-op implementation of a BindingType visitor</p>
|
||
|
|
<p>Initialize BindingTypeVisitor</p>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingTypeVisitor.visit_any_error">
|
||
|
|
<tt class="descname">visit_any_error</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingTypeVisitor.visit_any_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingTypeVisitor.visit_any_error" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit an error value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.AnyErrorType" title="vmware.vapi.bindings.type.AnyErrorType"><tt class="xref py py-class docutils literal"><span class="pre">AnyErrorType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingTypeVisitor.visit_blob">
|
||
|
|
<tt class="descname">visit_blob</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingTypeVisitor.visit_blob"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingTypeVisitor.visit_blob" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a blob value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.BlobType" title="vmware.vapi.bindings.type.BlobType"><tt class="xref py py-class docutils literal"><span class="pre">BlobType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingTypeVisitor.visit_boolean">
|
||
|
|
<tt class="descname">visit_boolean</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingTypeVisitor.visit_boolean"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingTypeVisitor.visit_boolean" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a boolean value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.BooleanType" title="vmware.vapi.bindings.type.BooleanType"><tt class="xref py py-class docutils literal"><span class="pre">BooleanType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingTypeVisitor.visit_date_time">
|
||
|
|
<tt class="descname">visit_date_time</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingTypeVisitor.visit_date_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingTypeVisitor.visit_date_time" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a datetime value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.DateTimeType" title="vmware.vapi.bindings.type.DateTimeType"><tt class="xref py py-class docutils literal"><span class="pre">DateTimeType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingTypeVisitor.visit_double">
|
||
|
|
<tt class="descname">visit_double</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingTypeVisitor.visit_double"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingTypeVisitor.visit_double" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a double value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.DoubleType" title="vmware.vapi.bindings.type.DoubleType"><tt class="xref py py-class docutils literal"><span class="pre">DoubleType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingTypeVisitor.visit_dynamic_struct">
|
||
|
|
<tt class="descname">visit_dynamic_struct</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingTypeVisitor.visit_dynamic_struct"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingTypeVisitor.visit_dynamic_struct" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a struct value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.DynamicStructType" title="vmware.vapi.bindings.type.DynamicStructType"><tt class="xref py py-class docutils literal"><span class="pre">DynamicStructType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingTypeVisitor.visit_enum">
|
||
|
|
<tt class="descname">visit_enum</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingTypeVisitor.visit_enum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingTypeVisitor.visit_enum" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a enum value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.EnumType" title="vmware.vapi.bindings.type.EnumType"><tt class="xref py py-class docutils literal"><span class="pre">EnumType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingTypeVisitor.visit_error">
|
||
|
|
<tt class="descname">visit_error</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingTypeVisitor.visit_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingTypeVisitor.visit_error" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit an error 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">Parameters:</th><td class="field-body"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.ErrorType" title="vmware.vapi.bindings.type.ErrorType"><tt class="xref py py-class docutils literal"><span class="pre">ErrorType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingTypeVisitor.visit_id">
|
||
|
|
<tt class="descname">visit_id</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingTypeVisitor.visit_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingTypeVisitor.visit_id" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a ID value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.IdType" title="vmware.vapi.bindings.type.IdType"><tt class="xref py py-class docutils literal"><span class="pre">IdType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingTypeVisitor.visit_integer">
|
||
|
|
<tt class="descname">visit_integer</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingTypeVisitor.visit_integer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingTypeVisitor.visit_integer" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit an integer value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.IntegerType" title="vmware.vapi.bindings.type.IntegerType"><tt class="xref py py-class docutils literal"><span class="pre">IntegerType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingTypeVisitor.visit_list">
|
||
|
|
<tt class="descname">visit_list</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingTypeVisitor.visit_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingTypeVisitor.visit_list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a list value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.ListType" title="vmware.vapi.bindings.type.ListType"><tt class="xref py py-class docutils literal"><span class="pre">ListType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingTypeVisitor.visit_opaque">
|
||
|
|
<tt class="descname">visit_opaque</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingTypeVisitor.visit_opaque"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingTypeVisitor.visit_opaque" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit an opaque value.</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.OpaqueType" title="vmware.vapi.bindings.type.OpaqueType"><tt class="xref py py-class docutils literal"><span class="pre">OpaqueType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingTypeVisitor.visit_optional">
|
||
|
|
<tt class="descname">visit_optional</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingTypeVisitor.visit_optional"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingTypeVisitor.visit_optional" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit an optional value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.OptionalType" title="vmware.vapi.bindings.type.OptionalType"><tt class="xref py py-class docutils literal"><span class="pre">OptionalType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingTypeVisitor.visit_reference">
|
||
|
|
<tt class="descname">visit_reference</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingTypeVisitor.visit_reference"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingTypeVisitor.visit_reference" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a reference 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">Parameters:</th><td class="field-body"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.ReferenceType" title="vmware.vapi.bindings.type.ReferenceType"><tt class="xref py py-class docutils literal"><span class="pre">ReferenceType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingTypeVisitor.visit_secret">
|
||
|
|
<tt class="descname">visit_secret</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingTypeVisitor.visit_secret"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingTypeVisitor.visit_secret" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a secret value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.SecretType" title="vmware.vapi.bindings.type.SecretType"><tt class="xref py py-class docutils literal"><span class="pre">SecretType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingTypeVisitor.visit_string">
|
||
|
|
<tt class="descname">visit_string</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingTypeVisitor.visit_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingTypeVisitor.visit_string" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a string value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.StringType" title="vmware.vapi.bindings.type.StringType"><tt class="xref py py-class docutils literal"><span class="pre">StringType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingTypeVisitor.visit_struct">
|
||
|
|
<tt class="descname">visit_struct</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingTypeVisitor.visit_struct"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingTypeVisitor.visit_struct" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a struct value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.StructType" title="vmware.vapi.bindings.type.StructType"><tt class="xref py py-class docutils literal"><span class="pre">StructType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingTypeVisitor.visit_uri">
|
||
|
|
<tt class="descname">visit_uri</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingTypeVisitor.visit_uri"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingTypeVisitor.visit_uri" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit an URI value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.URIType" title="vmware.vapi.bindings.type.URIType"><tt class="xref py py-class docutils literal"><span class="pre">URIType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BindingTypeVisitor.visit_void">
|
||
|
|
<tt class="descname">visit_void</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BindingTypeVisitor.visit_void"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BindingTypeVisitor.visit_void" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a void value (i.e. None)</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.VoidType" title="vmware.vapi.bindings.type.VoidType"><tt class="xref py py-class docutils literal"><span class="pre">VoidType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BlobType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">BlobType</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BlobType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BlobType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a></p>
|
||
|
|
<p>Representation of binary IDL Type in Python Binding</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.BooleanType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">BooleanType</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#BooleanType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.BooleanType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a></p>
|
||
|
|
<p>Representation of boolean IDL Type in Python Binding</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">DataDefinitionBuilder</tt><big>(</big><em>ctx</em>, <em>seen_structures</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingTypeVisitor" title="vmware.vapi.bindings.type.BindingTypeVisitor"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingTypeVisitor</span></tt></a></p>
|
||
|
|
<p>Builds DataDefinition by visiting a BindingType</p>
|
||
|
|
<p>Initialize DataDefinitionBuilder</p>
|
||
|
|
<table class="docutils field-list" 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>ctx</strong> (<a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.definition.ReferenceResolver" title="vmware.vapi.data.definition.ReferenceResolver"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.definition.ReferenceResolver</span></tt></a>) – Data definition reference resolver object</li>
|
||
|
|
<li><strong>seen_structures</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> or <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – List of structures seen</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.get_out_value">
|
||
|
|
<tt class="descname">get_out_value</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.get_out_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.get_out_value" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the data definition</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.definition.DataDefinition" title="vmware.vapi.data.definition.DataDefinition"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.definition.DataDefinition</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Data definition</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_any_error">
|
||
|
|
<tt class="descname">visit_any_error</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_any_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_any_error" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit an error value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.AnyErrorType" title="vmware.vapi.bindings.type.AnyErrorType"><tt class="xref py py-class docutils literal"><span class="pre">AnyErrorType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_blob">
|
||
|
|
<tt class="descname">visit_blob</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_blob"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_blob" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a blob value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.BlobType" title="vmware.vapi.bindings.type.BlobType"><tt class="xref py py-class docutils literal"><span class="pre">BlobType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_boolean">
|
||
|
|
<tt class="descname">visit_boolean</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_boolean"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_boolean" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a boolean value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.BooleanType" title="vmware.vapi.bindings.type.BooleanType"><tt class="xref py py-class docutils literal"><span class="pre">BooleanType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_date_time">
|
||
|
|
<tt class="descname">visit_date_time</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_date_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_date_time" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a datetime value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.DateTimeType" title="vmware.vapi.bindings.type.DateTimeType"><tt class="xref py py-class docutils literal"><span class="pre">DateTimeType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_double">
|
||
|
|
<tt class="descname">visit_double</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_double"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_double" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a double value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.DoubleType" title="vmware.vapi.bindings.type.DoubleType"><tt class="xref py py-class docutils literal"><span class="pre">DoubleType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_dynamic_struct">
|
||
|
|
<tt class="descname">visit_dynamic_struct</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_dynamic_struct"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_dynamic_struct" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a struct value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.DynamicStructType" title="vmware.vapi.bindings.type.DynamicStructType"><tt class="xref py py-class docutils literal"><span class="pre">DynamicStructType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_enum">
|
||
|
|
<tt class="descname">visit_enum</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_enum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_enum" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a enum value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.EnumType" title="vmware.vapi.bindings.type.EnumType"><tt class="xref py py-class docutils literal"><span class="pre">EnumType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_error">
|
||
|
|
<tt class="descname">visit_error</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_error" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit an error 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">Parameters:</th><td class="field-body"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.ErrorType" title="vmware.vapi.bindings.type.ErrorType"><tt class="xref py py-class docutils literal"><span class="pre">ErrorType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_id">
|
||
|
|
<tt class="descname">visit_id</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_id" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a ID value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.IdType" title="vmware.vapi.bindings.type.IdType"><tt class="xref py py-class docutils literal"><span class="pre">IdType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_integer">
|
||
|
|
<tt class="descname">visit_integer</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_integer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_integer" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit an integer value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.IntegerType" title="vmware.vapi.bindings.type.IntegerType"><tt class="xref py py-class docutils literal"><span class="pre">IntegerType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_list">
|
||
|
|
<tt class="descname">visit_list</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a list value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.ListType" title="vmware.vapi.bindings.type.ListType"><tt class="xref py py-class docutils literal"><span class="pre">ListType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_map">
|
||
|
|
<tt class="descname">visit_map</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_map"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_map" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a map value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.MapType" title="vmware.vapi.bindings.type.MapType"><tt class="xref py py-class docutils literal"><span class="pre">MapType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_opaque">
|
||
|
|
<tt class="descname">visit_opaque</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_opaque"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_opaque" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit an opaque value.</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.OpaqueType" title="vmware.vapi.bindings.type.OpaqueType"><tt class="xref py py-class docutils literal"><span class="pre">OpaqueType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_optional">
|
||
|
|
<tt class="descname">visit_optional</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_optional"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_optional" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit an optional value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.OptionalType" title="vmware.vapi.bindings.type.OptionalType"><tt class="xref py py-class docutils literal"><span class="pre">OptionalType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_reference">
|
||
|
|
<tt class="descname">visit_reference</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_reference"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_reference" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a reference 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">Parameters:</th><td class="field-body"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.ReferenceType" title="vmware.vapi.bindings.type.ReferenceType"><tt class="xref py py-class docutils literal"><span class="pre">ReferenceType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_secret">
|
||
|
|
<tt class="descname">visit_secret</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_secret"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_secret" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a secret value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.SecretType" title="vmware.vapi.bindings.type.SecretType"><tt class="xref py py-class docutils literal"><span class="pre">SecretType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_set">
|
||
|
|
<tt class="descname">visit_set</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_set" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a set value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.SetType" title="vmware.vapi.bindings.type.SetType"><tt class="xref py py-class docutils literal"><span class="pre">SetType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_string">
|
||
|
|
<tt class="descname">visit_string</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_string" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a string value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.StringType" title="vmware.vapi.bindings.type.StringType"><tt class="xref py py-class docutils literal"><span class="pre">StringType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_struct">
|
||
|
|
<tt class="descname">visit_struct</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_struct"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_struct" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a struct value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.StructType" title="vmware.vapi.bindings.type.StructType"><tt class="xref py py-class docutils literal"><span class="pre">StructType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_uri">
|
||
|
|
<tt class="descname">visit_uri</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_uri"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_uri" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit an URI value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.URIType" title="vmware.vapi.bindings.type.URIType"><tt class="xref py py-class docutils literal"><span class="pre">URIType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DataDefinitionBuilder.visit_void">
|
||
|
|
<tt class="descname">visit_void</tt><big>(</big><em>typ</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DataDefinitionBuilder.visit_void"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DataDefinitionBuilder.visit_void" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a void value (i.e. None)</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>typ</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.VoidType" title="vmware.vapi.bindings.type.VoidType"><tt class="xref py py-class docutils literal"><span class="pre">VoidType</span></tt></a>) – Binding type of the value</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DateTimeType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">DateTimeType</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DateTimeType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DateTimeType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a></p>
|
||
|
|
<p>Representation of datetime IDL Type in Python Binding</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DoubleType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">DoubleType</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DoubleType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DoubleType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a></p>
|
||
|
|
<p>Representation of float IDL Type in Python Binding</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DynamicStructType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">DynamicStructType</tt><big>(</big><em>name</em>, <em>fields</em>, <em>binding_class=None</em>, <em>has_fields_of_type=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DynamicStructType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DynamicStructType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.StructType" title="vmware.vapi.bindings.type.StructType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.StructType</span></tt></a></p>
|
||
|
|
<p>Representation of StructValue IDL annotation in Python Binding</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>has_fields_of_type</strong> – List of reference types whose fields need to be
|
||
|
|
present in the StructValue for this DynamicStruct type</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>Initialize DynamicStructType</p>
|
||
|
|
<table class="docutils field-list" 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>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the Structure</li>
|
||
|
|
<li><strong>fields</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> and <a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">BindingType</span></tt></a>) – Map of field name and field binding type</li>
|
||
|
|
<li><strong>binding_class</strong> (<a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.definition.DataDefinition" title="vmware.vapi.data.definition.DataDefinition"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.definition.DataDefinition</span></tt></a>) – Data definition for this type</li>
|
||
|
|
<li><strong>has_fields_of_type</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.ReferenceType" title="vmware.vapi.bindings.type.ReferenceType"><tt class="xref py py-class docutils literal"><span class="pre">ReferenceType</span></tt></a>) – List of reference types whose fields need to
|
||
|
|
be present in the StructValue for this DynamicStruct type</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.type.DynamicStructType.has_fields_of_type">
|
||
|
|
<tt class="descname">has_fields_of_type</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#DynamicStructType.has_fields_of_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.DynamicStructType.has_fields_of_type" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the has_fields_of_type</p>
|
||
|
|
<p>:rtype <a class="reference internal" href="#vmware.vapi.bindings.type.ReferenceType" title="vmware.vapi.bindings.type.ReferenceType"><tt class="xref py py-class docutils literal"><span class="pre">ReferenceType</span></tt></a>
|
||
|
|
:return List of reference types whose fields need to be present in the</p>
|
||
|
|
<blockquote>
|
||
|
|
<div>StructValue for this DynamicStruct type</div></blockquote>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.EnumType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">EnumType</tt><big>(</big><em>name</em>, <em>binding_class</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#EnumType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.EnumType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a></p>
|
||
|
|
<p>Representation of enum IDL Type in Python Binding</p>
|
||
|
|
<table class="docutils field-list" 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> – Name of the enum</li>
|
||
|
|
<li><strong>binding_class</strong> – Reference to the Python native class corresponding
|
||
|
|
to this structure</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.type.EnumType.binding_class">
|
||
|
|
<tt class="descname">binding_class</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#EnumType.binding_class"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.EnumType.binding_class" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the reference to the Python native class
|
||
|
|
corresponding to this structure</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.type.EnumType.name">
|
||
|
|
<tt class="descname">name</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#EnumType.name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.EnumType.name" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the name of the EnumType</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Name of the EnumType</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.ErrorType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">ErrorType</tt><big>(</big><em>name</em>, <em>fields</em>, <em>binding_class=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#ErrorType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.ErrorType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.StructType" title="vmware.vapi.bindings.type.StructType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.StructType</span></tt></a></p>
|
||
|
|
<p>Representation of Error IDL type in Python Binding</p>
|
||
|
|
<table class="docutils field-list" 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>definition</strong> – type representation in the API runtime</li>
|
||
|
|
<li><strong>name</strong> – Name of the structure</li>
|
||
|
|
<li><strong>binding_class</strong> – Reference to the Python native class corresponding
|
||
|
|
to this error</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.IdType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">IdType</tt><big>(</big><em>resource_types=None</em>, <em>resource_type_field_name=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#IdType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.IdType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a></p>
|
||
|
|
<p>Representation of ID IDL type in Python Binding</p>
|
||
|
|
<table class="docutils field-list" 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>resolved_types</strong> – Resource type(s) for the ID</li>
|
||
|
|
<li><strong>resource_type_field_name</strong> – Name of the field specifying the resource
|
||
|
|
type</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.type.IdType.resource_type_field_name">
|
||
|
|
<tt class="descname">resource_type_field_name</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#IdType.resource_type_field_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.IdType.resource_type_field_name" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the name of the field specifying the resource 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">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Name of the field specifying the resource type</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.type.IdType.resource_types">
|
||
|
|
<tt class="descname">resource_types</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#IdType.resource_types"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.IdType.resource_types" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the Resource type(s) for the ID field</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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">str</span></tt> or <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="xref py py-class docutils literal"><span class="pre">None</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Resource type(s) for the ID</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.IntegerType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">IntegerType</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#IntegerType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.IntegerType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a></p>
|
||
|
|
<p>Representation of integer IDL Type in Python Binding</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.ListType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">ListType</tt><big>(</big><em>element_type</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#ListType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.ListType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a></p>
|
||
|
|
<p>Representation of List IDL type in Python Binding</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>element_type</strong> – element type</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.type.ListType.element_type">
|
||
|
|
<tt class="descname">element_type</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#ListType.element_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.ListType.element_type" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Return the element type of this ListType</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">BindingType</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">element type</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.MapType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">MapType</tt><big>(</big><em>key_type</em>, <em>value_type</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#MapType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.MapType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a></p>
|
||
|
|
<p>Representation of Map IDL type in Python Binding</p>
|
||
|
|
<table class="docutils field-list" 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>key_type</strong> – map key type</li>
|
||
|
|
<li><strong>value_type</strong> – map value type</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.type.MapType.key_type">
|
||
|
|
<tt class="descname">key_type</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#MapType.key_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.MapType.key_type" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Return the key type of this MapType</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">BindingType</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">key type</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.type.MapType.value_type">
|
||
|
|
<tt class="descname">value_type</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#MapType.value_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.MapType.value_type" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Return the value type of this MapType</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">BindingType</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">value type</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.OpaqueType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">OpaqueType</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#OpaqueType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.OpaqueType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a></p>
|
||
|
|
<p>Representation of Opaque IDL annotation in Python Binding</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.OptionalType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">OptionalType</tt><big>(</big><em>element_type</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#OptionalType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.OptionalType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a></p>
|
||
|
|
<p>Representation of optional IDL annotation in Python Binding</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>element_type</strong> – element type</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.type.OptionalType.element_type">
|
||
|
|
<tt class="descname">element_type</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#OptionalType.element_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.OptionalType.element_type" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Return the element type of this ListType</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">BindingType</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">element type</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.ReferenceType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">ReferenceType</tt><big>(</big><em>context</em>, <em>type_name</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#ReferenceType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.ReferenceType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a></p>
|
||
|
|
<p>Reference type to resolve references lazily.</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>resolved_type</strong> – Resolved reference type</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<p>Initialize ReferenceType</p>
|
||
|
|
<table class="docutils field-list" 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>context</strong> (<tt class="xref py py-class docutils literal"><span class="pre">module</span></tt>) – Module reference that has the type</li>
|
||
|
|
<li><strong>type_name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Fully qualified name of the type reference. i.e.
|
||
|
|
if the type Bar is nested inside type Foo, it would be Foo.Bar</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.type.ReferenceType.resolved_type">
|
||
|
|
<tt class="descname">resolved_type</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#ReferenceType.resolved_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.ReferenceType.resolved_type" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the resolved struct type or enum 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">Return type:</th><td class="field-body"><a class="reference internal" href="#vmware.vapi.bindings.type.StructType" title="vmware.vapi.bindings.type.StructType"><tt class="xref py py-class docutils literal"><span class="pre">StructType</span></tt></a> or
|
||
|
|
<a class="reference internal" href="#vmware.vapi.bindings.type.EnumType" title="vmware.vapi.bindings.type.EnumType"><tt class="xref py py-class docutils literal"><span class="pre">EnumType</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Resolved struct type or enum type</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.SecretType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">SecretType</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#SecretType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.SecretType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a></p>
|
||
|
|
<p>Representation of @secret IDL annotation in Python Binding. @secret
|
||
|
|
annotation can only be applied to strings.</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.SetType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">SetType</tt><big>(</big><em>element_type</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#SetType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.SetType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a></p>
|
||
|
|
<p>Representation of Set IDL type in Python Binding</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>element_type</strong> – element type</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.type.SetType.element_type">
|
||
|
|
<tt class="descname">element_type</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#SetType.element_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.SetType.element_type" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Return the element type of this SetType</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">BindingType</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">element type</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.StringType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">StringType</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#StringType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.StringType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a></p>
|
||
|
|
<p>Representation of string IDL Type in Python Binding</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.StructType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">StructType</tt><big>(</big><em>name</em>, <em>fields</em>, <em>binding_class=None</em>, <em>is_model=False</em>, <em>model_keys=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#StructType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.StructType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a></p>
|
||
|
|
<p>Representation of Structure IDL type in Python Binding</p>
|
||
|
|
<table class="docutils field-list" 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> – Name of the structure</li>
|
||
|
|
<li><strong>binding_class</strong> – Reference to the Python native class corresponding
|
||
|
|
to this structure</li>
|
||
|
|
<li><strong>is_model</strong> – True if the structure is marked as Model, False otherwise</li>
|
||
|
|
<li><strong>model_keys</strong> – List of model keys for the structure if it is marked as Model</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.type.StructType.binding_class">
|
||
|
|
<tt class="descname">binding_class</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#StructType.binding_class"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.StructType.binding_class" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the reference to the Python native class
|
||
|
|
corresponding to this structure</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Reference to the python native class</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.StructType.get_field">
|
||
|
|
<tt class="descname">get_field</tt><big>(</big><em>field_name</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#StructType.get_field"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.StructType.get_field" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the BindingType of the argument</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>field_name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Field name</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">BindingType</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">BindingType of the field specified</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.type.StructType.get_field_names">
|
||
|
|
<tt class="descname">get_field_names</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#StructType.get_field_names"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.StructType.get_field_names" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the list of field names present in this StructType</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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">str</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of field names</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.type.StructType.is_model">
|
||
|
|
<tt class="descname">is_model</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#StructType.is_model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.StructType.is_model" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Check if the Struct is marked as model</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the Struct is marked as model, False otherwise</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.type.StructType.model_keys">
|
||
|
|
<tt class="descname">model_keys</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#StructType.model_keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.StructType.model_keys" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns list of model keys for the Struct if it is marked as model</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><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">str</span></tt> or None</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of model keys for the Struct if it is marked as model</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.type.StructType.name">
|
||
|
|
<tt class="descname">name</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#StructType.name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.StructType.name" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the name of the StructType</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Name of the StructType</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.TypeUtil">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">TypeUtil</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#TypeUtil"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.TypeUtil" 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>Converts a BindingType object to DataDefinition object</p>
|
||
|
|
<dl class="staticmethod">
|
||
|
|
<dt id="vmware.vapi.bindings.type.TypeUtil.convert_to_data_definition">
|
||
|
|
<em class="property">static </em><tt class="descname">convert_to_data_definition</tt><big>(</big><em>binding_type</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#TypeUtil.convert_to_data_definition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.TypeUtil.convert_to_data_definition" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Converts a BindingType object to DataDefinition object</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>binding_type</strong> (<a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">BindingType</span></tt></a>) – Binding type</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.definition.DataDefinition" title="vmware.vapi.data.definition.DataDefinition"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.definition.DataDefinition</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">DataDefinition</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.URIType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">URIType</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#URIType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.URIType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a></p>
|
||
|
|
<p>Representation of URI IDL Type in Python Binding</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.type.VoidType">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.type.</tt><tt class="descname">VoidType</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/type.html#VoidType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.type.VoidType" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.bindings.type.BindingType" title="vmware.vapi.bindings.type.BindingType"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.type.BindingType</span></tt></a></p>
|
||
|
|
<p>Representation of void IDL type in Python Binding</p>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-vmware.vapi.bindings.uri_helper">
|
||
|
|
<span id="uri-helper-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">uri_helper</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.bindings.uri_helper" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Utility library for validating IRI that conform to RFC 3987</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.uri_helper.URIValidator">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.uri_helper.</tt><tt class="descname">URIValidator</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/uri_helper.html#URIValidator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.uri_helper.URIValidator" 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>Helper class for validation of IRI’s</p>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.uri_helper.URIValidator.compiled_regex">
|
||
|
|
<tt class="descname">compiled_regex</tt><em class="property"> = {'IRI': <_sre.SRE_Pattern object at 0x992f4b0>, 'IRI_reference': <_sre.SRE_Pattern object at 0x9941e78>}</em><a class="headerlink" href="#vmware.vapi.bindings.uri_helper.URIValidator.compiled_regex" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.uri_helper.URIValidator.final_regex">
|
||
|
|
<tt class="descname">final_regex</tt><em class="property"> = {'IPv4address': '(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)', 'ireg_name': "(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=])*", 'sub_delims': "[!$&'()*+,;=]", 'reserved': "(?:[:/?#[\\]@]|[!$&'()*+,;=])", 'ucschar': '[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF]', 'isegment_nz_nc': "(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|@)+", 'IRI_reference': "(?:[a-zA-Z][a-zA-Z0-9+.-]*:(?://(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:)*@)?(?:\\[(?:(?:(?:[0-9A-Fa-f]{1,4}:){6}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|::(?:[0-9A-Fa-f]{1,4}:){5}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|[0-9A-Fa-f]{1,4}?::(?:[0-9A-Fa-f]{1,4}:){4}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:)?[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){3}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,2}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){2}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,3}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:)(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,4}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,5}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}|(?:(?:[0-9A-Fa-f]{1,4}:){,6}[0-9A-Fa-f]{1,4})?::)|v[0-9A-Fa-f]+\\.(?:[a-zA-Z0-9_.~-]|[!$&'()*+,;=]|:)+)\\]|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=])*)(?::[0-9]*)?(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|/(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*)?|(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|)(?:\\?(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)|[\\uE000-\\uF8FF]|/|\\?)*)?(?:\\#(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)|/|\\?)*)?|(?:(?://(?:(?:(?:[a-zA-Z0-9._~-]|[\\xA0-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFEF])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:)*@)?(?:\\[(?:(?:(?:[0-9A-Fa-f]{1,4}:){6}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|::(?:[0-9A-Fa-f]{1,4}:){5}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|[0-9A-Fa-f]{1,4}?::(?:[0-9A-Fa-f]{1,4}:){4}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:)?[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){3}(?:[0-9A-Fa-f]
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.uri_helper.URIValidator.key">
|
||
|
|
<tt class="descname">key</tt><em class="property"> = 'IRI_reference'</em><a class="headerlink" href="#vmware.vapi.bindings.uri_helper.URIValidator.key" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.uri_helper.URIValidator.regex">
|
||
|
|
<tt class="descname">regex</tt><em class="property"> = <_sre.SRE_Pattern object at 0x9941e78></em><a class="headerlink" href="#vmware.vapi.bindings.uri_helper.URIValidator.regex" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.uri_helper.URIValidator.regex_str">
|
||
|
|
<tt class="descname">regex_str</tt><em class="property"> = u"^(?:[a-zA-Z][a-zA-Z0-9+.-]*:(?://(?:(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:)*@)?(?:\\[(?:(?:(?:[0-9A-Fa-f]{1,4}:){6}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|::(?:[0-9A-Fa-f]{1,4}:){5}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|[0-9A-Fa-f]{1,4}?::(?:[0-9A-Fa-f]{1,4}:){4}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:)?[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){3}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,2}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){2}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,3}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:)(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,4}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,5}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}|(?:(?:[0-9A-Fa-f]{1,4}:){,6}[0-9A-Fa-f]{1,4})?::)|v[0-9A-Fa-f]+\\.(?:[a-zA-Z0-9_.~-]|[!$&'()*+,;=]|:)+)\\]|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=])*)(?::[0-9]*)?(?:/(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|/(?:(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*)?|(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)+(?:/(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)*)*|)(?:\\?(?:(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)|[\ue000-\uf8ff]|/|\\?)*)?(?:\\#(?:(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:|@)|/|\\?)*)?|(?:(?://(?:(?:(?:[a-zA-Z0-9._~-]|[\xa0-\ud7ff\uf900-\ufdcf\ufdf0-\uffef])|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|:)*@)?(?:\\[(?:(?:(?:[0-9A-Fa-f]{1,4}:){6}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|::(?:[0-9A-Fa-f]{1,4}:){5}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|[0-9A-Fa-f]{1,4}?::(?:[0-9A-Fa-f]{1,4}:){4}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:)?[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){3}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,2}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){2}(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,3}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:)(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){,4}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.)
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.uri_helper.URIValidator.rule_type">
|
||
|
|
<tt class="descname">rule_type</tt><em class="property"> = 'IRI_reference'</em><a class="headerlink" href="#vmware.vapi.bindings.uri_helper.URIValidator.rule_type" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.uri_helper.URIValidator.unicode_wrap">
|
||
|
|
<tt class="descname">unicode_wrap</tt><em class="property"> = 'u"""{0}"""'</em><a class="headerlink" href="#vmware.vapi.bindings.uri_helper.URIValidator.unicode_wrap" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="staticmethod">
|
||
|
|
<dt id="vmware.vapi.bindings.uri_helper.URIValidator.validate">
|
||
|
|
<em class="property">static </em><tt class="descname">validate</tt><big>(</big><em>iri</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/uri_helper.html#URIValidator.validate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.uri_helper.URIValidator.validate" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Validate the given IRI string</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>iri</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – IRI string to be validated</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.uri_helper.URIValidator.value">
|
||
|
|
<tt class="descname">value</tt><em class="property"> = '(?:{IRI}|{irelative_ref})'</em><a class="headerlink" href="#vmware.vapi.bindings.uri_helper.URIValidator.value" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="section" id="module-vmware.vapi.bindings.value">
|
||
|
|
<span id="value-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">value</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.bindings.value" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<p>Convenient libraries for DynamicValue</p>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.value.BaseDataValueConverter">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.value.</tt><tt class="descname">BaseDataValueConverter</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#BaseDataValueConverter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.BaseDataValueConverter" 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>Class to convert DataValue <-> DynamicValue</p>
|
||
|
|
<p>Note: This is an internal helper class for supporting this
|
||
|
|
functionality in client and provider standard libraries. This
|
||
|
|
class should be derived and the derived class should initialize
|
||
|
|
dynamic_value_class and optional_dynamic_value_class with the
|
||
|
|
appropriate class references.</p>
|
||
|
|
<table class="docutils field-list" 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>dynamic_value_class</strong> – Dynamic value class reference</li>
|
||
|
|
<li><strong>optional_dynamic_value_class</strong> – Optional dynamic value class reference</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.value.BaseDataValueConverter.dynamic_value_class">
|
||
|
|
<tt class="descname">dynamic_value_class</tt><em class="property"> = None</em><a class="headerlink" href="#vmware.vapi.bindings.value.BaseDataValueConverter.dynamic_value_class" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.value.BaseDataValueConverter.optional_dynamic_value_class">
|
||
|
|
<tt class="descname">optional_dynamic_value_class</tt><em class="property"> = None</em><a class="headerlink" href="#vmware.vapi.bindings.value.BaseDataValueConverter.optional_dynamic_value_class" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="classmethod">
|
||
|
|
<dt id="vmware.vapi.bindings.value.BaseDataValueConverter.to_data_value">
|
||
|
|
<em class="property">classmethod </em><tt class="descname">to_data_value</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#BaseDataValueConverter.to_data_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.BaseDataValueConverter.to_data_value" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Convert a given DynamicValue to DataValue</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be converted</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.DataValue" title="vmware.vapi.data.value.DataValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.DataValue</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">DataValue generated from DynamicValue</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="classmethod">
|
||
|
|
<dt id="vmware.vapi.bindings.value.BaseDataValueConverter.to_dynamic_value">
|
||
|
|
<em class="property">classmethod </em><tt class="descname">to_dynamic_value</tt><big>(</big><em>data_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#BaseDataValueConverter.to_dynamic_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.BaseDataValueConverter.to_dynamic_value" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Convert a given DataValue to DynamicValue</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>data_value</strong> (<a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.DataValue" title="vmware.vapi.data.value.DataValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.DataValue</span></tt></a>) – DataValue to be converted</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">DynamicValue generated from DataValue</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.value.BaseNativeValueConverter">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.value.</tt><tt class="descname">BaseNativeValueConverter</tt><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#BaseNativeValueConverter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.BaseNativeValueConverter" 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>class to convert Native value <-> DynamicValue.</p>
|
||
|
|
<p>Note: This is an internal helper class for supporting this
|
||
|
|
functionality in client and provider standard libraries. This
|
||
|
|
class should be derived and the derived class should initialize
|
||
|
|
dynamic_value_class and optional_dynamic_value_class with the
|
||
|
|
appropriate class references.</p>
|
||
|
|
<table class="docutils field-list" 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>dynamic_value_class</strong> – Dynamic value class reference</li>
|
||
|
|
<li><strong>optional_dynamic_value_class</strong> – Optional dynamic value class reference</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.value.BaseNativeValueConverter.dynamic_value_class">
|
||
|
|
<tt class="descname">dynamic_value_class</tt><em class="property"> = None</em><a class="headerlink" href="#vmware.vapi.bindings.value.BaseNativeValueConverter.dynamic_value_class" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="vmware.vapi.bindings.value.BaseNativeValueConverter.optional_dynamic_value_class">
|
||
|
|
<tt class="descname">optional_dynamic_value_class</tt><em class="property"> = None</em><a class="headerlink" href="#vmware.vapi.bindings.value.BaseNativeValueConverter.optional_dynamic_value_class" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="classmethod">
|
||
|
|
<dt id="vmware.vapi.bindings.value.BaseNativeValueConverter.to_dynamic_value">
|
||
|
|
<em class="property">classmethod </em><tt class="descname">to_dynamic_value</tt><big>(</big><em>native_value</em>, <em>is_optional=False</em>, <em>is_secret=False</em>, <em>is_binary=False</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#BaseNativeValueConverter.to_dynamic_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.BaseNativeValueConverter.to_dynamic_value" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Convert a given native value to DynamicValue</p>
|
||
|
|
<table class="docutils field-list" 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 simple">
|
||
|
|
<li><strong>native_value</strong> (<tt class="xref py py-class docutils literal"><span class="pre">object</span></tt>) – Native value to be converted</li>
|
||
|
|
<li><strong>is_optional</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – If true, after conversion of native
|
||
|
|
value to dynamic value, the output is wrapped in an
|
||
|
|
dynamic value whose type is OPTIONAL.</li>
|
||
|
|
<li><strong>is_secret</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – If true, and the native value is a string, the type of
|
||
|
|
the dynamic value returned will be secret. This boolean option, is
|
||
|
|
also passed to the elements of generic types such as List and
|
||
|
|
Set.</li>
|
||
|
|
<li><strong>is_binary</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – If true, and the native value is a string, the type of
|
||
|
|
the dynamic value returned will be binary. This boolean option, is
|
||
|
|
also passed to the elements of generic types such as List and
|
||
|
|
Set.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">DynamicValue generated from DataValue</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="classmethod">
|
||
|
|
<dt id="vmware.vapi.bindings.value.BaseNativeValueConverter.to_native_value">
|
||
|
|
<em class="property">classmethod </em><tt class="descname">to_native_value</tt><big>(</big><em>dynamic_value</em>, <em>is_set=False</em>, <em>is_datetime=False</em>, <em>user_defined_class_reference=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#BaseNativeValueConverter.to_native_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.BaseNativeValueConverter.to_native_value" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Convert a given DynamicValue to native value</p>
|
||
|
|
<table class="docutils field-list" 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 simple">
|
||
|
|
<li><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be converted</li>
|
||
|
|
<li><strong>is_set</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – If true, and the dynamic value is a list, the type of
|
||
|
|
the native value returned will be a set. This boolean option, is
|
||
|
|
also passed to the elements of generic types such as List and
|
||
|
|
Optional. If the dynamic value represents a Map, this option is
|
||
|
|
used only for the conversion of values of the Map.</li>
|
||
|
|
<li><strong>is_datetime</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – If true, and the dynamic value is a string, the type of
|
||
|
|
the native value returned will be a datetime. This boolean option, is
|
||
|
|
also passed to the elements of generic types such as List and
|
||
|
|
Optional. If the dynamic value represents a Map, this option is
|
||
|
|
used only for the conversion of values of the Map.</li>
|
||
|
|
<li><strong>user_defined_class_reference</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a> or
|
||
|
|
<a class="reference internal" href="#vmware.vapi.bindings.error.VapiError" title="vmware.vapi.bindings.error.VapiError"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.error.VapiError</span></tt></a> or
|
||
|
|
<a class="reference internal" href="#vmware.vapi.bindings.enum.Enum" title="vmware.vapi.bindings.enum.Enum"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></a>) – This class reference is used to
|
||
|
|
create native instances of user defined types (structures, errors
|
||
|
|
and enumerations). If the dynamic value is a Structure, instead of
|
||
|
|
returning VapiStruct, an instance of this class is returned. If the
|
||
|
|
dynamic value is an Error, instead of returning VapiError, an instance
|
||
|
|
of this class is returned. If the dynamic value is String, instead of
|
||
|
|
returning a string, an instance of this class is returned.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Native value generated</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DataValueToDynamicValueVisitor">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.value.</tt><tt class="descname">DataValueToDynamicValueVisitor</tt><big>(</big><em>dynamic_value_class</em>, <em>optional_dynamic_value_class</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DataValueToDynamicValueVisitor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DataValueToDynamicValueVisitor" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.SimpleValueVisitor" title="vmware.vapi.data.value.SimpleValueVisitor"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.SimpleValueVisitor</span></tt></a></p>
|
||
|
|
<p>Visitor to convert DataValue to DynamicValue</p>
|
||
|
|
<p>Initialize DataValueToDynamicValueVisitor</p>
|
||
|
|
<table class="docutils field-list" 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>dynamic_value_class</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue class reference</li>
|
||
|
|
<li><strong>optional_dynamic_value_class</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – OptionalDynamicValue class reference</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.get_out_value">
|
||
|
|
<tt class="descname">get_out_value</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DataValueToDynamicValueVisitor.get_out_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.get_out_value" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the output value</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">DynamicValue generated from DataValue</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_blob">
|
||
|
|
<tt class="descname">visit_blob</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DataValueToDynamicValueVisitor.visit_blob"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_blob" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_boolean">
|
||
|
|
<tt class="descname">visit_boolean</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DataValueToDynamicValueVisitor.visit_boolean"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_boolean" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_double">
|
||
|
|
<tt class="descname">visit_double</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DataValueToDynamicValueVisitor.visit_double"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_double" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_error">
|
||
|
|
<tt class="descname">visit_error</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DataValueToDynamicValueVisitor.visit_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_error" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_integer">
|
||
|
|
<tt class="descname">visit_integer</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DataValueToDynamicValueVisitor.visit_integer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_integer" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_list">
|
||
|
|
<tt class="descname">visit_list</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DataValueToDynamicValueVisitor.visit_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_optional">
|
||
|
|
<tt class="descname">visit_optional</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DataValueToDynamicValueVisitor.visit_optional"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_optional" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_secret">
|
||
|
|
<tt class="descname">visit_secret</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DataValueToDynamicValueVisitor.visit_secret"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_secret" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_string">
|
||
|
|
<tt class="descname">visit_string</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DataValueToDynamicValueVisitor.visit_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_string" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_struct">
|
||
|
|
<tt class="descname">visit_struct</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DataValueToDynamicValueVisitor.visit_struct"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_struct" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_void">
|
||
|
|
<tt class="descname">visit_void</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DataValueToDynamicValueVisitor.visit_void"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DataValueToDynamicValueVisitor.visit_void" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd></dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToDataValueVisitor">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.value.</tt><tt class="descname">DynamicValueToDataValueVisitor</tt><big>(</big><em>dynamic_value_class</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToDataValueVisitor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToDataValueVisitor" 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>Visitor to convert DynamicValue to DataValue</p>
|
||
|
|
<p>Initialize DynamicValueToDataValueVisitor</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value_class</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue class reference</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.get_out_value">
|
||
|
|
<tt class="descname">get_out_value</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToDataValueVisitor.get_out_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.get_out_value" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the DataValue</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.DataValue" title="vmware.vapi.data.value.DataValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.DataValue</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">DataValue generated from DynamicValue</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit">
|
||
|
|
<tt class="descname">visit</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToDataValueVisitor.visit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_binary">
|
||
|
|
<tt class="descname">visit_binary</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToDataValueVisitor.visit_binary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_binary" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is BINARY</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_boolean">
|
||
|
|
<tt class="descname">visit_boolean</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToDataValueVisitor.visit_boolean"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_boolean" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is BOOLEAN</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_double">
|
||
|
|
<tt class="descname">visit_double</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToDataValueVisitor.visit_double"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_double" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is DOUBLE</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_error">
|
||
|
|
<tt class="descname">visit_error</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToDataValueVisitor.visit_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_error" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is ERROR</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_list">
|
||
|
|
<tt class="descname">visit_list</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToDataValueVisitor.visit_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is LIST</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_long">
|
||
|
|
<tt class="descname">visit_long</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToDataValueVisitor.visit_long"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_long" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is LONG</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_optional">
|
||
|
|
<tt class="descname">visit_optional</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToDataValueVisitor.visit_optional"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_optional" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is OPTIONAL</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_secret">
|
||
|
|
<tt class="descname">visit_secret</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToDataValueVisitor.visit_secret"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_secret" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is SECRET</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_string">
|
||
|
|
<tt class="descname">visit_string</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToDataValueVisitor.visit_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_string" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is STRING</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_structure">
|
||
|
|
<tt class="descname">visit_structure</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToDataValueVisitor.visit_structure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_structure" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is STRUCTURE</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_void">
|
||
|
|
<tt class="descname">visit_void</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToDataValueVisitor.visit_void"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToDataValueVisitor.visit_void" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is VOID</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.value.</tt><tt class="descname">DynamicValueToNativeValueVisitor</tt><big>(</big><em>dynamic_value_class</em>, <em>optional_dynamic_value_class</em>, <em>is_set=False</em>, <em>is_datetime=False</em>, <em>user_defined_class_reference=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToNativeValueVisitor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor" 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>Visitor to convert DynamicValue to python native value</p>
|
||
|
|
<p>Initialize DynamicValueToDataValueVisitor</p>
|
||
|
|
<table class="docutils field-list" 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>dynamic_value_class</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue class reference</li>
|
||
|
|
<li><strong>optional_dynamic_value_class</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – OptionalDynamicValue class reference</li>
|
||
|
|
<li><strong>is_set</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – If true, and the dynamic value is a list, the type of
|
||
|
|
the native value returned will be a set. This boolean option, is
|
||
|
|
also passed to the elements of generic types such as List and
|
||
|
|
Optional. If the dynamic value represents a Map, this option is
|
||
|
|
used only for the conversion of values of the Map.</li>
|
||
|
|
<li><strong>is_datetime</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – If true, and the dynamic value is a string, the type of
|
||
|
|
the native value returned will be a datetime. This boolean option, is
|
||
|
|
also passed to the elements of generic types such as List and
|
||
|
|
Optional. If the dynamic value represents a Map, this option is
|
||
|
|
used only for the conversion of values of the Map.</li>
|
||
|
|
<li><strong>user_defined_class_reference</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a> or
|
||
|
|
<a class="reference internal" href="#vmware.vapi.bindings.error.VapiError" title="vmware.vapi.bindings.error.VapiError"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.error.VapiError</span></tt></a> or
|
||
|
|
<a class="reference internal" href="#vmware.vapi.bindings.enum.Enum" title="vmware.vapi.bindings.enum.Enum"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></a>) – This class reference is used to
|
||
|
|
create native instances of user defined types (structures, errors
|
||
|
|
and enumerations). If the dynamic value is a Structure, instead of
|
||
|
|
returning VapiStruct, an instance of this class is returned. If the
|
||
|
|
dynamic value is an Error, instead of returning VapiError, an instance
|
||
|
|
of this class is returned. If the dynamic value is String, instead of
|
||
|
|
returning a string, an instance of this class is returned.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.get_out_value">
|
||
|
|
<tt class="descname">get_out_value</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToNativeValueVisitor.get_out_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.get_out_value" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the DataValue</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.DataValue" title="vmware.vapi.data.value.DataValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.DataValue</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">DataValue generated from DynamicValue</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit">
|
||
|
|
<tt class="descname">visit</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToNativeValueVisitor.visit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_binary">
|
||
|
|
<tt class="descname">visit_binary</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToNativeValueVisitor.visit_binary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_binary" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is BINARY</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_boolean">
|
||
|
|
<tt class="descname">visit_boolean</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToNativeValueVisitor.visit_boolean"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_boolean" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is BOOLEAN</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_double">
|
||
|
|
<tt class="descname">visit_double</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToNativeValueVisitor.visit_double"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_double" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is DOUBLE</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_error">
|
||
|
|
<tt class="descname">visit_error</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToNativeValueVisitor.visit_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_error" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is ERROR</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_list">
|
||
|
|
<tt class="descname">visit_list</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToNativeValueVisitor.visit_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is LIST</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_long">
|
||
|
|
<tt class="descname">visit_long</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToNativeValueVisitor.visit_long"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_long" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is LONG</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_optional">
|
||
|
|
<tt class="descname">visit_optional</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToNativeValueVisitor.visit_optional"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_optional" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is OPTIONAL</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_secret">
|
||
|
|
<tt class="descname">visit_secret</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToNativeValueVisitor.visit_secret"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_secret" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is SECRET</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_string">
|
||
|
|
<tt class="descname">visit_string</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToNativeValueVisitor.visit_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_string" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is STRING</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_structure">
|
||
|
|
<tt class="descname">visit_structure</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToNativeValueVisitor.visit_structure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_structure" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is STRUCTURE</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_void">
|
||
|
|
<tt class="descname">visit_void</tt><big>(</big><em>dynamic_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#DynamicValueToNativeValueVisitor.visit_void"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.DynamicValueToNativeValueVisitor.visit_void" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a DynamicValue whose type is VOID</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>dynamic_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue to be visited</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor">
|
||
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.bindings.value.</tt><tt class="descname">NativeValueToDynamicValueVisitor</tt><big>(</big><em>dynamic_value_class</em>, <em>optional_dynamic_value_class</em>, <em>is_optional=False</em>, <em>is_secret=False</em>, <em>is_binary=False</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#NativeValueToDynamicValueVisitor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor" 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>Visitor to convert Native value to Dynamic value</p>
|
||
|
|
<p>Initialize DynamicValueToDataValueVisitor</p>
|
||
|
|
<table class="docutils field-list" 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>dynamic_value_class</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – DynamicValue class reference</li>
|
||
|
|
<li><strong>optional_dynamic_value_class</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – OptionalDynamicValue class reference</li>
|
||
|
|
<li><strong>is_optional</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – If true, after conversion of native
|
||
|
|
value to dynamic value, the output is wrapped in an
|
||
|
|
dynamic value whose type is OPTIONAL.</li>
|
||
|
|
<li><strong>is_secret</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – If true, and the native value is a string, the type of
|
||
|
|
the dynamic value returned will be secret. This boolean option, is
|
||
|
|
also passed to the elements of generic types such as List and
|
||
|
|
Set.</li>
|
||
|
|
<li><strong>is_binary</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – If true, and the native value is a string, the type of
|
||
|
|
the dynamic value returned will be binary. This boolean option, is
|
||
|
|
also passed to the elements of generic types such as List and
|
||
|
|
Set.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.get_out_value">
|
||
|
|
<tt class="descname">get_out_value</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#NativeValueToDynamicValueVisitor.get_out_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.get_out_value" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Returns the DataValue</p>
|
||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
||
|
|
<col class="field-name" />
|
||
|
|
<col class="field-body" />
|
||
|
|
<tbody valign="top">
|
||
|
|
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="vmware.vapi.data.html#vmware.vapi.data.value.DataValue" title="vmware.vapi.data.value.DataValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.DataValue</span></tt></a></td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">DataValue generated from DynamicValue</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit">
|
||
|
|
<tt class="descname">visit</tt><big>(</big><em>native_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#NativeValueToDynamicValueVisitor.visit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Visit a native value</p>
|
||
|
|
<table class="docutils field-list" 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"><strong>native_value</strong> (<tt class="xref py py-class docutils literal"><span class="pre">object</span></tt>) – Native value to be converted</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit_boolean">
|
||
|
|
<tt class="descname">visit_boolean</tt><big>(</big><em>native_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#NativeValueToDynamicValueVisitor.visit_boolean"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit_boolean" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>visit a native value whose value is bool 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">Parameters:</th><td class="field-body"><strong>native_value</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Native value to be converted</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit_datetime">
|
||
|
|
<tt class="descname">visit_datetime</tt><big>(</big><em>native_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#NativeValueToDynamicValueVisitor.visit_datetime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit_datetime" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>visit a native value whose value is datetime 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">Parameters:</th><td class="field-body"><strong>native_value</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt>) – Native value to be converted</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit_double">
|
||
|
|
<tt class="descname">visit_double</tt><big>(</big><em>native_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#NativeValueToDynamicValueVisitor.visit_double"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit_double" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>visit a native value whose value is double 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">Parameters:</th><td class="field-body"><strong>native_value</strong> (<tt class="xref py py-class docutils literal"><span class="pre">double</span></tt> or <tt class="xref py py-class docutils literal"><span class="pre">decimal.Decimal</span></tt>) – Native value to be converted</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit_enumeration">
|
||
|
|
<tt class="descname">visit_enumeration</tt><big>(</big><em>native_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#NativeValueToDynamicValueVisitor.visit_enumeration"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit_enumeration" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>visit a native value whose value is vAPI enumeration 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">Parameters:</th><td class="field-body"><strong>native_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.enum.Enum" title="vmware.vapi.bindings.enum.Enum"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></a>) – Native value to be converted</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit_error">
|
||
|
|
<tt class="descname">visit_error</tt><big>(</big><em>native_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#NativeValueToDynamicValueVisitor.visit_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit_error" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>visit a native value whose value is vAPI error 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">Parameters:</th><td class="field-body"><strong>native_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.error.VapiError" title="vmware.vapi.bindings.error.VapiError"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.error.VapiError</span></tt></a>) – Native value to be converted</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit_list">
|
||
|
|
<tt class="descname">visit_list</tt><big>(</big><em>native_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#NativeValueToDynamicValueVisitor.visit_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit_list" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>visit a native value whose value is list or set 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">Parameters:</th><td class="field-body"><strong>native_value</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> or <tt class="xref py py-class docutils literal"><span class="pre">set</span></tt>) – Native value to be converted</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit_long">
|
||
|
|
<tt class="descname">visit_long</tt><big>(</big><em>native_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#NativeValueToDynamicValueVisitor.visit_long"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit_long" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>visit a native value whose value is long 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">Parameters:</th><td class="field-body"><strong>native_value</strong> (<tt class="xref py py-class docutils literal"><span class="pre">int</span></tt> or <tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – Native value to be converted</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit_string">
|
||
|
|
<tt class="descname">visit_string</tt><big>(</big><em>native_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#NativeValueToDynamicValueVisitor.visit_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit_string" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>visit a native value whose value is string 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">Parameters:</th><td class="field-body"><strong>native_value</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Native value to be converted</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit_structure">
|
||
|
|
<tt class="descname">visit_structure</tt><big>(</big><em>native_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#NativeValueToDynamicValueVisitor.visit_structure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit_structure" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>visit a native value whose value is vAPI structure 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">Parameters:</th><td class="field-body"><strong>native_value</strong> (<a class="reference internal" href="#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a>) – Native value to be converted</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit_void">
|
||
|
|
<tt class="descname">visit_void</tt><big>(</big><em>native_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/bindings/value.html#NativeValueToDynamicValueVisitor.visit_void"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.bindings.value.NativeValueToDynamicValueVisitor.visit_void" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>visit a native value whose value is None 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">Parameters:</th><td class="field-body"><strong>native_value</strong> (<tt class="xref py py-class docutils literal"><span class="pre">None</span></tt>) – Native value to be converted</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</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="#">bindings Package</a><ul>
|
||
|
|
<li><a class="reference internal" href="#id1"><tt class="docutils literal"><span class="pre">bindings</span></tt> Package</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.bindings.common"><tt class="docutils literal"><span class="pre">common</span></tt> Module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.bindings.converter"><tt class="docutils literal"><span class="pre">converter</span></tt> Module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.bindings.datetime_helper"><tt class="docutils literal"><span class="pre">datetime_helper</span></tt> Module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.bindings.enum"><tt class="docutils literal"><span class="pre">enum</span></tt> Module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.bindings.error"><tt class="docutils literal"><span class="pre">error</span></tt> Module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.bindings.message"><tt class="docutils literal"><span class="pre">message</span></tt> Module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.bindings.skeleton"><tt class="docutils literal"><span class="pre">skeleton</span></tt> Module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.bindings.struct"><tt class="docutils literal"><span class="pre">struct</span></tt> Module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.bindings.stub"><tt class="docutils literal"><span class="pre">stub</span></tt> Module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.bindings.type"><tt class="docutils literal"><span class="pre">type</span></tt> Module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.bindings.uri_helper"><tt class="docutils literal"><span class="pre">uri_helper</span></tt> Module</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-vmware.vapi.bindings.value"><tt class="docutils literal"><span class="pre">value</span></tt> Module</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h4>Previous topic</h4>
|
||
|
|
<p class="topless"><a href="vmware.vapi.html"
|
||
|
|
title="previous chapter">vapi Package</a></p>
|
||
|
|
<h4>Next topic</h4>
|
||
|
|
<p class="topless"><a href="vmware.vapi.data.html"
|
||
|
|
title="next chapter">data Package</a></p>
|
||
|
|
<h3>This Page</h3>
|
||
|
|
<ul class="this-page-menu">
|
||
|
|
<li><a href="_sources/vmware.vapi.bindings.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.data.html" title="data Package"
|
||
|
|
>next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="vmware.vapi.html" title="vapi Package"
|
||
|
|
>previous</a> |</li>
|
||
|
|
<li><a href="index.html">vCloud Suite SDK for Python 6.0.0 documentation</a> »</li>
|
||
|
|
<li><a href="vmware.html" >vmware Package</a> »</li>
|
||
|
|
<li><a href="vmware.vapi.html" >vapi Package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="footer">
|
||
|
|
© Copyright 2014, VMware, Inc..
|
||
|
|
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|