mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-25 10:50:00 -05:00
2028 lines
148 KiB
HTML
2028 lines
148 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>data Package — vSphere Automation SDK for Python 6.5.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.5.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="vSphere Automation SDK for Python 6.5.0 documentation" href="index.html" />
|
|
<link rel="up" title="vapi Package" href="vmware.vapi.html" />
|
|
<link rel="next" title="serializers Package" href="vmware.vapi.data.serializers.html" />
|
|
<link rel="prev" title="bindings Package" href="vmware.vapi.bindings.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.serializers.html" title="serializers Package"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="vmware.vapi.bindings.html" title="bindings Package"
|
|
accesskey="P">previous</a> |</li>
|
|
<li><a href="index.html">vSphere Automation SDK for Python 6.5.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="data-package">
|
|
<h1>data Package<a class="headerlink" href="#data-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">data</span></tt> Package<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
|
|
<span class="target" id="module-vmware.vapi.data"></span></div>
|
|
<div class="section" id="module-vmware.vapi.data.definition">
|
|
<span id="definition-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">definition</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.data.definition" title="Permalink to this headline">¶</a></h2>
|
|
<p>DataDefinition classes</p>
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.definition.AnyErrorDefinition">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.definition.</tt><tt class="descname">AnyErrorDefinition</tt><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#AnyErrorDefinition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.AnyErrorDefinition" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.data.definition.SingletonDefinition" title="vmware.vapi.data.definition.SingletonDefinition"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.definition.SingletonDefinition</span></tt></a></p>
|
|
<p>DataDefinition for ‘Exception’ type in IDL</p>
|
|
<p>Initialize AnyErrorDefinition</p>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.AnyErrorDefinition.validate">
|
|
<tt class="descname">validate</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#AnyErrorDefinition.validate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.AnyErrorDefinition.validate" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>The validation for AnyErrorDefinition will succeed against
|
|
any 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>value</strong> (<a class="reference internal" href="#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>) – the data value to validate</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">list</span></tt> of <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> or <tt class="docutils literal"><span class="pre">None</span></tt></td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a stack of messages indicating why the value is not an instance
|
|
of this data-definition, or None if the value is an instance of
|
|
this data-definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.definition.BlobDefinition">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.definition.</tt><tt class="descname">BlobDefinition</tt><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#BlobDefinition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.BlobDefinition" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.data.definition.SingletonDefinition" title="vmware.vapi.data.definition.SingletonDefinition"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.definition.SingletonDefinition</span></tt></a></p>
|
|
<p>DataDefinition for binary values</p>
|
|
<p>Initialize BlobDefinition</p>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.BlobDefinition.new_value">
|
|
<tt class="descname">new_value</tt><big>(</big><em>value=''</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#BlobDefinition.new_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.BlobDefinition.new_value" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Create a new BlobValue</p>
|
|
<table class="docutils field-list" 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.value.BlobValue" title="vmware.vapi.data.value.BlobValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.BlobValue</span></tt></a></td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Newly created BlobValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.definition.BooleanDefinition">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.definition.</tt><tt class="descname">BooleanDefinition</tt><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#BooleanDefinition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.BooleanDefinition" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.data.definition.SingletonDefinition" title="vmware.vapi.data.definition.SingletonDefinition"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.definition.SingletonDefinition</span></tt></a></p>
|
|
<p>DataDefinition for bool values</p>
|
|
<p>Initialize BooleanDefinition</p>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.BooleanDefinition.new_value">
|
|
<tt class="descname">new_value</tt><big>(</big><em>value=False</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#BooleanDefinition.new_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.BooleanDefinition.new_value" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Create a new BooleanValue</p>
|
|
<table class="docutils field-list" 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.value.BooleanValue" title="vmware.vapi.data.value.BooleanValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.BooleanValue</span></tt></a></td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Newly created BooleanValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.definition.DataDefinition">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.definition.</tt><tt class="descname">DataDefinition</tt><big>(</big><em>data_type=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#DataDefinition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.DataDefinition" 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>Base class for all types in the vAPI run-time type system</p>
|
|
<table class="docutils field-list" 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>type</strong> – String representation of the type</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Initialize the data definition instance</p>
|
|
<table class="docutils field-list" 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_type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String representation of the type</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.DataDefinition.accept">
|
|
<tt class="descname">accept</tt><big>(</big><em>visitor</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#DataDefinition.accept"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.DataDefinition.accept" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Applies a visitor to this 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">Parameters:</th><td class="field-body"><strong>visitor</strong> (<a class="reference internal" href="#vmware.vapi.data.definition.SimpleDefinitionVisitor" title="vmware.vapi.data.definition.SimpleDefinitionVisitor"><tt class="xref py py-class docutils literal"><span class="pre">SimpleDefinitionVisitor</span></tt></a>) – the visitor operating on this data-definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.DataDefinition.complete_value">
|
|
<tt class="descname">complete_value</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#DataDefinition.complete_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.DataDefinition.complete_value" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Fill the optional fields of StructValues. Also
|
|
includes the StructValues present in other generic types: List
|
|
and 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>value</strong> (<a class="reference internal" href="#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</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.DataDefinition.valid_instance_of">
|
|
<tt class="descname">valid_instance_of</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#DataDefinition.valid_instance_of"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.DataDefinition.valid_instance_of" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Validates that the specified <a class="reference internal" href="#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> is an instance of
|
|
this 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">Parameters:</th><td class="field-body"><strong>value</strong> (<a class="reference internal" href="#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>) – the data value to validate</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">bool</span></tt></td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">true if the value is an instance of this data-definition,
|
|
false, otherwise</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.DataDefinition.validate">
|
|
<tt class="descname">validate</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#DataDefinition.validate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.DataDefinition.validate" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Validates that the specified <a class="reference internal" href="#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> is an instance of
|
|
this 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">Parameters:</th><td class="field-body"><strong>value</strong> (<a class="reference internal" href="#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>) – the data value to validate</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">list</span></tt> of <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> or <tt class="docutils literal"><span class="pre">None</span></tt></td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a stack of messages indicating why the value is not an instance
|
|
of this data-definition, or None if the value is an instance of
|
|
this data-definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.definition.DoubleDefinition">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.definition.</tt><tt class="descname">DoubleDefinition</tt><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#DoubleDefinition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.DoubleDefinition" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.data.definition.SingletonDefinition" title="vmware.vapi.data.definition.SingletonDefinition"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.definition.SingletonDefinition</span></tt></a></p>
|
|
<p>DataDefinition for floats</p>
|
|
<p>Initialize DoubleDefinition</p>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.DoubleDefinition.new_value">
|
|
<tt class="descname">new_value</tt><big>(</big><em>value=0.0</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#DoubleDefinition.new_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.DoubleDefinition.new_value" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Create a new DoubleValue</p>
|
|
<table class="docutils field-list" 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.value.DoubleValue" title="vmware.vapi.data.value.DoubleValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.DoubleValue</span></tt></a></td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Newly created DoubleValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.definition.DynamicStructDefinition">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.definition.</tt><tt class="descname">DynamicStructDefinition</tt><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#DynamicStructDefinition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.DynamicStructDefinition" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.data.definition.SingletonDefinition" title="vmware.vapi.data.definition.SingletonDefinition"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.definition.SingletonDefinition</span></tt></a></p>
|
|
<p>DataDefinition for dynamic structs</p>
|
|
<p>Initialize DynamicStructDefinition</p>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.DynamicStructDefinition.validate">
|
|
<tt class="descname">validate</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#DynamicStructDefinition.validate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.DynamicStructDefinition.validate" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>The validation for DynamicStructDefinition will succeed against
|
|
any 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>value</strong> (<a class="reference internal" href="#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>) – the data value to validate</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">list</span></tt> of <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> or <tt class="docutils literal"><span class="pre">None</span></tt></td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a stack of messages indicating why the value is not an instance
|
|
of this data-definition, or None if the value is an instance of
|
|
this data-definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.definition.ErrorDefinition">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.definition.</tt><tt class="descname">ErrorDefinition</tt><big>(</big><em>name</em>, <em>fields</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#ErrorDefinition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.ErrorDefinition" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.data.definition.StructDefinition" title="vmware.vapi.data.definition.StructDefinition"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.definition.StructDefinition</span></tt></a></p>
|
|
<p>DataDefinition for errors</p>
|
|
<p>Initialize ErrorDefinition</p>
|
|
<table class="docutils field-list" 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 Error</li>
|
|
<li><strong>fields</strong> (<tt class="xref py py-class docutils literal"><span class="pre">tuple</span></tt> of (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>, <a class="reference internal" href="#vmware.vapi.data.definition.DataDefinition" title="vmware.vapi.data.definition.DataDefinition"><tt class="xref py py-class docutils literal"><span class="pre">DataDefinition</span></tt></a>)) – A tuple consisting of the field name and the field
|
|
definition for all the fields inside this
|
|
StructDefinition</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.ErrorDefinition.new_value">
|
|
<tt class="descname">new_value</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#ErrorDefinition.new_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.ErrorDefinition.new_value" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Create a new 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">Return type:</th><td class="field-body"><a class="reference internal" href="#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">Newly created ErrorValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.definition.IntegerDefinition">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.definition.</tt><tt class="descname">IntegerDefinition</tt><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#IntegerDefinition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.IntegerDefinition" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.data.definition.SingletonDefinition" title="vmware.vapi.data.definition.SingletonDefinition"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.definition.SingletonDefinition</span></tt></a></p>
|
|
<p>DataDefinition for long values</p>
|
|
<p>Initialize IntegerDefinition</p>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.IntegerDefinition.new_value">
|
|
<tt class="descname">new_value</tt><big>(</big><em>value=0</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#IntegerDefinition.new_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.IntegerDefinition.new_value" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Create a new IntegerValue</p>
|
|
<table class="docutils field-list" 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.value.IntegerValue" title="vmware.vapi.data.value.IntegerValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.IntegerValue</span></tt></a></td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Newly created IntegerValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.definition.ListDefinition">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.definition.</tt><tt class="descname">ListDefinition</tt><big>(</big><em>element_type</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#ListDefinition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.ListDefinition" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|
<p>DataDefinition for lists</p>
|
|
<p>Initialize ListDefinition</p>
|
|
<table class="docutils field-list" 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>element_type</strong> (<a class="reference internal" href="#vmware.vapi.data.definition.DataDefinition" title="vmware.vapi.data.definition.DataDefinition"><tt class="xref py py-class docutils literal"><span class="pre">DataDefinition</span></tt></a>) – DataDefinition of the elements inside ListDefinition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.ListDefinition.complete_value">
|
|
<tt class="descname">complete_value</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#ListDefinition.complete_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.ListDefinition.complete_value" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Fill the optional values inside StructValues</p>
|
|
<table class="docutils field-list" 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> (<a class="reference internal" href="#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</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.ListDefinition.new_value">
|
|
<tt class="descname">new_value</tt><big>(</big><em>values=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#ListDefinition.new_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.ListDefinition.new_value" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Create a new 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>values</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#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>) – List of elements</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.value.ListValue" title="vmware.vapi.data.value.ListValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.ListValue</span></tt></a></td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Newly created ListValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.ListDefinition.validate">
|
|
<tt class="descname">validate</tt><big>(</big><em>list_value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#ListDefinition.validate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.ListDefinition.validate" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Apart from the validation checks specified in the validate
|
|
method of DataDefinition class, this method does some additional checks</p>
|
|
<p>Validation will fail if any element in the ListValue does not validate
|
|
against the DataDefinition of the elementType of this ListDefinition</p>
|
|
<table class="docutils field-list" 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>other</strong> (<a class="reference internal" href="#vmware.vapi.data.value.ListValue" title="vmware.vapi.data.value.ListValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.ListValue</span></tt></a>) – ListValue to be validated</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">list</span></tt> of <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> or <tt class="docutils literal"><span class="pre">None</span></tt></td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a stack of messages indicating why the value is not an instance
|
|
of this data-definition, or None if the value is an instance of
|
|
this data-definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.definition.OpaqueDefinition">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.definition.</tt><tt class="descname">OpaqueDefinition</tt><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#OpaqueDefinition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.OpaqueDefinition" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.data.definition.SingletonDefinition" title="vmware.vapi.data.definition.SingletonDefinition"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.definition.SingletonDefinition</span></tt></a></p>
|
|
<p>DataDefinition for opaque</p>
|
|
<p>Initialize OpaqueDefinition</p>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.OpaqueDefinition.validate">
|
|
<tt class="descname">validate</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#OpaqueDefinition.validate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.OpaqueDefinition.validate" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>The validation for OpaqueDefinition will succeed against
|
|
any DataValue. Only validates that supplied value is not 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>value</strong> (<a class="reference internal" href="#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 validated</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">list</span></tt> of <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> or <tt class="docutils literal"><span class="pre">None</span></tt></td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a stack of messages indicating why the value is not an instance
|
|
of this data-definition, or None if the value is an instance of
|
|
this data-definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.definition.OptionalDefinition">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.definition.</tt><tt class="descname">OptionalDefinition</tt><big>(</big><em>element_type</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#OptionalDefinition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.OptionalDefinition" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|
<p>An OptionalDefinition instance defines an optional type with a specified
|
|
element 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">Variables:</th><td class="field-body"><ul class="first last simple">
|
|
<li><strong>type</strong> – String representation of the type</li>
|
|
<li><strong>element_type</strong> – The type of the element that is optional</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Initialize OptionalDefinition</p>
|
|
<table class="docutils field-list" 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>element_type</strong> (<a class="reference internal" href="#vmware.vapi.data.type.Type" title="vmware.vapi.data.type.Type"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.type.Type</span></tt></a>) – Type of the DataDefinition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.OptionalDefinition.complete_value">
|
|
<tt class="descname">complete_value</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#OptionalDefinition.complete_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.OptionalDefinition.complete_value" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Fill the optional values inside StructValues</p>
|
|
<table class="docutils field-list" 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> (<a class="reference internal" href="#vmware.vapi.data.value.OptionalValue" title="vmware.vapi.data.value.OptionalValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.OptionalValue</span></tt></a>) – DataValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.OptionalDefinition.new_value">
|
|
<tt class="descname">new_value</tt><big>(</big><em>value=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#OptionalDefinition.new_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.OptionalDefinition.new_value" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Create and return a new <tt class="xref py py-class docutils literal"><span class="pre">OptionalValue</span></tt> using this
|
|
optional-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">Parameters:</th><td class="field-body"><strong>value</strong> (<a class="reference internal" href="#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>) – The element value</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.value.OptionalValue" title="vmware.vapi.data.value.OptionalValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.OptionalValue</span></tt></a></td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A new optional value using the given data-definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.OptionalDefinition.validate">
|
|
<tt class="descname">validate</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#OptionalDefinition.validate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.OptionalDefinition.validate" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Apart from the validation checks specified in the validate
|
|
method of DataDefinition class, this method does some additional checks.</p>
|
|
<p>Since this is an OptionalValue, validation will succeed if the
|
|
element value is None. If the element value is not None, validation
|
|
will fail if element in the OptionalValue does not validate against
|
|
the DataDefinition of the element_type of this OptionalDefinition.</p>
|
|
<table class="docutils field-list" 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>other</strong> (<a class="reference internal" href="#vmware.vapi.data.value.OptionalValue" title="vmware.vapi.data.value.OptionalValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.OptionalValue</span></tt></a>) – OptionalValue to be validated</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">list</span></tt> of <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></td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a stack of messages indicating why the value is not an instance
|
|
of this data-definition, or None if the value is an instance of
|
|
this data-definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.definition.ReferenceResolver">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.definition.</tt><tt class="descname">ReferenceResolver</tt><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#ReferenceResolver"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.ReferenceResolver" 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>Resolves all the StructRefDefinition objects</p>
|
|
<p>Initialize ReferenceResolver</p>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.ReferenceResolver.add_definition">
|
|
<tt class="descname">add_definition</tt><big>(</big><em>definition</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#ReferenceResolver.add_definition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.ReferenceResolver.add_definition" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Adds a new structure definition to the context</p>
|
|
<table class="docutils field-list" 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.definition.StructDefinition" title="vmware.vapi.data.definition.StructDefinition"><tt class="xref py py-class docutils literal"><span class="pre">StructDefinition</span></tt></a>) – StructDefinition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.ReferenceResolver.add_reference">
|
|
<tt class="descname">add_reference</tt><big>(</big><em>reference</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#ReferenceResolver.add_reference"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.ReferenceResolver.add_reference" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Adds a new structure refernce to the context</p>
|
|
<table class="docutils field-list" 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>refernce</strong> (<a class="reference internal" href="#vmware.vapi.data.definition.StructRefDefinition" title="vmware.vapi.data.definition.StructRefDefinition"><tt class="xref py py-class docutils literal"><span class="pre">StructRefDefinition</span></tt></a>) – StructRefDefinition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.ReferenceResolver.get_definition">
|
|
<tt class="descname">get_definition</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#ReferenceResolver.get_definition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.ReferenceResolver.get_definition" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Determines whether the context contains a definition for the specified
|
|
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.data.definition.StructDefinition" title="vmware.vapi.data.definition.StructDefinition"><tt class="xref py py-class docutils literal"><span class="pre">StructDefinition</span></tt></a></td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Definition if the structure if it is already defined, None otherwise</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.ReferenceResolver.is_defined">
|
|
<tt class="descname">is_defined</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#ReferenceResolver.is_defined"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.ReferenceResolver.is_defined" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Determines whether the context contains a definition for the specified
|
|
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"><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 structure is already defined, false otherwise</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.ReferenceResolver.resolve">
|
|
<tt class="descname">resolve</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#ReferenceResolver.resolve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.ReferenceResolver.resolve" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Traverses all references and resolves the unresolved ones.</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.definition.SecretDefinition">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.definition.</tt><tt class="descname">SecretDefinition</tt><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#SecretDefinition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.SecretDefinition" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.data.definition.SingletonDefinition" title="vmware.vapi.data.definition.SingletonDefinition"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.definition.SingletonDefinition</span></tt></a></p>
|
|
<p>DataDefinition for Secrets. Only strings are allowed to be secrets.</p>
|
|
<p>Initialize SecretDefinition</p>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.SecretDefinition.new_value">
|
|
<tt class="descname">new_value</tt><big>(</big><em>value=''</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#SecretDefinition.new_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.SecretDefinition.new_value" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Create a new SecretValue</p>
|
|
<table class="docutils field-list" 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.value.SecretValue" title="vmware.vapi.data.value.SecretValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.SecretValue</span></tt></a></td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Newly created SecretValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.definition.SimpleDefinitionVisitor">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.definition.</tt><tt class="descname">SimpleDefinitionVisitor</tt><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#SimpleDefinitionVisitor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.SimpleDefinitionVisitor" 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 definition visitor</p>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_blob">
|
|
<tt class="descname">visit_blob</tt><big>(</big><em>defn</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#SimpleDefinitionVisitor.visit_blob"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_blob" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a BlobDefinition</p>
|
|
<table class="docutils field-list" 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>defn</strong> (<a class="reference internal" href="#vmware.vapi.data.definition.BlobDefinition" title="vmware.vapi.data.definition.BlobDefinition"><tt class="xref py py-class docutils literal"><span class="pre">BlobDefinition</span></tt></a>) – Data definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_boolean">
|
|
<tt class="descname">visit_boolean</tt><big>(</big><em>defn</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#SimpleDefinitionVisitor.visit_boolean"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_boolean" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a BooleanDefinition</p>
|
|
<table class="docutils field-list" 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>defn</strong> (<a class="reference internal" href="#vmware.vapi.data.definition.BooleanDefinition" title="vmware.vapi.data.definition.BooleanDefinition"><tt class="xref py py-class docutils literal"><span class="pre">BooleanDefinition</span></tt></a>) – Data definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_double">
|
|
<tt class="descname">visit_double</tt><big>(</big><em>defn</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#SimpleDefinitionVisitor.visit_double"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_double" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a DoubleDefinition</p>
|
|
<table class="docutils field-list" 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>defn</strong> (<a class="reference internal" href="#vmware.vapi.data.definition.DoubleDefinition" title="vmware.vapi.data.definition.DoubleDefinition"><tt class="xref py py-class docutils literal"><span class="pre">DoubleDefinition</span></tt></a>) – Data definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_error">
|
|
<tt class="descname">visit_error</tt><big>(</big><em>defn</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#SimpleDefinitionVisitor.visit_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_error" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit an ErrorDefinition</p>
|
|
<table class="docutils field-list" 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>defn</strong> (<a class="reference internal" href="#vmware.vapi.data.definition.ErrorDefinition" title="vmware.vapi.data.definition.ErrorDefinition"><tt class="xref py py-class docutils literal"><span class="pre">ErrorDefinition</span></tt></a>) – Data definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_integer">
|
|
<tt class="descname">visit_integer</tt><big>(</big><em>defn</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#SimpleDefinitionVisitor.visit_integer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_integer" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a IntegerDefinition</p>
|
|
<table class="docutils field-list" 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>defn</strong> (<a class="reference internal" href="#vmware.vapi.data.definition.IntegerDefinition" title="vmware.vapi.data.definition.IntegerDefinition"><tt class="xref py py-class docutils literal"><span class="pre">IntegerDefinition</span></tt></a>) – Data definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_list">
|
|
<tt class="descname">visit_list</tt><big>(</big><em>defn</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#SimpleDefinitionVisitor.visit_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_list" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a ListDefinition</p>
|
|
<table class="docutils field-list" 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>defn</strong> (<a class="reference internal" href="#vmware.vapi.data.definition.ListDefinition" title="vmware.vapi.data.definition.ListDefinition"><tt class="xref py py-class docutils literal"><span class="pre">ListDefinition</span></tt></a>) – Data definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_opaque">
|
|
<tt class="descname">visit_opaque</tt><big>(</big><em>defn</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#SimpleDefinitionVisitor.visit_opaque"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_opaque" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a OpaqueDefinition</p>
|
|
<table class="docutils field-list" 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>defn</strong> (<a class="reference internal" href="#vmware.vapi.data.definition.OpaqueDefinition" title="vmware.vapi.data.definition.OpaqueDefinition"><tt class="xref py py-class docutils literal"><span class="pre">OpaqueDefinition</span></tt></a>) – Data definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_optional">
|
|
<tt class="descname">visit_optional</tt><big>(</big><em>defn</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#SimpleDefinitionVisitor.visit_optional"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_optional" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a OptionalDefinition</p>
|
|
<table class="docutils field-list" 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>defn</strong> (<a class="reference internal" href="#vmware.vapi.data.definition.OptionalDefinition" title="vmware.vapi.data.definition.OptionalDefinition"><tt class="xref py py-class docutils literal"><span class="pre">OptionalDefinition</span></tt></a>) – Data definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_secret">
|
|
<tt class="descname">visit_secret</tt><big>(</big><em>defn</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#SimpleDefinitionVisitor.visit_secret"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_secret" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a SecretDefinition</p>
|
|
<table class="docutils field-list" 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>defn</strong> (<a class="reference internal" href="#vmware.vapi.data.definition.SecretDefinition" title="vmware.vapi.data.definition.SecretDefinition"><tt class="xref py py-class docutils literal"><span class="pre">SecretDefinition</span></tt></a>) – Data definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_string">
|
|
<tt class="descname">visit_string</tt><big>(</big><em>defn</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#SimpleDefinitionVisitor.visit_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_string" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a StringDefinition</p>
|
|
<table class="docutils field-list" 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>defn</strong> (<a class="reference internal" href="#vmware.vapi.data.definition.StringDefinition" title="vmware.vapi.data.definition.StringDefinition"><tt class="xref py py-class docutils literal"><span class="pre">StringDefinition</span></tt></a>) – Data definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_struct">
|
|
<tt class="descname">visit_struct</tt><big>(</big><em>defn</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#SimpleDefinitionVisitor.visit_struct"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_struct" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a StructDefinition</p>
|
|
<table class="docutils field-list" 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>defn</strong> (<a class="reference internal" href="#vmware.vapi.data.definition.StructDefinition" title="vmware.vapi.data.definition.StructDefinition"><tt class="xref py py-class docutils literal"><span class="pre">StructDefinition</span></tt></a>) – Data definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_struct_ref">
|
|
<tt class="descname">visit_struct_ref</tt><big>(</big><em>defn</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#SimpleDefinitionVisitor.visit_struct_ref"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_struct_ref" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a StructRefDefinition</p>
|
|
<table class="docutils field-list" 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>defn</strong> (<a class="reference internal" href="#vmware.vapi.data.definition.StructRefDefinition" title="vmware.vapi.data.definition.StructRefDefinition"><tt class="xref py py-class docutils literal"><span class="pre">StructRefDefinition</span></tt></a>) – StructRefDefinition object</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_void">
|
|
<tt class="descname">visit_void</tt><big>(</big><em>defn</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#SimpleDefinitionVisitor.visit_void"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.SimpleDefinitionVisitor.visit_void" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a VoidDefinition</p>
|
|
<table class="docutils field-list" 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>defn</strong> (<a class="reference internal" href="#vmware.vapi.data.definition.VoidDefinition" title="vmware.vapi.data.definition.VoidDefinition"><tt class="xref py py-class docutils literal"><span class="pre">VoidDefinition</span></tt></a>) – Data definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.definition.SingletonDefinition">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.definition.</tt><tt class="descname">SingletonDefinition</tt><big>(</big><em>data_type</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#SingletonDefinition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.SingletonDefinition" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|
<p>Base class for all the primitive data definition classes. All the derived
|
|
classes of this class will have only one instance.</p>
|
|
<p>Initialize SingletonDefinition</p>
|
|
<table class="docutils field-list" 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_type</strong> (<a class="reference internal" href="#vmware.vapi.data.type.Type" title="vmware.vapi.data.type.Type"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.type.Type</span></tt></a>) – Type of the DataDefinition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.definition.StringDefinition">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.definition.</tt><tt class="descname">StringDefinition</tt><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#StringDefinition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.StringDefinition" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.data.definition.SingletonDefinition" title="vmware.vapi.data.definition.SingletonDefinition"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.definition.SingletonDefinition</span></tt></a></p>
|
|
<p>DataDefinition for strings</p>
|
|
<p>Initialize StringDefinition</p>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.StringDefinition.new_value">
|
|
<tt class="descname">new_value</tt><big>(</big><em>value=''</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#StringDefinition.new_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.StringDefinition.new_value" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Create a new 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">Return type:</th><td class="field-body"><a class="reference internal" href="#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></td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Newly created StringValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.definition.StructDefinition">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.definition.</tt><tt class="descname">StructDefinition</tt><big>(</big><em>name</em>, <em>fields</em>, <em>data_type='Structure'</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#StructDefinition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.StructDefinition" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|
<p>DataDefinition for structures</p>
|
|
<p>Initialize StructDefinition</p>
|
|
<table class="docutils field-list" 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">tuple</span></tt> of (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>, <a class="reference internal" href="#vmware.vapi.data.definition.DataDefinition" title="vmware.vapi.data.definition.DataDefinition"><tt class="xref py py-class docutils literal"><span class="pre">DataDefinition</span></tt></a>)) – A tuple consisting of the field name and the field
|
|
definition for all the fields inside this StructDefinition</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.StructDefinition.complete_value">
|
|
<tt class="descname">complete_value</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#StructDefinition.complete_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.StructDefinition.complete_value" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Fill out all the unset optional fields in a structure
|
|
based on the StructDefinition</p>
|
|
<table class="docutils field-list" 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> (<a class="reference internal" href="#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>) – Input Struct Value</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.StructDefinition.get_field">
|
|
<tt class="descname">get_field</tt><big>(</big><em>field</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#StructDefinition.get_field"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.StructDefinition.get_field" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the field definition of the specified 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"><a class="reference internal" href="#vmware.vapi.data.definition.DataDefinition" title="vmware.vapi.data.definition.DataDefinition"><tt class="xref py py-class docutils literal"><span class="pre">DataDefinition</span></tt></a></td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">field definition of the specified field</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.StructDefinition.get_field_names">
|
|
<tt class="descname">get_field_names</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#StructDefinition.get_field_names"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.StructDefinition.get_field_names" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the list of field names in this struct definition. The ordering
|
|
of fields is not preserved.</p>
|
|
<table class="docutils field-list" 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 in this struct definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.StructDefinition.new_value">
|
|
<tt class="descname">new_value</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#StructDefinition.new_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.StructDefinition.new_value" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Create a new 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">Return type:</th><td class="field-body"><a class="reference internal" href="#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">Newly created StructValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.StructDefinition.validate">
|
|
<tt class="descname">validate</tt><big>(</big><em>other</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#StructDefinition.validate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.StructDefinition.validate" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Apart from the validation checks specified in the validate
|
|
method of DataDefinition class, this method does some additional checks</p>
|
|
<p>Validation will fail if
|
|
- the name of the input StructValue does not match the name of this
|
|
StructDefinition.
|
|
- any of the fields (either required or optional) in this StructDefinition
|
|
are not present in the input StructValue
|
|
- the validation fails for any field value in the input StructValue with
|
|
its corresponding definition in this StructDefinition</p>
|
|
<p>The method performs inclusive validation. i.e. If there are any extra
|
|
fields in the input StructValue which are not present in the
|
|
StructDefinition, validation will not fail.</p>
|
|
<table class="docutils field-list" 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>other</strong> (<a class="reference internal" href="#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</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">list</span></tt> of <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> of <tt class="docutils literal"><span class="pre">None</span></tt></td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a stack of messages indicating why the value is not an instance
|
|
of this data-definition, or None if the value is an instance of
|
|
this data-definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.definition.StructRefDefinition">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.definition.</tt><tt class="descname">StructRefDefinition</tt><big>(</big><em>name</em>, <em>definition=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#StructRefDefinition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.StructRefDefinition" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|
<p>Reference to a StructDefinition. If the reference is resolved, it is
|
|
bound to a specific StructDefinition target. If the reference is
|
|
unresolved, its target is 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">Variables:</th><td class="field-body"><strong>name</strong> – Structure name</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Initialize StructRefDefinition</p>
|
|
<table class="docutils field-list" 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>) – Structure name</li>
|
|
<li><strong>definition</strong> (<a class="reference internal" href="#vmware.vapi.data.definition.DataDefinition" title="vmware.vapi.data.definition.DataDefinition"><tt class="xref py py-class docutils literal"><span class="pre">DataDefinition</span></tt></a>) – If definition is passed, it creates a resolved
|
|
reference</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.StructRefDefinition.check_resolved">
|
|
<tt class="descname">check_resolved</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#StructRefDefinition.check_resolved"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.StructRefDefinition.check_resolved" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Check if the reference is resolved or not</p>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.StructRefDefinition.complete_value">
|
|
<tt class="descname">complete_value</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#StructRefDefinition.complete_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.StructRefDefinition.complete_value" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Fill out all the unset optional fields in a structure
|
|
based on the resolved StructDefinition for this
|
|
StructRefDefinition.</p>
|
|
<table class="docutils field-list" 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> (<a class="reference internal" href="#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>) – Input StructValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="vmware.vapi.data.definition.StructRefDefinition.target">
|
|
<tt class="descname">target</tt><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#StructRefDefinition.target"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.StructRefDefinition.target" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the target structure definition of this reference.</p>
|
|
<table class="docutils field-list" 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.definition.DataDefinition" title="vmware.vapi.data.definition.DataDefinition"><tt class="xref py py-class docutils literal"><span class="pre">DataDefinition</span></tt></a> or <tt 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">The target of this reference. The value will be None for
|
|
unresolved reference</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.StructRefDefinition.validate">
|
|
<tt class="descname">validate</tt><big>(</big><em>other</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#StructRefDefinition.validate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.StructRefDefinition.validate" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Validate using the target if the reference is resolved</p>
|
|
<table class="docutils field-list" 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>other</strong> (<a class="reference internal" href="#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</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">list</span></tt> of <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> of <tt class="docutils literal"><span class="pre">None</span></tt></td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a stack of messages indicating that the reference is not
|
|
resolved or why the value is not an instance of this
|
|
data-definition, or None if the value is an instance of
|
|
this data-definition</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.definition.VoidDefinition">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.definition.</tt><tt class="descname">VoidDefinition</tt><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#VoidDefinition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.VoidDefinition" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.data.definition.SingletonDefinition" title="vmware.vapi.data.definition.SingletonDefinition"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.definition.SingletonDefinition</span></tt></a></p>
|
|
<p>DataDefinition class for void</p>
|
|
<p>Initialize VoidDefinition</p>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.definition.VoidDefinition.new_value">
|
|
<tt class="descname">new_value</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#VoidDefinition.new_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.VoidDefinition.new_value" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Create a new VoidValue</p>
|
|
<table class="docutils field-list" 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.value.VoidValue" title="vmware.vapi.data.value.VoidValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.VoidValue</span></tt></a></td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Newly created VoidValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="vmware.vapi.data.definition.data_definition_factory">
|
|
<tt class="descclassname">vmware.vapi.data.definition.</tt><tt class="descname">data_definition_factory</tt><big>(</big><em>data_type</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/definition.html#data_definition_factory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.definition.data_definition_factory" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>data definition 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"><ul class="first last simple">
|
|
<li><strong>data_type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Type name defined in vmware.vapi.data.type</li>
|
|
<li><strong>args</strong> (<tt class="xref py py-class docutils literal"><span class="pre">set</span></tt>) – Positional arguments to data definition constructor</li>
|
|
<li><strong>kwargs</strong> (<tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt>) – Dict arguments to data definition constructor</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-vmware.vapi.data.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.data.type" title="Permalink to this headline">¶</a></h2>
|
|
<p>List of Data types supported</p>
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.type.Type">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.type.</tt><tt class="descname">Type</tt><a class="reference internal" href="_modules/vmware/vapi/data/type.html#Type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.type.Type" 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>Enum of all the data types used in vAPI Runtime</p>
|
|
<dl class="attribute">
|
|
<dt id="vmware.vapi.data.type.Type.ANY_ERROR">
|
|
<tt class="descname">ANY_ERROR</tt><em class="property"> = 'AnyError'</em><a class="headerlink" href="#vmware.vapi.data.type.Type.ANY_ERROR" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="vmware.vapi.data.type.Type.BLOB">
|
|
<tt class="descname">BLOB</tt><em class="property"> = 'Blob'</em><a class="headerlink" href="#vmware.vapi.data.type.Type.BLOB" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="vmware.vapi.data.type.Type.BOOLEAN">
|
|
<tt class="descname">BOOLEAN</tt><em class="property"> = 'Boolean'</em><a class="headerlink" href="#vmware.vapi.data.type.Type.BOOLEAN" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="vmware.vapi.data.type.Type.DOUBLE">
|
|
<tt class="descname">DOUBLE</tt><em class="property"> = 'Double'</em><a class="headerlink" href="#vmware.vapi.data.type.Type.DOUBLE" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="vmware.vapi.data.type.Type.DYNAMIC_STRUCTURE">
|
|
<tt class="descname">DYNAMIC_STRUCTURE</tt><em class="property"> = 'DynamicStructure'</em><a class="headerlink" href="#vmware.vapi.data.type.Type.DYNAMIC_STRUCTURE" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="vmware.vapi.data.type.Type.ERROR">
|
|
<tt class="descname">ERROR</tt><em class="property"> = 'Error'</em><a class="headerlink" href="#vmware.vapi.data.type.Type.ERROR" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="vmware.vapi.data.type.Type.INTEGER">
|
|
<tt class="descname">INTEGER</tt><em class="property"> = 'Integer'</em><a class="headerlink" href="#vmware.vapi.data.type.Type.INTEGER" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="vmware.vapi.data.type.Type.LIST">
|
|
<tt class="descname">LIST</tt><em class="property"> = 'List'</em><a class="headerlink" href="#vmware.vapi.data.type.Type.LIST" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="vmware.vapi.data.type.Type.OPAQUE">
|
|
<tt class="descname">OPAQUE</tt><em class="property"> = 'Opaque'</em><a class="headerlink" href="#vmware.vapi.data.type.Type.OPAQUE" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="vmware.vapi.data.type.Type.OPTIONAL">
|
|
<tt class="descname">OPTIONAL</tt><em class="property"> = 'Optional'</em><a class="headerlink" href="#vmware.vapi.data.type.Type.OPTIONAL" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="vmware.vapi.data.type.Type.SECRET">
|
|
<tt class="descname">SECRET</tt><em class="property"> = 'Secret'</em><a class="headerlink" href="#vmware.vapi.data.type.Type.SECRET" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="vmware.vapi.data.type.Type.STRING">
|
|
<tt class="descname">STRING</tt><em class="property"> = 'String'</em><a class="headerlink" href="#vmware.vapi.data.type.Type.STRING" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="vmware.vapi.data.type.Type.STRUCTURE">
|
|
<tt class="descname">STRUCTURE</tt><em class="property"> = 'Structure'</em><a class="headerlink" href="#vmware.vapi.data.type.Type.STRUCTURE" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="vmware.vapi.data.type.Type.STRUCTURE_REF">
|
|
<tt class="descname">STRUCTURE_REF</tt><em class="property"> = 'StructureRef'</em><a class="headerlink" href="#vmware.vapi.data.type.Type.STRUCTURE_REF" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="attribute">
|
|
<dt id="vmware.vapi.data.type.Type.VOID">
|
|
<tt class="descname">VOID</tt><em class="property"> = 'Void'</em><a class="headerlink" href="#vmware.vapi.data.type.Type.VOID" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-vmware.vapi.data.validator">
|
|
<span id="validator-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">validator</span></tt> Module<a class="headerlink" href="#module-vmware.vapi.data.validator" title="Permalink to this headline">¶</a></h2>
|
|
<p>Data Validator classes</p>
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.validator.HasFieldsOfValidator">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.validator.</tt><tt class="descname">HasFieldsOfValidator</tt><a class="reference internal" href="_modules/vmware/vapi/data/validator.html#HasFieldsOfValidator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.validator.HasFieldsOfValidator" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|
<p>HasFieldsOfValidator validator class that validates the data_value has reuired fields of the class specified</p>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.validator.HasFieldsOfValidator.validate">
|
|
<tt class="descname">validate</tt><big>(</big><em>data_value</em>, <em>data_type=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/validator.html#HasFieldsOfValidator.validate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.validator.HasFieldsOfValidator.validate" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Validates a struct value for union consistency</p>
|
|
<p>:type data_value <a class="reference internal" href="#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>
|
|
:param data_value The struct value that needs to be validated
|
|
:type data_type <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.BindingType</span></tt>
|
|
:param data_type The Struct binding type
|
|
:rtype: <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <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> or <tt class="docutils literal"><span class="pre">None</span></tt>
|
|
:return List of error messages if validation fails or None</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.validator.UnionValidator">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.validator.</tt><tt class="descname">UnionValidator</tt><big>(</big><em>discriminant_name</em>, <em>case_map</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/validator.html#UnionValidator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.validator.UnionValidator" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|
<p>Union Validator class that validates a struct value for union consistency</p>
|
|
<p>Initialize the union validator class</p>
|
|
<p>:type discriminant_name <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>
|
|
:param discriminant_name Name of a structure field that represents a</p>
|
|
<blockquote>
|
|
<div>union discriminant</div></blockquote>
|
|
<p>:type case_map <tt class="xref py py-class docutils literal"><span class="pre">dict</span></tt>
|
|
:param case_map Python dict with string value of the discriminant as</p>
|
|
<blockquote>
|
|
<div>dictionary key and list of tuple of structure field
|
|
associated with it and a boolean representing whether
|
|
it is rqeuired as dictionary value</div></blockquote>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.validator.UnionValidator.validate">
|
|
<tt class="descname">validate</tt><big>(</big><em>data_value</em>, <em>data_type=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/validator.html#UnionValidator.validate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.validator.UnionValidator.validate" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Validates a struct value for union consistency</p>
|
|
<p>:type data_value <a class="reference internal" href="#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>
|
|
:param data_value The struct value that needs to be validated
|
|
:type data_type <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.BindingType</span></tt>
|
|
:param data_type The Struct binding type
|
|
:rtype: <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <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> or <tt class="docutils literal"><span class="pre">None</span></tt>
|
|
:return List of error messages if validation fails or None</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.validator.Validator">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.validator.</tt><tt class="descname">Validator</tt><a class="reference internal" href="_modules/vmware/vapi/data/validator.html#Validator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.validator.Validator" 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 Data object validator class
|
|
This is an abstract class.</p>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.validator.Validator.validate">
|
|
<tt class="descname">validate</tt><big>(</big><em>data_value</em>, <em>data_type=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/validator.html#Validator.validate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.validator.Validator.validate" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>This method validates a data value</p>
|
|
<p>:type data_value <a class="reference internal" href="#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>
|
|
:param data_value The struct value that needs to be validated
|
|
:type data_type <tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.binding.type.BindingType</span></tt>
|
|
:param data_type The Struct binding type
|
|
:rtype: <tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <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> or <tt class="docutils literal"><span class="pre">None</span></tt>
|
|
:return List of error messages if validation fails or None</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-vmware.vapi.data.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.data.value" title="Permalink to this headline">¶</a></h2>
|
|
<p>vAPI DataValues</p>
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.value.BlobValue">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.value.</tt><tt class="descname">BlobValue</tt><big>(</big><em>value=''</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#BlobValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.BlobValue" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.data.value.PrimitiveDataValue" title="vmware.vapi.data.value.PrimitiveDataValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.PrimitiveDataValue</span></tt></a>, <a class="reference internal" href="#vmware.vapi.data.value.ComparableValueMixin" title="vmware.vapi.data.value.ComparableValueMixin"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.ComparableValueMixin</span></tt></a></p>
|
|
<p>DataValue class for binary 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">Variables:</th><td class="field-body"><strong>value</strong> – Binary present in BlobValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Initialize BooleanValue</p>
|
|
<table class="docutils field-list" 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">bytes</span></tt>) – Binary value to be initialized</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.value.BooleanValue">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.value.</tt><tt class="descname">BooleanValue</tt><big>(</big><em>value=False</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#BooleanValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.BooleanValue" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.data.value.PrimitiveDataValue" title="vmware.vapi.data.value.PrimitiveDataValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.PrimitiveDataValue</span></tt></a>, <a class="reference internal" href="#vmware.vapi.data.value.ComparableValueMixin" title="vmware.vapi.data.value.ComparableValueMixin"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.ComparableValueMixin</span></tt></a></p>
|
|
<p>DataValue class for bool 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">Variables:</th><td class="field-body"><strong>value</strong> – Bool present in BooleanValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Initialize BooleanValue</p>
|
|
<table class="docutils field-list" 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">bool</span></tt>) – Bool value to be initialized</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.value.ComparableValueMixin">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.value.</tt><tt class="descname">ComparableValueMixin</tt><a class="reference internal" href="_modules/vmware/vapi/data/value.html#ComparableValueMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.ComparableValueMixin" 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 implement the rich comparator operations.</p>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.value.DataValue">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.value.</tt><tt class="descname">DataValue</tt><big>(</big><em>data_type=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#DataValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.DataValue" 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>A piece of introspectable value in vAPI infrastructure</p>
|
|
<table class="docutils field-list" 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>type</strong> – Type of DataValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Initialize 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>data_type</strong> (<a class="reference internal" href="#vmware.vapi.data.type.Type" title="vmware.vapi.data.type.Type"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.type.Type</span></tt></a>) – Type of DataValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.DataValue.accept">
|
|
<tt class="descname">accept</tt><big>(</big><em>visitor</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#DataValue.accept"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.DataValue.accept" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Applies a visitor to this 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>visitor</strong> (<a class="reference internal" href="#vmware.vapi.data.value.SimpleValueVisitor" title="vmware.vapi.data.value.SimpleValueVisitor"><tt class="xref py py-class docutils literal"><span class="pre">SimpleValueVisitor</span></tt></a>) – visitor operating on this DataValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.value.DoubleValue">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.value.</tt><tt class="descname">DoubleValue</tt><big>(</big><em>value=0.0</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#DoubleValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.DoubleValue" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.data.value.PrimitiveDataValue" title="vmware.vapi.data.value.PrimitiveDataValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.PrimitiveDataValue</span></tt></a>, <a class="reference internal" href="#vmware.vapi.data.value.ComparableValueMixin" title="vmware.vapi.data.value.ComparableValueMixin"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.ComparableValueMixin</span></tt></a></p>
|
|
<p>DataValue class for float 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">Variables:</th><td class="field-body"><strong>value</strong> – 64 bit signed float present in DoubleValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Initialize DoubleValue</p>
|
|
<table class="docutils field-list" 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">float</span></tt> or <tt class="xref py py-class docutils literal"><span class="pre">decimal.Decimal</span></tt>) – Float or decimal.Decimal value to be initialized</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.value.ErrorValue">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.value.</tt><tt class="descname">ErrorValue</tt><big>(</big><em>name=None</em>, <em>values=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#ErrorValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.ErrorValue" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#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></p>
|
|
<p>DataValue class for Errors</p>
|
|
<p>Initialize 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>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the ErrorValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.value.IntegerValue">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.value.</tt><tt class="descname">IntegerValue</tt><big>(</big><em>value=0</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#IntegerValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.IntegerValue" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.data.value.PrimitiveDataValue" title="vmware.vapi.data.value.PrimitiveDataValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.PrimitiveDataValue</span></tt></a>, <a class="reference internal" href="#vmware.vapi.data.value.ComparableValueMixin" title="vmware.vapi.data.value.ComparableValueMixin"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.ComparableValueMixin</span></tt></a></p>
|
|
<p>DataValue class for integer 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">Variables:</th><td class="field-body"><strong>value</strong> – 64 bit signed int present in IntegerValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Initialize IntegerValue</p>
|
|
<table class="docutils field-list" 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">int</span></tt>) – Integer value to be initialized</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.value.ListValue">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.value.</tt><tt class="descname">ListValue</tt><big>(</big><em>values=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#ListValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.ListValue" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#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>
|
|
<p>DataValue class for lists</p>
|
|
<p>Initialize ListValue</p>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.ListValue.add">
|
|
<tt class="descname">add</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#ListValue.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.ListValue.add" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Add an element to 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>value</strong> (<a class="reference internal" href="#vmware.vapi.data.value.DataValue" title="vmware.vapi.data.value.DataValue"><tt class="xref py py-class docutils literal"><span class="pre">DataValue</span></tt></a>) – DataValue to be added</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.ListValue.add_all">
|
|
<tt class="descname">add_all</tt><big>(</big><em>values</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#ListValue.add_all"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.ListValue.add_all" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Add all the elements from input list to 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>values</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <a class="reference internal" href="#vmware.vapi.data.value.DataValue" title="vmware.vapi.data.value.DataValue"><tt class="xref py py-class docutils literal"><span class="pre">DataValue</span></tt></a>) – List of DataValues to be added</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.ListValue.is_empty">
|
|
<tt class="descname">is_empty</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#ListValue.is_empty"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.ListValue.is_empty" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns true if the list is empty</p>
|
|
<table class="docutils field-list" 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 list is empty, false otherwise</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.ListValue.size">
|
|
<tt class="descname">size</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#ListValue.size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.ListValue.size" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the size of the 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">Return type:</th><td class="field-body"><tt class="xref py py-class docutils literal"><span class="pre">int</span></tt></td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Size of the list value</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.value.OptionalValue">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.value.</tt><tt class="descname">OptionalValue</tt><big>(</big><em>value=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#OptionalValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.OptionalValue" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#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>, <a class="reference internal" href="#vmware.vapi.data.value.ComparableValueMixin" title="vmware.vapi.data.value.ComparableValueMixin"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.ComparableValueMixin</span></tt></a></p>
|
|
<p>DataValue class for optionals</p>
|
|
<table class="docutils field-list" 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>value</strong> – DataValue present in this OptionalValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Initialize 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>value</strong> (<a class="reference internal" href="#vmware.vapi.data.value.DataValue" title="vmware.vapi.data.value.DataValue"><tt class="xref py py-class docutils literal"><span class="pre">DataValue</span></tt></a>) – DataValue to be used in OptionalValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.OptionalValue.is_set">
|
|
<tt class="descname">is_set</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#OptionalValue.is_set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.OptionalValue.is_set" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns true if OptionalValue has a DataValue present in it</p>
|
|
<table class="docutils field-list" 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">Returns true if OptionalValue is initialized with some
|
|
DataValue, false otherwise</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.value.PrimitiveDataValue">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.value.</tt><tt class="descname">PrimitiveDataValue</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#PrimitiveDataValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.PrimitiveDataValue" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#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>
|
|
<p>Base class for all 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">Variables:</th><td class="field-body"><strong>value</strong> – Primitive value</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.value.SecretValue">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.value.</tt><tt class="descname">SecretValue</tt><big>(</big><em>value=''</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#SecretValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.SecretValue" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.data.value.PrimitiveDataValue" title="vmware.vapi.data.value.PrimitiveDataValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.PrimitiveDataValue</span></tt></a>, <a class="reference internal" href="#vmware.vapi.data.value.ComparableValueMixin" title="vmware.vapi.data.value.ComparableValueMixin"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.ComparableValueMixin</span></tt></a></p>
|
|
<p>DataValue class for secret values. Only strings are allowed to be
|
|
secrets.</p>
|
|
<table class="docutils field-list" 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>value</strong> – String present in SecretValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Initialize 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>value</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value to be initialized</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.value.SimpleValueVisitor">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.value.</tt><tt class="descname">SimpleValueVisitor</tt><a class="reference internal" href="_modules/vmware/vapi/data/value.html#SimpleValueVisitor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.SimpleValueVisitor" 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 DataValue visitor</p>
|
|
<p>Initialize SimpleValueVisitor</p>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.SimpleValueVisitor.visit_blob">
|
|
<tt class="descname">visit_blob</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#SimpleValueVisitor.visit_blob"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.SimpleValueVisitor.visit_blob" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a BlobValue</p>
|
|
<table class="docutils field-list" 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> (<a class="reference internal" href="#vmware.vapi.data.value.BlobValue" title="vmware.vapi.data.value.BlobValue"><tt class="xref py py-class docutils literal"><span class="pre">BlobValue</span></tt></a>) – Data value</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.SimpleValueVisitor.visit_boolean">
|
|
<tt class="descname">visit_boolean</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#SimpleValueVisitor.visit_boolean"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.SimpleValueVisitor.visit_boolean" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a BooleanValue</p>
|
|
<table class="docutils field-list" 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> (<a class="reference internal" href="#vmware.vapi.data.value.BooleanValue" title="vmware.vapi.data.value.BooleanValue"><tt class="xref py py-class docutils literal"><span class="pre">BooleanValue</span></tt></a>) – Data value</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.SimpleValueVisitor.visit_double">
|
|
<tt class="descname">visit_double</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#SimpleValueVisitor.visit_double"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.SimpleValueVisitor.visit_double" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a DoubleValue</p>
|
|
<table class="docutils field-list" 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> (<a class="reference internal" href="#vmware.vapi.data.value.DoubleValue" title="vmware.vapi.data.value.DoubleValue"><tt class="xref py py-class docutils literal"><span class="pre">DoubleValue</span></tt></a>) – Data value</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.SimpleValueVisitor.visit_error">
|
|
<tt class="descname">visit_error</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#SimpleValueVisitor.visit_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.SimpleValueVisitor.visit_error" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit an 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>value</strong> (<a class="reference internal" href="#vmware.vapi.data.value.ErrorValue" title="vmware.vapi.data.value.ErrorValue"><tt class="xref py py-class docutils literal"><span class="pre">ErrorValue</span></tt></a>) – Data value</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.SimpleValueVisitor.visit_integer">
|
|
<tt class="descname">visit_integer</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#SimpleValueVisitor.visit_integer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.SimpleValueVisitor.visit_integer" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a IntegerValue</p>
|
|
<table class="docutils field-list" 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> (<a class="reference internal" href="#vmware.vapi.data.value.IntegerValue" title="vmware.vapi.data.value.IntegerValue"><tt class="xref py py-class docutils literal"><span class="pre">IntegerValue</span></tt></a>) – Data value</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.SimpleValueVisitor.visit_list">
|
|
<tt class="descname">visit_list</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#SimpleValueVisitor.visit_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.SimpleValueVisitor.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>value</strong> (<a class="reference internal" href="#vmware.vapi.data.value.ListValue" title="vmware.vapi.data.value.ListValue"><tt class="xref py py-class docutils literal"><span class="pre">ListValue</span></tt></a>) – Data value</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.SimpleValueVisitor.visit_optional">
|
|
<tt class="descname">visit_optional</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#SimpleValueVisitor.visit_optional"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.SimpleValueVisitor.visit_optional" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a 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>value</strong> (<a class="reference internal" href="#vmware.vapi.data.value.OptionalValue" title="vmware.vapi.data.value.OptionalValue"><tt class="xref py py-class docutils literal"><span class="pre">OptionalValue</span></tt></a>) – Data value</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.SimpleValueVisitor.visit_secret">
|
|
<tt class="descname">visit_secret</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#SimpleValueVisitor.visit_secret"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.SimpleValueVisitor.visit_secret" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a SecretValue</p>
|
|
<table class="docutils field-list" 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> (<a class="reference internal" href="#vmware.vapi.data.value.SecretValue" title="vmware.vapi.data.value.SecretValue"><tt class="xref py py-class docutils literal"><span class="pre">SecretValue</span></tt></a>) – Data value</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.SimpleValueVisitor.visit_string">
|
|
<tt class="descname">visit_string</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#SimpleValueVisitor.visit_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.SimpleValueVisitor.visit_string" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a 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>value</strong> (<a class="reference internal" href="#vmware.vapi.data.value.StringValue" title="vmware.vapi.data.value.StringValue"><tt class="xref py py-class docutils literal"><span class="pre">StringValue</span></tt></a>) – Data value</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.SimpleValueVisitor.visit_struct">
|
|
<tt class="descname">visit_struct</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#SimpleValueVisitor.visit_struct"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.SimpleValueVisitor.visit_struct" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a 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>value</strong> (<a class="reference internal" href="#vmware.vapi.data.value.StructValue" title="vmware.vapi.data.value.StructValue"><tt class="xref py py-class docutils literal"><span class="pre">StructValue</span></tt></a>) – Data value</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.SimpleValueVisitor.visit_void">
|
|
<tt class="descname">visit_void</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#SimpleValueVisitor.visit_void"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.SimpleValueVisitor.visit_void" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Visit a VoidValue</p>
|
|
<table class="docutils field-list" 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> (<a class="reference internal" href="#vmware.vapi.data.value.VoidValue" title="vmware.vapi.data.value.VoidValue"><tt class="xref py py-class docutils literal"><span class="pre">VoidValue</span></tt></a>) – Data value</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.value.StringValue">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.value.</tt><tt class="descname">StringValue</tt><big>(</big><em>value=''</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#StringValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.StringValue" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.data.value.PrimitiveDataValue" title="vmware.vapi.data.value.PrimitiveDataValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.PrimitiveDataValue</span></tt></a>, <a class="reference internal" href="#vmware.vapi.data.value.ComparableValueMixin" title="vmware.vapi.data.value.ComparableValueMixin"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.ComparableValueMixin</span></tt></a></p>
|
|
<p>DataValue class for strings</p>
|
|
<table class="docutils field-list" 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>value</strong> – String present in StringValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Initialize 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>value</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value to be initialized</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.value.StructValue">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.value.</tt><tt class="descname">StructValue</tt><big>(</big><em>name=None</em>, <em>data_type='Structure'</em>, <em>values=None</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#StructValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.StructValue" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#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>
|
|
<p>DataValue class for Structures</p>
|
|
<table class="docutils field-list" 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>name</strong> – Name of the structure</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p>Initialize 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>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the StructValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.StructValue.get_field">
|
|
<tt class="descname">get_field</tt><big>(</big><em>field</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#StructValue.get_field"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.StructValue.get_field" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the field value of the field present in the 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>field</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the field</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.value.DataValue" title="vmware.vapi.data.value.DataValue"><tt class="xref py py-class docutils literal"><span class="pre">DataValue</span></tt></a></td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns the field value of the field present in the StructValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.StructValue.get_field_names">
|
|
<tt class="descname">get_field_names</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#StructValue.get_field_names"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.StructValue.get_field_names" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the list of field names present in this StructValue.
|
|
The ordering of fields is not preserved.</p>
|
|
<table class="docutils field-list" 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 present in this StructValue</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.StructValue.get_fields">
|
|
<tt class="descname">get_fields</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#StructValue.get_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.StructValue.get_fields" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the map of field names and values present in this
|
|
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">Return type:</th><td class="field-body"><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.data.value.DataValue" title="vmware.vapi.data.value.DataValue"><tt class="xref py py-class docutils literal"><span class="pre">DataValue</span></tt></a></td>
|
|
</tr>
|
|
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Fields in this struct value</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.StructValue.has_field">
|
|
<tt class="descname">has_field</tt><big>(</big><em>field</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#StructValue.has_field"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.StructValue.has_field" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns true if the field is present in the StructValue, false otherwise</p>
|
|
<table class="docutils field-list" 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</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the field</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">bool</span></tt></td>
|
|
</tr>
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns true if the field is present in the StructValue,
|
|
false otherwise</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
<dl class="method">
|
|
<dt id="vmware.vapi.data.value.StructValue.keys">
|
|
<tt class="descname">keys</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#StructValue.keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.StructValue.keys" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the list of field names</p>
|
|
<table class="docutils field-list" 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> or <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="method">
|
|
<dt id="vmware.vapi.data.value.StructValue.set_field">
|
|
<tt class="descname">set_field</tt><big>(</big><em>field</em>, <em>value</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#StructValue.set_field"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.StructValue.set_field" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Set the field value for the field name passed in 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"><ul class="first last simple">
|
|
<li><strong>field</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Name of the field</li>
|
|
<li><strong>field</strong> – Name of the field to be set</li>
|
|
<li><strong>value</strong> (<a class="reference internal" href="#vmware.vapi.data.value.DataValue" title="vmware.vapi.data.value.DataValue"><tt class="xref py py-class docutils literal"><span class="pre">DataValue</span></tt></a>) – DataValue to be used for the field</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
<dl class="class">
|
|
<dt id="vmware.vapi.data.value.VoidValue">
|
|
<em class="property">class </em><tt class="descclassname">vmware.vapi.data.value.</tt><tt class="descname">VoidValue</tt><a class="reference internal" href="_modules/vmware/vapi/data/value.html#VoidValue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.VoidValue" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <a class="reference internal" href="#vmware.vapi.data.value.PrimitiveDataValue" title="vmware.vapi.data.value.PrimitiveDataValue"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.data.value.PrimitiveDataValue</span></tt></a></p>
|
|
<p>DataValue class for None</p>
|
|
<p>Initialize VoidValue</p>
|
|
</dd></dl>
|
|
|
|
<dl class="function">
|
|
<dt id="vmware.vapi.data.value.data_value_factory">
|
|
<tt class="descclassname">vmware.vapi.data.value.</tt><tt class="descname">data_value_factory</tt><big>(</big><em>data_type</em>, <em>*args</em><big>)</big><a class="reference internal" href="_modules/vmware/vapi/data/value.html#data_value_factory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#vmware.vapi.data.value.data_value_factory" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Convenience method to create 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"><ul class="first last simple">
|
|
<li><strong>data_type</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String representation of the data value type</li>
|
|
<li><strong>args</strong> – The argument list to be passed to the data value constructor</li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="subpackages">
|
|
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="vmware.vapi.data.serializers.html">serializers Package</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.data.serializers.html#id1"><tt class="docutils literal"><span class="pre">serializers</span></tt> Package</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.data.serializers.html#module-vmware.vapi.data.serializers.cleanjson"><tt class="docutils literal"><span class="pre">cleanjson</span></tt> Module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.data.serializers.html#module-vmware.vapi.data.serializers.introspection"><tt class="docutils literal"><span class="pre">introspection</span></tt> Module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.data.serializers.html#module-vmware.vapi.data.serializers.jsonrpc"><tt class="docutils literal"><span class="pre">jsonrpc</span></tt> Module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.data.serializers.html#module-vmware.vapi.data.serializers.python"><tt class="docutils literal"><span class="pre">python</span></tt> Module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="vmware.vapi.data.serializers.html#subpackages">Subpackages</a><ul class="simple">
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</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="#">data Package</a><ul>
|
|
<li><a class="reference internal" href="#id1"><tt class="docutils literal"><span class="pre">data</span></tt> Package</a></li>
|
|
<li><a class="reference internal" href="#module-vmware.vapi.data.definition"><tt class="docutils literal"><span class="pre">definition</span></tt> Module</a></li>
|
|
<li><a class="reference internal" href="#module-vmware.vapi.data.type"><tt class="docutils literal"><span class="pre">type</span></tt> Module</a></li>
|
|
<li><a class="reference internal" href="#module-vmware.vapi.data.validator"><tt class="docutils literal"><span class="pre">validator</span></tt> Module</a></li>
|
|
<li><a class="reference internal" href="#module-vmware.vapi.data.value"><tt class="docutils literal"><span class="pre">value</span></tt> Module</a></li>
|
|
<li><a class="reference internal" href="#subpackages">Subpackages</a><ul>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="vmware.vapi.bindings.html"
|
|
title="previous chapter">bindings Package</a></p>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="vmware.vapi.data.serializers.html"
|
|
title="next chapter">serializers Package</a></p>
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="_sources/vmware.vapi.data.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.serializers.html" title="serializers Package"
|
|
>next</a> |</li>
|
|
<li class="right" >
|
|
<a href="vmware.vapi.bindings.html" title="bindings Package"
|
|
>previous</a> |</li>
|
|
<li><a href="index.html">vSphere Automation SDK for Python 6.5.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> |