mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 17:39:59 -05:00
3401 lines
284 KiB
HTML
3401 lines
284 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<title>com.vmware.vapi.metadata package — vSphere Automation SDK for Python. 6.8.7 documentation</title>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||
|
||
|
||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||
|
||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="com.vmware.vapi.metadata.authentication package" href="com.vmware.vapi.metadata.authentication.html" />
|
||
<link rel="prev" title="com.vmware.vapi package" href="com.vmware.vapi.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
|
||
|
||
<div class="wy-grid-for-nav">
|
||
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python.
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div class="version">
|
||
6.8.7
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
||
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
||
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
||
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
|
||
</ul>
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
||
|
||
<nav class="wy-nav-top" aria-label="top navigation">
|
||
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">vSphere Automation SDK for Python.</a>
|
||
|
||
</nav>
|
||
|
||
|
||
<div class="wy-nav-content">
|
||
|
||
<div class="rst-content">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
|
||
<ul class="wy-breadcrumbs">
|
||
|
||
<li><a href="index.html">Docs</a> »</li>
|
||
|
||
<li><a href="com.html">com package</a> »</li>
|
||
|
||
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
||
|
||
<li><a href="com.vmware.vapi.html">com.vmware.vapi package</a> »</li>
|
||
|
||
<li>com.vmware.vapi.metadata package</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
<a href="_sources/com.vmware.vapi.metadata.rst.txt" rel="nofollow"> View page source</a>
|
||
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<div class="section" id="module-com.vmware.vapi.metadata">
|
||
<span id="com-vmware-vapi-metadata-package"></span><h1>com.vmware.vapi.metadata package<a class="headerlink" href="#module-com.vmware.vapi.metadata" title="Permalink to this headline">¶</a></h1>
|
||
<div class="section" id="subpackages">
|
||
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
||
<div class="toctree-wrapper compound">
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html">com.vmware.vapi.metadata.authentication package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html#module-com.vmware.vapi.metadata.authentication.service_client">com.vmware.vapi.metadata.authentication.service_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html">com.vmware.vapi.metadata.metamodel package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#module-com.vmware.vapi.metadata.metamodel.resource_client">com.vmware.vapi.metadata.metamodel.resource_client module</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#module-com.vmware.vapi.metadata.metamodel.service_client">com.vmware.vapi.metadata.metamodel.service_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html">com.vmware.vapi.metadata.privilege package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html#module-com.vmware.vapi.metadata.privilege.service_client">com.vmware.vapi.metadata.privilege.service_client module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="submodules">
|
||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vapi.metadata.authentication_client">
|
||
<span id="com-vmware-vapi-metadata-authentication-client-module"></span><h2>com.vmware.vapi.metadata.authentication_client module<a class="headerlink" href="#module-com.vmware.vapi.metadata.authentication_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.authentication_client</span></code> module provides classes
|
||
that expose authentication information for operation elements across all the
|
||
service elements.</p>
|
||
<p>To calculate the effective authentication information for an operation element,
|
||
you should first see if there is an authentication scheme specified for the
|
||
operation element. If it is not specified, then authentication scheme for the
|
||
service element that contains this operation element is used. If it is not
|
||
specified for the service element as well, then the authentication scheme for
|
||
the package element that contains this service element is used.</p>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.AuthenticationInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.authentication_client.</code><code class="descname">AuthenticationInfo</code><span class="sig-paren">(</span><em>scheme_type=None</em>, <em>session_manager=None</em>, <em>scheme=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.AuthenticationInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">AuthenticationInfo</span></code> class describes the authentication information.
|
||
Authentication information could be specified for a package element,
|
||
service elenent or an operation element.</p>
|
||
<p>Using the authentication scheme information, a client invoking an API call
|
||
from any class can figure out what kind of credentials are needed for that
|
||
API call.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>scheme_type</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.AuthenticationInfo.SchemeType" title="com.vmware.vapi.metadata.authentication_client.AuthenticationInfo.SchemeType"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuthenticationInfo.SchemeType</span></code></a>) – The type of the authentication scheme.</p></li>
|
||
<li><p><strong>session_manager</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – In a session aware authentication scheme, a session manager is
|
||
required that supports <code class="docutils literal notranslate"><span class="pre">create</span></code>, <code class="docutils literal notranslate"><span class="pre">delete</span></code> and <code class="docutils literal notranslate"><span class="pre">keepAlive</span></code>
|
||
methods. The fully qualified class name of the session manager is
|
||
provided in <code class="xref py py-attr docutils literal notranslate"><span class="pre">AuthenticationInfo.session_manager</span></code> attribute.
|
||
This class is responsible for handling sessions.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">schemeType</span></code> is
|
||
<a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.AuthenticationInfo.SchemeType.SESSION_AWARE" title="com.vmware.vapi.metadata.authentication_client.AuthenticationInfo.SchemeType.SESSION_AWARE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AuthenticationInfo.SchemeType.SESSION_AWARE</span></code></a>.</p></li>
|
||
<li><p><strong>scheme</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>String identifier of the authentication scheme.</p>
|
||
<p>Following are the supported authentication schemes by the
|
||
infrastructure:</p>
|
||
<ul>
|
||
<li><p>The identifier <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.security.saml_hok_token</span></code>
|
||
for SAML holder of key token based authentication mechanism.</p></li>
|
||
<li><p>The identifier <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.security.bearer_token</span></code> for
|
||
SAML bearer token based authentication mechanism.</p></li>
|
||
<li><p>The identifier <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.security.session_id</span></code> for
|
||
session based authentication mechanism.</p></li>
|
||
<li><p>The identifier <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std.security.user_pass</span></code> for
|
||
username and password based authentication mechanism.</p></li>
|
||
</ul>
|
||
</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.AuthenticationInfo.SchemeType">
|
||
<em class="property">class </em><code class="descname">SchemeType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.AuthenticationInfo.SchemeType" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">AuthenticationInfo.SchemeType</span></code> class provides class attributes for
|
||
the set of valid authentication scheme types.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">SchemeType</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.AuthenticationInfo.SchemeType.SESSIONLESS">
|
||
<code class="descname">SESSIONLESS</code><em class="property"> = SchemeType(string='SESSIONLESS')</em><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.AuthenticationInfo.SchemeType.SESSIONLESS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates that the scheme is a session less authentication scheme, the user
|
||
is authenticated on every method. There is no explicit session
|
||
establishment.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.AuthenticationInfo.SchemeType.SESSION_AWARE">
|
||
<code class="descname">SESSION_AWARE</code><em class="property"> = SchemeType(string='SESSION_AWARE')</em><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.AuthenticationInfo.SchemeType.SESSION_AWARE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates that the scheme is a session aware authentication scheme. It
|
||
requires an explicit login before executing a method and logout when a
|
||
session terminates. A class might choose to have a session aware scheme if
|
||
it wants to associate some state corresponding to the user until the user
|
||
logs out or if it wants to mitigate the cost of authenticating the user on
|
||
every method.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.Component">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.authentication_client.</code><code class="descname">Component</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.Component" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Component</span></code> class provides methods to retrieve authentication
|
||
information of a component element.</p>
|
||
<p>A component element is said to contain authentication information if any
|
||
one of package elements contained in it has authentication information.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.Component.RESOURCE_TYPE">
|
||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vapi.component'</em><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.Component.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resource type for component.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.Component.fingerprint">
|
||
<code class="descname">fingerprint</code><span class="sig-paren">(</span><em>component_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.Component.fingerprint" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieves the fingerprint computed from the authentication metadata of
|
||
the component element corresponding to <code class="docutils literal notranslate"><span class="pre">component_id</span></code>.</p>
|
||
<p>The fingerprint provides clients an efficient way to check if the
|
||
metadata for a particular component has been modified on the server.
|
||
The client can do this by comparing the result of this operation with
|
||
the fingerprint returned in the result of <a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.Component.get" title="com.vmware.vapi.metadata.authentication_client.Component.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Component.get()</span></code></a>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>component_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component element.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.component</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The fingerprint computed from the authentication metadata of the
|
||
component.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the component element associated with <code class="docutils literal notranslate"><span class="pre">component_id</span></code> does not
|
||
have any authentication information.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.Component.get">
|
||
<code class="descname">get</code><span class="sig-paren">(</span><em>component_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.Component.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieves authentication information about the component element
|
||
corresponding to <code class="docutils literal notranslate"><span class="pre">component_id</span></code>.</p>
|
||
<p>The <a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.ComponentData" title="com.vmware.vapi.metadata.authentication_client.ComponentData"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentData</span></code></a> contains the authentication information
|
||
about the component element and it’s fingerprint. It contains
|
||
information about all the package elements that belong to this
|
||
component element.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>component_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component element.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.component</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.ComponentData" title="com.vmware.vapi.metadata.authentication_client.ComponentData"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentData</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.ComponentData" title="com.vmware.vapi.metadata.authentication_client.ComponentData"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentData</span></code></a> instance that corresponds to
|
||
<code class="docutils literal notranslate"><span class="pre">component_id</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the component element associated with <code class="docutils literal notranslate"><span class="pre">component_id</span></code> does not
|
||
have any authentication information.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.Component.list">
|
||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.Component.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the identifiers for the component elements that have
|
||
authentication information.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.Component.list" title="com.vmware.vapi.metadata.authentication_client.Component.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The list of identifiers for the component elements that have
|
||
authentication information.
|
||
The return value will contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.component</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.ComponentData">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.authentication_client.</code><code class="descname">ComponentData</code><span class="sig-paren">(</span><em>info=None</em>, <em>fingerprint=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.ComponentData" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ComponentData</span></code> class contains the authentication information of the
|
||
component along with its fingerprint.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>info</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.ComponentInfo" title="com.vmware.vapi.metadata.authentication_client.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentInfo</span></code></a>) – Authentication information of the component. This includes
|
||
information about all the modules in the component.</p></li>
|
||
<li><p><strong>fingerprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Fingerprint of the metadata of the component.</p>
|
||
<p>Authentication information could change when there is an
|
||
infrastructure update. Since the data present in
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">ComponentData.info</span></code> could be quite large, <code class="docutils literal notranslate"><span class="pre">fingerprint</span></code>
|
||
provides a convenient way to check if the data for a particular
|
||
component is updated.</p>
|
||
<p>You should store the fingerprint associated with a component. After
|
||
an update, by invoking the <a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.Component.fingerprint" title="com.vmware.vapi.metadata.authentication_client.Component.fingerprint"><code class="xref py py-func docutils literal notranslate"><span class="pre">Component.fingerprint()</span></code></a> method,
|
||
you can retrieve the new fingerprint for the component. If the new
|
||
fingerprint and the previously stored fingerprint do not match,
|
||
clients can then use the <a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.Component.get" title="com.vmware.vapi.metadata.authentication_client.Component.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Component.get()</span></code></a> to retrieve the new
|
||
authentication information for the component.</p>
|
||
</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.ComponentInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.authentication_client.</code><code class="descname">ComponentInfo</code><span class="sig-paren">(</span><em>packages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.ComponentInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ComponentInfo</span></code> class contains authentication information of a
|
||
component element.</p>
|
||
<p>For an explanation of authentication information contained within component
|
||
elements, see <a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.Component" title="com.vmware.vapi.metadata.authentication_client.Component"><code class="xref py py-class docutils literal notranslate"><span class="pre">Component</span></code></a>.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>packages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.PackageInfo" title="com.vmware.vapi.metadata.authentication_client.PackageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackageInfo</span></code></a>) – <p>Authentication information of all the package elements. The key in
|
||
the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the identifier of the package element and the
|
||
value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the authentication information for
|
||
the package element.</p>
|
||
<p>For an explanation of authentication information containment within
|
||
package elements, see <a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.Package" title="com.vmware.vapi.metadata.authentication_client.Package"><code class="xref py py-class docutils literal notranslate"><span class="pre">Package</span></code></a>.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.package</span></code>. When methods return a value of
|
||
this class as a return value, the key in the attribute
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.package</span></code>.</p>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.OperationInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.authentication_client.</code><code class="descname">OperationInfo</code><span class="sig-paren">(</span><em>schemes=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.OperationInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">OperationInfo</span></code> class contains authentication information of an
|
||
operation element.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>schemes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.AuthenticationInfo" title="com.vmware.vapi.metadata.authentication_client.AuthenticationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuthenticationInfo</span></code></a>) – List of authentication schemes used by an operation element. The
|
||
authentication scheme specified on the service element
|
||
corresponding to this operation element is ignored.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.Package">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.authentication_client.</code><code class="descname">Package</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.Package" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Package</span></code> class provides methods to retrieve authentication
|
||
information of a package element.</p>
|
||
<p>A package element is said to contain authentication information if there is
|
||
a default authentication assigned to all service elements contained in the
|
||
package element or if one of the service element contained in this package
|
||
element has authentication information.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.Package.RESOURCE_TYPE">
|
||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vapi.package'</em><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.Package.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resource type for package.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.Package.get">
|
||
<code class="descname">get</code><span class="sig-paren">(</span><em>package_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.Package.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieves authentication information about the package element
|
||
corresponding to <code class="docutils literal notranslate"><span class="pre">package_id</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>package_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the package element.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.package</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.PackageInfo" title="com.vmware.vapi.metadata.authentication_client.PackageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackageInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.PackageInfo" title="com.vmware.vapi.metadata.authentication_client.PackageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackageInfo</span></code></a> instance that corresponds to
|
||
<code class="docutils literal notranslate"><span class="pre">package_id</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the package element associated with <code class="docutils literal notranslate"><span class="pre">package_id</span></code> does not have
|
||
any authentication information.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.Package.list">
|
||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.Package.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the identifiers for the package elements that have
|
||
authentication information.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.Package.list" title="com.vmware.vapi.metadata.authentication_client.Package.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The list of identifiers for the package elements that have
|
||
authentication information.
|
||
The return value will contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.package</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.PackageInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.authentication_client.</code><code class="descname">PackageInfo</code><span class="sig-paren">(</span><em>schemes=None</em>, <em>services=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.PackageInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">PackageInfo</span></code> class contains authentication information of a package
|
||
element.</p>
|
||
<p>For an explanation of authentication information contained within package
|
||
elements, see <a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.Package" title="com.vmware.vapi.metadata.authentication_client.Package"><code class="xref py py-class docutils literal notranslate"><span class="pre">Package</span></code></a>.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>schemes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.AuthenticationInfo" title="com.vmware.vapi.metadata.authentication_client.AuthenticationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuthenticationInfo</span></code></a>) – List of authentication schemes to be used for all the operation
|
||
elements contained in this package element. If a particular service
|
||
or operation element has no explicit authentications defined in the
|
||
authentication defintion file, these authentication schemes are
|
||
used for authenticating the user.</p></li>
|
||
<li><p><strong>services</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.ServiceInfo" title="com.vmware.vapi.metadata.authentication_client.ServiceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceInfo</span></code></a>) – <p>Information about all service elements contained in this package
|
||
element that contain authentication information. The key in the
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the identifier of the service element and the
|
||
value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the authentication information for
|
||
the service element.</p>
|
||
<p>For an explanation of authentication information containment within
|
||
service elements, see <a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.Service" title="com.vmware.vapi.metadata.authentication_client.Service"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service</span></code></a>.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>. When methods return a value of
|
||
this class as a return value, the key in the attribute
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p>
|
||
</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.Service">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.authentication_client.</code><code class="descname">Service</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.Service" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Service</span></code> class provides methods to retrieve authentication
|
||
information of a service element.</p>
|
||
<p>A service element is said to contain authentication information if there is
|
||
a default authentication assigned to all operation elements contained in a
|
||
service element or if one of the operation elements contained in this
|
||
service element has authentication information.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.Service.RESOURCE_TYPE">
|
||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vapi.service'</em><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.Service.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resource type for service.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.Service.get">
|
||
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.Service.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieves authentication information about the service element
|
||
corresponding to <code class="docutils literal notranslate"><span class="pre">service_id</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.ServiceInfo" title="com.vmware.vapi.metadata.authentication_client.ServiceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.ServiceInfo" title="com.vmware.vapi.metadata.authentication_client.ServiceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceInfo</span></code></a> instance that corresponds to
|
||
<code class="docutils literal notranslate"><span class="pre">service_id</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the service element associated with <code class="docutils literal notranslate"><span class="pre">service_id</span></code> does not have
|
||
any authentication information.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.Service.list">
|
||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.Service.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the identifiers for the service elements that have
|
||
authentication information.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.Service.list" title="com.vmware.vapi.metadata.authentication_client.Service.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The list of identifiers for the service elements that have
|
||
authentication information.
|
||
The return value will contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.ServiceInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.authentication_client.</code><code class="descname">ServiceInfo</code><span class="sig-paren">(</span><em>schemes=None</em>, <em>operations=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.ServiceInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ServiceInfo</span></code> class contains authentication information of a service
|
||
element.</p>
|
||
<p>For an explanation of authentication information contained within service
|
||
elements, see <a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.Service" title="com.vmware.vapi.metadata.authentication_client.Service"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service</span></code></a>.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>schemes</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.AuthenticationInfo" title="com.vmware.vapi.metadata.authentication_client.AuthenticationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuthenticationInfo</span></code></a>) – List of authentication schemes to be used for all the operation
|
||
elements contained in this service element. The authentication
|
||
scheme specified on the package element corresponding to this
|
||
service element is ignored.</p></li>
|
||
<li><p><strong>operations</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.authentication_client.OperationInfo" title="com.vmware.vapi.metadata.authentication_client.OperationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">OperationInfo</span></code></a>) – <p>Information about all operation elements contained in this service
|
||
element that contain authentication information. The key in the
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the identifier of the operation element and the
|
||
value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the authentication information for
|
||
the operation element.</p>
|
||
<p>For an explanation of containment of authentication information
|
||
within operation elements, see
|
||
<a class="reference internal" href="com.vmware.vapi.metadata.authentication.html#com.vmware.vapi.metadata.authentication.service_client.Operation" title="com.vmware.vapi.metadata.authentication.service_client.Operation"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.authentication.service_client.Operation</span></code></a>.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>. When methods return a value of
|
||
this class as a return value, the key in the attribute
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p>
|
||
</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.authentication_client.StubFactory">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.authentication_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.authentication_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vapi.metadata.cli_client">
|
||
<span id="com-vmware-vapi-metadata-cli-client-module"></span><h2>com.vmware.vapi.metadata.cli_client module<a class="headerlink" href="#module-com.vmware.vapi.metadata.cli_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.cli_client</span></code> module provides classes that expose
|
||
all the information required to display namespace or command help, execute a
|
||
command and display it’s result.</p>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.cli_client.</code><code class="descname">Command</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Command</span></code> class provides methods to get information about command
|
||
line interface (CLI) commands.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.FormatterType">
|
||
<em class="property">class </em><code class="descname">FormatterType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.FormatterType" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Command.FormatterType</span></code> class defines supported CLI output formatter
|
||
types. See <code class="xref py py-attr docutils literal notranslate"><span class="pre">Command.Info.formatter</span></code>.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">FormatterType</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.FormatterType.CSV">
|
||
<code class="descname">CSV</code><em class="property"> = FormatterType(string='CSV')</em><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.FormatterType.CSV" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Displays command output in CSV format.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.FormatterType.HTML">
|
||
<code class="descname">HTML</code><em class="property"> = FormatterType(string='HTML')</em><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.FormatterType.HTML" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Displays command output in HTML format.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.FormatterType.JSON">
|
||
<code class="descname">JSON</code><em class="property"> = FormatterType(string='JSON')</em><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.FormatterType.JSON" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Displays command output in JSON format.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.FormatterType.SIMPLE">
|
||
<code class="descname">SIMPLE</code><em class="property"> = FormatterType(string='SIMPLE')</em><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.FormatterType.SIMPLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Displays command output as it is.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.FormatterType.TABLE">
|
||
<code class="descname">TABLE</code><em class="property"> = FormatterType(string='TABLE')</em><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.FormatterType.TABLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Displays command output in table format.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.FormatterType.XML">
|
||
<code class="descname">XML</code><em class="property"> = FormatterType(string='XML')</em><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.FormatterType.XML" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Displays command output in XML format.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.GenericType">
|
||
<em class="property">class </em><code class="descname">GenericType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.GenericType" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Command.GenericType</span></code> class defines generic types supported by
|
||
<code class="docutils literal notranslate"><span class="pre">Command</span></code> class. See <code class="xref py py-attr docutils literal notranslate"><span class="pre">Command.OptionInfo.generic</span></code>.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">GenericType</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.GenericType.LIST">
|
||
<code class="descname">LIST</code><em class="property"> = GenericType(string='LIST')</em><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.GenericType.LIST" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Input parameter is a list.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.GenericType.LIST_OPTIONAL">
|
||
<code class="descname">LIST_OPTIONAL</code><em class="property"> = GenericType(string='LIST_OPTIONAL')</em><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.GenericType.LIST_OPTIONAL" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Input parameter is a list of optionals. This class attribute was added in
|
||
vSphere API 6.5.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.GenericType.NONE">
|
||
<code class="descname">NONE</code><em class="property"> = GenericType(string='NONE')</em><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.GenericType.NONE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Default case.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.GenericType.OPTIONAL">
|
||
<code class="descname">OPTIONAL</code><em class="property"> = GenericType(string='OPTIONAL')</em><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.GenericType.OPTIONAL" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Input parameter is an optional.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.GenericType.OPTIONAL_LIST">
|
||
<code class="descname">OPTIONAL_LIST</code><em class="property"> = GenericType(string='OPTIONAL_LIST')</em><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.GenericType.OPTIONAL_LIST" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Input parameter is an optional of type list. This class attribute was added
|
||
in vSphere API 6.5.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.Identity">
|
||
<em class="property">class </em><code class="descname">Identity</code><span class="sig-paren">(</span><em>path=None</em>, <em>name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.Identity" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Command.Identity</span></code> class uniquely identifies a command in the CLI
|
||
commands tree.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The dot-separated path of the namespace containing the command in
|
||
the CLI command tree.</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the command.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.Info">
|
||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>identity=None</em>, <em>description=None</em>, <em>service_id=None</em>, <em>operation_id=None</em>, <em>options=None</em>, <em>formatter=None</em>, <em>output_field_list=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Command.Info</span></code> class contains information about a command. It
|
||
includes the identity of the command, a description, information about the
|
||
class and method that implement the command, and CLI-specific information
|
||
for the command.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>identity</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.cli_client.Command.Identity" title="com.vmware.vapi.metadata.cli_client.Command.Identity"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command.Identity</span></code></a>) – Basic command identity.</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The text description displayed to the user in help output.</p></li>
|
||
<li><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The service identifier that contains the operations for this CLI
|
||
command.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p></li>
|
||
<li><p><strong>operation_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The operation identifier corresponding to this CLI command.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
|
||
<li><p><strong>options</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vapi.metadata.cli_client.Command.OptionInfo" title="com.vmware.vapi.metadata.cli_client.Command.OptionInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command.OptionInfo</span></code></a>) – The input for this command.</p></li>
|
||
<li><p><strong>formatter</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.cli_client.Command.FormatterType" title="com.vmware.vapi.metadata.cli_client.Command.FormatterType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command.FormatterType</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The formatter to use when displaying the output of this command.
|
||
If not present, client can choose a default output formatter.</p></li>
|
||
<li><p><strong>output_field_list</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vapi.metadata.cli_client.Command.OutputInfo" title="com.vmware.vapi.metadata.cli_client.Command.OutputInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command.OutputInfo</span></code></a>) – List of output structure name and output field info.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.OptionInfo">
|
||
<em class="property">class </em><code class="descname">OptionInfo</code><span class="sig-paren">(</span><em>long_option=None</em>, <em>short_option=None</em>, <em>field_name=None</em>, <em>description=None</em>, <em>type=None</em>, <em>generic=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.OptionInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Command.OptionInfo</span></code> class describes information about a specific
|
||
input option of a command.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>long_option</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The long option name of the parameter as used by the user.</p></li>
|
||
<li><p><strong>short_option</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The single character value option name.
|
||
If not present, there’s no single character option for the
|
||
parameter.</p></li>
|
||
<li><p><strong>field_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The fully qualified name of the option referred to by the operation
|
||
element in <code class="xref py py-attr docutils literal notranslate"><span class="pre">Command.Info.operation_id</span></code>.</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The description of the option to be displayed to the user when they
|
||
request usage information for a CLI command.</p></li>
|
||
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The type of option. This is used to display information about what
|
||
kind of data is expected (string, number, boolean, etc.) for the
|
||
option when they request usage information for a CLI command. For
|
||
class this stores the fully qualified class id.</p></li>
|
||
<li><p><strong>generic</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.cli_client.Command.GenericType" title="com.vmware.vapi.metadata.cli_client.Command.GenericType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command.GenericType</span></code></a>) – This is used to tell the user whether the option is required or
|
||
optional, or whether they can specify the option multiple times.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.OutputFieldInfo">
|
||
<em class="property">class </em><code class="descname">OutputFieldInfo</code><span class="sig-paren">(</span><em>field_name=None</em>, <em>display_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.OutputFieldInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Command.OutputFieldInfo</span></code> class describes the name used by the CLI to
|
||
display a single attribute of a class element in the interface definition
|
||
language.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>field_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the attribute.</p></li>
|
||
<li><p><strong>display_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name used by the CLI to display the attribute.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.OutputInfo">
|
||
<em class="property">class </em><code class="descname">OutputInfo</code><span class="sig-paren">(</span><em>structure_id=None</em>, <em>output_fields=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.OutputInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Command.OutputInfo</span></code> class describes the names used by the CLI to
|
||
display the attributes of a class element in the interface definition
|
||
language as well as the order in which the attributes will be displayed.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>structure_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the class.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.</p></li>
|
||
<li><p><strong>output_fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vapi.metadata.cli_client.Command.OutputFieldInfo" title="com.vmware.vapi.metadata.cli_client.Command.OutputFieldInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command.OutputFieldInfo</span></code></a>) – The order in which the attributes of the class will be displayed by
|
||
the CLI as well as the names used to display the attributes.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.fingerprint">
|
||
<code class="descname">fingerprint</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.fingerprint" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the aggregate fingerprint of all the command metadata from all
|
||
the metadata sources.</p>
|
||
<p>The fingerprint provides clients an efficient way to check if the
|
||
metadata for commands has been modified on the server.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Fingerprint of all the command metadata present on the server.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.get">
|
||
<code class="descname">get</code><span class="sig-paren">(</span><em>identity</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieves information about a command including information about how
|
||
to execute that command.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>identity</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.cli_client.Command.Identity" title="com.vmware.vapi.metadata.cli_client.Command.Identity"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command.Identity</span></code></a>) – Identifier of the command for which to retreive information.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vapi.metadata.cli_client.Command.Info" title="com.vmware.vapi.metadata.cli_client.Command.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Information about the command including information about how to
|
||
execute that command.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if a command corresponding to <code class="docutils literal notranslate"><span class="pre">identity</span></code> doesn’t exist.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Command.list">
|
||
<code class="descname">list</code><span class="sig-paren">(</span><em>path=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Command.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the identifiers of all commands, or commands in a specific
|
||
namespace.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The dot-separated path of the namespace for which command
|
||
identifiers should be returned.
|
||
If None identifiers of all commands registered with the
|
||
infrastructure will be returned.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vapi.metadata.cli_client.Command.list" title="com.vmware.vapi.metadata.cli_client.Command.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vapi.metadata.cli_client.Command.Identity" title="com.vmware.vapi.metadata.cli_client.Command.Identity"><code class="xref py py-class docutils literal notranslate"><span class="pre">Command.Identity</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Identifiers of the requested commands.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if a namespace corresponding to <code class="docutils literal notranslate"><span class="pre">path</span></code> doesn’t exist.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Namespace">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.cli_client.</code><code class="descname">Namespace</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Namespace" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Namespace</span></code> class provides methods to get information about command
|
||
line interface (CLI) namespaces.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Namespace.Identity">
|
||
<em class="property">class </em><code class="descname">Identity</code><span class="sig-paren">(</span><em>path=None</em>, <em>name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Namespace.Identity" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Namespace.Identity</span></code> class uniquely identifies a namespace in the CLI
|
||
namespace tree.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The dot-separated path of the namespace containing the namespace in
|
||
the CLI node tree. For top-level namespace this will be empty.</p></li>
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The name displayed to the user for this namespace.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Namespace.Info">
|
||
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>identity=None</em>, <em>description=None</em>, <em>children=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Namespace.Info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Namespace.Info</span></code> class contains information about a namespace. It
|
||
includes the identity of the namespace, a description, information children
|
||
namespaces.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>identity</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.cli_client.Namespace.Identity" title="com.vmware.vapi.metadata.cli_client.Namespace.Identity"><code class="xref py py-class docutils literal notranslate"><span class="pre">Namespace.Identity</span></code></a>) – Basic namespace identity.</p></li>
|
||
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The text description displayed to the user in help output.</p></li>
|
||
<li><p><strong>children</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vapi.metadata.cli_client.Namespace.Identity" title="com.vmware.vapi.metadata.cli_client.Namespace.Identity"><code class="xref py py-class docutils literal notranslate"><span class="pre">Namespace.Identity</span></code></a>) – The children of this namespace in the tree of CLI namespaces.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Namespace.fingerprint">
|
||
<code class="descname">fingerprint</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Namespace.fingerprint" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the aggregate fingerprint of all the namespace metadata from
|
||
all the metadata sources.</p>
|
||
<p>The fingerprint provides clients an efficient way to check if the
|
||
metadata for namespaces has been modified on the server.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Fingerprint of all the namespace metadata present on the server.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Namespace.get">
|
||
<code class="descname">get</code><span class="sig-paren">(</span><em>identity</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Namespace.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retreives information about a namespace including information about
|
||
children of that namespace.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>identity</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.cli_client.Namespace.Identity" title="com.vmware.vapi.metadata.cli_client.Namespace.Identity"><code class="xref py py-class docutils literal notranslate"><span class="pre">Namespace.Identity</span></code></a>) – Identifier of the namespace for which to retreive information.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vapi.metadata.cli_client.Namespace.Info" title="com.vmware.vapi.metadata.cli_client.Namespace.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Namespace.Info</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>Information about the namespace including information about child
|
||
of that namespace.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if a namespace corresponding to <code class="docutils literal notranslate"><span class="pre">identity</span></code> doesn’t exist.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.Namespace.list">
|
||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.Namespace.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the identifiers of all namespaces registered with the
|
||
infrastructure.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vapi.metadata.cli_client.Namespace.list" title="com.vmware.vapi.metadata.cli_client.Namespace.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.vapi.metadata.cli_client.Namespace.Identity" title="com.vmware.vapi.metadata.cli_client.Namespace.Identity"><code class="xref py py-class docutils literal notranslate"><span class="pre">Namespace.Identity</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Identifiers of all the namespaces.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.cli_client.StubFactory">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.cli_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.cli_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vapi.metadata.metamodel_client">
|
||
<span id="com-vmware-vapi-metadata-metamodel-client-module"></span><h2>com.vmware.vapi.metadata.metamodel_client module<a class="headerlink" href="#module-com.vmware.vapi.metadata.metamodel_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.metamodel_client</span></code> module provides classes that
|
||
expose all the information present in the interface definition language (IDL)
|
||
specification.</p>
|
||
<p>Metamodel metadata is organized into an hierarchy of elements. The main
|
||
elements are:</p>
|
||
<ul class="simple">
|
||
<li><p>Enumeration: An enumeration element that has a list of enumeration value
|
||
elements.</p></li>
|
||
<li><p>Constant: A constant element has a name and a value.</p></li>
|
||
<li><p>Structure: A structure element can have field elements, constant elements and
|
||
enumeration elements.</p></li>
|
||
<li><p>Operation: An operation has a list of parameter elements, result element and
|
||
error elements.</p></li>
|
||
<li><p>Service: A service is a collection of operation elements, structure elements,
|
||
enumerated elements and constant elements.</p></li>
|
||
<li><p>Package: A package is a collection of service elements, structure elements
|
||
and enumeration elements.</p></li>
|
||
<li><p>Component: A component is a collection of package elements.</p></li>
|
||
</ul>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.metamodel_client</span></code> module has classes that
|
||
enables two styles of client applications:</p>
|
||
<ul class="simple">
|
||
<li><p>A client can retrieve the exact pieces of information it requires using the
|
||
various granularities the API supports (that is <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Component" title="com.vmware.vapi.metadata.metamodel_client.Component"><code class="xref py py-class docutils literal notranslate"><span class="pre">Component</span></code></a>,
|
||
<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Package" title="com.vmware.vapi.metadata.metamodel_client.Package"><code class="xref py py-class docutils literal notranslate"><span class="pre">Package</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Service" title="com.vmware.vapi.metadata.metamodel_client.Service"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Structure" title="com.vmware.vapi.metadata.metamodel_client.Structure"><code class="xref py py-class docutils literal notranslate"><span class="pre">Structure</span></code></a>, <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Enumeration" title="com.vmware.vapi.metadata.metamodel_client.Enumeration"><code class="xref py py-class docutils literal notranslate"><span class="pre">Enumeration</span></code></a>
|
||
and <a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#com.vmware.vapi.metadata.metamodel.service_client.Operation" title="com.vmware.vapi.metadata.metamodel.service_client.Operation"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.metamodel.service_client.Operation</span></code></a>). In
|
||
this case, it doesn’t cache any information locally and always invokes methods
|
||
to get the metamodel information it requires.</p></li>
|
||
<li><p>A client can retrieve all the metamodel information in fewer method
|
||
invocations using the <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Component" title="com.vmware.vapi.metadata.metamodel_client.Component"><code class="xref py py-class docutils literal notranslate"><span class="pre">Component</span></code></a> class and cache the output locally. It
|
||
can then poll on the fingerprint information exposed by the <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Component" title="com.vmware.vapi.metadata.metamodel_client.Component"><code class="xref py py-class docutils literal notranslate"><span class="pre">Component</span></code></a>
|
||
class to monitor changes in API definition.</p></li>
|
||
</ul>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Component">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">Component</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Component" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Component</span></code> class providers methods to retrieve metamodel information
|
||
of a component element.</p>
|
||
<p>A component defines a set of functionality that is deployed together and
|
||
versioned together. For example, all the classes that belong to VMware
|
||
Content Library are part of a single component. A component element
|
||
describes a component. A component element contains one or more package
|
||
elements.</p>
|
||
<blockquote>
|
||
<div><p>The methods for package elements are provided by class <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Package" title="com.vmware.vapi.metadata.metamodel_client.Package"><code class="xref py py-class docutils literal notranslate"><span class="pre">Package</span></code></a>.</p>
|
||
</div></blockquote>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Component.RESOURCE_TYPE">
|
||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vapi.component'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Component.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resource type for component.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Component.fingerprint">
|
||
<code class="descname">fingerprint</code><span class="sig-paren">(</span><em>component_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Component.fingerprint" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieves the fingerprint computed from the metamodel metadata of the
|
||
component element corresponding to <code class="docutils literal notranslate"><span class="pre">component_id</span></code>.</p>
|
||
<p>The fingerprint provides clients an efficient way to check if the
|
||
metadata for a particular component element has been modified on the
|
||
server. The client can do this by comparing the result of this
|
||
operation with the fingerprint returned in the result of
|
||
<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Component.get" title="com.vmware.vapi.metadata.metamodel_client.Component.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Component.get()</span></code></a>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>component_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component element.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.component</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The fingerprint computed from the metamodel metadata of the
|
||
component element.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the component element associated with <code class="docutils literal notranslate"><span class="pre">component_id</span></code> is not
|
||
registered with the infrastructure.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Component.get">
|
||
<code class="descname">get</code><span class="sig-paren">(</span><em>component_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Component.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieves metamodel information about the component element
|
||
corresponding to <code class="docutils literal notranslate"><span class="pre">component_id</span></code>.</p>
|
||
<p>The <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ComponentData" title="com.vmware.vapi.metadata.metamodel_client.ComponentData"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentData</span></code></a> contains the metamodel information about the
|
||
component and it’s fingerprint. It contains information about all the
|
||
package elements that are contained in this component element.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>component_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component element.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.component</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ComponentData" title="com.vmware.vapi.metadata.metamodel_client.ComponentData"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentData</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ComponentData" title="com.vmware.vapi.metadata.metamodel_client.ComponentData"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentData</span></code></a> instance that corresponds to
|
||
<code class="docutils literal notranslate"><span class="pre">component_id</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the component element associated with <code class="docutils literal notranslate"><span class="pre">component_id</span></code> is not
|
||
registered with the infrastructure.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Component.list">
|
||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Component.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the identifiers for the component elements that are registered
|
||
with the infrastructure.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Component.list" title="com.vmware.vapi.metadata.metamodel_client.Component.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The list of identifiers for the component elements that are
|
||
registered with the infrastructure.
|
||
The return value will contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.component</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.ComponentData">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">ComponentData</code><span class="sig-paren">(</span><em>info=None</em>, <em>fingerprint=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.ComponentData" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ComponentData</span></code> class contains the metamodel metadata information of
|
||
a component element along with its fingerprint.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>info</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ComponentInfo" title="com.vmware.vapi.metadata.metamodel_client.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentInfo</span></code></a>) – <p>Metamodel information of the component element. This includes
|
||
information about all the package elements contained in this
|
||
component element.</p>
|
||
<p>The metamodel information about a component could be quite large if
|
||
there are a lot of package elements contained in this component.</p>
|
||
</p></li>
|
||
<li><p><strong>fingerprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Fingerprint of the metamodel metadata of the component component.</p>
|
||
<p>Metamodel information could change when there is an infrastructure
|
||
update and new functionality is added to an existing component.</p>
|
||
<p>Since the data present in <code class="xref py py-attr docutils literal notranslate"><span class="pre">ComponentData.info</span></code> could be quite
|
||
large, <code class="docutils literal notranslate"><span class="pre">fingerprint</span></code> provides a convenient way to check if the
|
||
data for a particular component is updated.</p>
|
||
<p>You should store the fingerprint associated with a component. After
|
||
an update, by invoking the <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Component.fingerprint" title="com.vmware.vapi.metadata.metamodel_client.Component.fingerprint"><code class="xref py py-func docutils literal notranslate"><span class="pre">Component.fingerprint()</span></code></a> method,
|
||
you can retrieve the new fingerprint for the component. If the new
|
||
fingerprint and the previously stored fingerprint do not match,
|
||
clients can use the <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Component.get" title="com.vmware.vapi.metadata.metamodel_client.Component.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Component.get()</span></code></a> to retrieve the new
|
||
metamodel information for the component.</p>
|
||
</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.ComponentInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">ComponentInfo</code><span class="sig-paren">(</span><em>name=None</em>, <em>packages=None</em>, <em>metadata=None</em>, <em>documentation=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.ComponentInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ComponentInfo</span></code> class contains metamodel metadata information about a
|
||
component element.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Dot separated name of the component element. The segments in the
|
||
name reflect the organization of the APIs. The format of each
|
||
segment is lower case with underscores. Each underscore represents
|
||
a word boundary. If there are acronyms in the word, the
|
||
capitalization is preserved. This format makes it easy to translate
|
||
the segment into a different naming convention.</p></li>
|
||
<li><p><strong>packages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.PackageInfo" title="com.vmware.vapi.metadata.metamodel_client.PackageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackageInfo</span></code></a>) – Metamodel metadata information of all the package elements
|
||
contained in the component element. The key in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is
|
||
the identifier of the package element and the value in the
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the metamodel information of the package element.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.package</span></code>. When methods return a value of
|
||
this class as a return value, the key in the attribute
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.package</span></code>.</p></li>
|
||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ElementMap" title="com.vmware.vapi.metadata.metamodel_client.ElementMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">ElementMap</span></code></a>) – <p>Generic metadata for the component element. The key in the
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the name of the metadata element and the value is
|
||
the data associated with that metadata element.</p>
|
||
<p>The <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier" title="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetadataIdentifier</span></code></a> contains possible string values for
|
||
keys in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code>.</p>
|
||
</p></li>
|
||
<li><p><strong>documentation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – English language documentation for a component. It can contain HTML
|
||
markup and documentation tags (similar to Javadoc tags). The first
|
||
sentence of the package documentation is a complete sentence that
|
||
identifies the component by name and summarizes the purpose of the
|
||
component.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.ConstantInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">ConstantInfo</code><span class="sig-paren">(</span><em>type=None</em>, <em>value=None</em>, <em>documentation=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.ConstantInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ConstantInfo</span></code> class contains metamodel information of the constant
|
||
elements.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Type" title="com.vmware.vapi.metadata.metamodel_client.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></a>) – Type of the constant element.</p></li>
|
||
<li><p><strong>value</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ConstantValue" title="com.vmware.vapi.metadata.metamodel_client.ConstantValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConstantValue</span></code></a>) – Value of the constant element.</p></li>
|
||
<li><p><strong>documentation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – English language documentation for the constant element. It can
|
||
contain HTML markup and documentation tags (similar to Javadoc
|
||
tags).</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.ConstantValue">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">ConstantValue</code><span class="sig-paren">(</span><em>category=None</em>, <em>primitive_value=None</em>, <em>list_value=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.ConstantValue" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ConstantValue</span></code> class contains the metamodel information of the
|
||
constant element.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category" title="com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConstantValue.Category</span></code></a>) – Category of the type of constant value.</p></li>
|
||
<li><p><strong>primitive_value</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue" title="com.vmware.vapi.metadata.metamodel_client.PrimitiveValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrimitiveValue</span></code></a>) – Primitive value of the constant element.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category.PRIMITIVE" title="com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category.PRIMITIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConstantValue.Category.PRIMITIVE</span></code></a>.</p></li>
|
||
<li><p><strong>list_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue" title="com.vmware.vapi.metadata.metamodel_client.PrimitiveValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrimitiveValue</span></code></a>) – List value of the constant element.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category.LIST" title="com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category.LIST"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ConstantValue.Category.LIST</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category">
|
||
<em class="property">class </em><code class="descname">Category</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ConstantValue.Category</span></code> class defines class attributes for the valid
|
||
kinds of values.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Category</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category.LIST">
|
||
<code class="descname">LIST</code><em class="property"> = Category(string='LIST')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category.LIST" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates the type of constant value is a list.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category.PRIMITIVE">
|
||
<code class="descname">PRIMITIVE</code><em class="property"> = Category(string='PRIMITIVE')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category.PRIMITIVE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates the type of constant value is primitive.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.ElementMap">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">ElementMap</code><span class="sig-paren">(</span><em>elements=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.ElementMap" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ElementMap</span></code> class contains the metadata elements.</p>
|
||
<p>One of the sources for metadata is the annotations present in the interface
|
||
definition language. When an annotation is represented in the
|
||
<code class="docutils literal notranslate"><span class="pre">ElementMap</span></code>, <code class="docutils literal notranslate"><span class="pre">ElementMap</span></code> describes the data specified in the
|
||
arguments for the annotation.</p>
|
||
<p>For example, in <code class="docutils literal notranslate"><span class="pre">\\@UnionCase(tag="tag",</span> <span class="pre">value="SELECT")</span></code>, ElementMap
|
||
describes the keyword arguments tag and value.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>elements</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ElementValue" title="com.vmware.vapi.metadata.metamodel_client.ElementValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">ElementValue</span></code></a>) – Metamodel information of the metadata elements. The key parameter
|
||
of the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the identifier for the element and the
|
||
value corresponds to the element value.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.ElementValue">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">ElementValue</code><span class="sig-paren">(</span><em>type=None</em>, <em>long_value=None</em>, <em>string_value=None</em>, <em>list_value=None</em>, <em>structure_id=None</em>, <em>structure_ids=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.ElementValue" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ElementValue</span></code> class describes the value of the metadata element.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ElementValue.Type" title="com.vmware.vapi.metadata.metamodel_client.ElementValue.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">ElementValue.Type</span></code></a>) – Type of the value.</p></li>
|
||
<li><p><strong>long_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Long value of the metadata element.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.LONG" title="com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.LONG"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ElementValue.Type.LONG</span></code></a>.</p></li>
|
||
<li><p><strong>string_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value of the metadata element.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRING" title="com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ElementValue.Type.STRING</span></code></a>.</p></li>
|
||
<li><p><strong>list_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of strings value of the metadata element.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRING_LIST" title="com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRING_LIST"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ElementValue.Type.STRING_LIST</span></code></a>.</p></li>
|
||
<li><p><strong>structure_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the structure element.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRUCTURE_REFERENCE" title="com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRUCTURE_REFERENCE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ElementValue.Type.STRUCTURE_REFERENCE</span></code></a>.</p></li>
|
||
<li><p><strong>structure_ids</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of identifiers of the structure elements.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will contain identifiers for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRUCTURE_REFERENCE_LIST" title="com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRUCTURE_REFERENCE_LIST"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ElementValue.Type.STRUCTURE_REFERENCE_LIST</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.ElementValue.Type">
|
||
<em class="property">class </em><code class="descname">Type</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.ElementValue.Type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ElementValue.Type</span></code> class defines the valid types for values in
|
||
metadata elements.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Type" title="com.vmware.vapi.metadata.metamodel_client.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.LONG">
|
||
<code class="descname">LONG</code><em class="property"> = Type(string='LONG')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.LONG" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates the type of the value is a long (64 bit signed integer).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRING">
|
||
<code class="descname">STRING</code><em class="property"> = Type(string='STRING')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRING" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates the type of the value is a string (a variable length sequence of
|
||
characters). The encoding is UTF-8.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRING_LIST">
|
||
<code class="descname">STRING_LIST</code><em class="property"> = Type(string='STRING_LIST')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRING_LIST" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates the type of the value is a list of strings.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRUCTURE_REFERENCE">
|
||
<code class="descname">STRUCTURE_REFERENCE</code><em class="property"> = Type(string='STRUCTURE_REFERENCE')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRUCTURE_REFERENCE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates the type of the value is an identifier for a structure element.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRUCTURE_REFERENCE_LIST">
|
||
<code class="descname">STRUCTURE_REFERENCE_LIST</code><em class="property"> = Type(string='STRUCTURE_REFERENCE_LIST')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRUCTURE_REFERENCE_LIST" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates the type of the value is a list of identifiers for a structure
|
||
element.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Enumeration">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">Enumeration</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Enumeration" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Enumeration</span></code> class provides methods to retrieve metamodel
|
||
information about an enumeration element in the interface definition
|
||
language.</p>
|
||
<blockquote>
|
||
<div><p>The <code class="docutils literal notranslate"><span class="pre">Enumeration</span></code> has a list of enumeration value elements.</p>
|
||
</div></blockquote>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Enumeration.RESOURCE_TYPE">
|
||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vapi.enumeration'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Enumeration.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resource type for enumeration.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Enumeration.get">
|
||
<code class="descname">get</code><span class="sig-paren">(</span><em>enumeration_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Enumeration.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieves information about the enumeration element corresponding to
|
||
<code class="docutils literal notranslate"><span class="pre">enumeration_id</span></code>.</p>
|
||
<p>The <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.EnumerationInfo" title="com.vmware.vapi.metadata.metamodel_client.EnumerationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">EnumerationInfo</span></code></a> contains the metamodel information about
|
||
the enumeration value element contained in the enumeration element.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>enumeration_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the enumeration element.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.enumeration</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.EnumerationInfo" title="com.vmware.vapi.metadata.metamodel_client.EnumerationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">EnumerationInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.EnumerationInfo" title="com.vmware.vapi.metadata.metamodel_client.EnumerationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">EnumerationInfo</span></code></a> instance that corresponds to
|
||
<code class="docutils literal notranslate"><span class="pre">enumeration_id</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the enumeration element associated with <code class="docutils literal notranslate"><span class="pre">enumeration_id</span></code> is
|
||
not contained in any of the package elements, service elements and
|
||
structure elements.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Enumeration.list">
|
||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Enumeration.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the identifiers for the enumeration elements that are contained
|
||
in all the package elements, service elements and structure elements.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Enumeration.list" title="com.vmware.vapi.metadata.metamodel_client.Enumeration.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The list of identifiers for the enumeration elements.
|
||
The return value will contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.enumeration</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.EnumerationInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">EnumerationInfo</code><span class="sig-paren">(</span><em>name=None</em>, <em>values=None</em>, <em>metadata=None</em>, <em>documentation=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.EnumerationInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">EnumerationInfo</span></code> class contains the metamodel information of an
|
||
enumeration element.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Dot separated name of the enumeration element. The segments in the
|
||
name reflect the organization of the APIs. The format of each
|
||
segment is lower case with underscores. Each underscore represents
|
||
a word boundary. If there are acronyms in the word, the
|
||
capitalization is preserved. This format makes it easy to translate
|
||
the segment into a different naming convention.</p></li>
|
||
<li><p><strong>values</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.EnumerationValueInfo" title="com.vmware.vapi.metadata.metamodel_client.EnumerationValueInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">EnumerationValueInfo</span></code></a>) – Metamodel information of all the enumeration value elements
|
||
contained in this enumeration element. The order of the enumeration
|
||
value elements in the list is same as the order in which they are
|
||
defined in the interface definition file.</p></li>
|
||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ElementMap" title="com.vmware.vapi.metadata.metamodel_client.ElementMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">ElementMap</span></code></a>) – <p>Generic metadata elements for an enumeration element. The key in
|
||
the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the name of the metadata element and the value
|
||
is the data associated with that metadata element.</p>
|
||
<p>The <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier" title="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetadataIdentifier</span></code></a> contains possible string values for
|
||
keys in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code>.</p>
|
||
</p></li>
|
||
<li><p><strong>documentation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>English language documentation for an enumeration element. It can
|
||
contain HTML markup and Javadoc tags. The first sentence of the
|
||
enumeration documentation is a complete sentence that identifies
|
||
the enumeration by name and summarizes the purpose of the
|
||
enumeration. The documentation describes the context in which the
|
||
enumeration is used.</p>
|
||
<p>The documentation also contains references to the context in which
|
||
the enumeration is used. But if the enumeration is used in many
|
||
contexts, the references may not be present.</p>
|
||
</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.EnumerationValueInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">EnumerationValueInfo</code><span class="sig-paren">(</span><em>value=None</em>, <em>metadata=None</em>, <em>documentation=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.EnumerationValueInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">EnumerationValueInfo</span></code> class describes the class attribute in the
|
||
class.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Value in the enumerated type. All the characters in the string are
|
||
capitalized.</p></li>
|
||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ElementMap" title="com.vmware.vapi.metadata.metamodel_client.ElementMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">ElementMap</span></code></a>) – <p>Additional metadata for enumeration value in the enumerated type.
|
||
The key in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the name of the metadata element
|
||
and the value is the data associated with that metadata element.</p>
|
||
<p>The <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier" title="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetadataIdentifier</span></code></a> contains possible string values for
|
||
keys in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code>.</p>
|
||
</p></li>
|
||
<li><p><strong>documentation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – English language documentation for an enumeration value. It can
|
||
contain HTML markup and documentation tags (similar to Javadoc
|
||
tags). The first statement will be a noun or verb phrase that
|
||
describes the purpose of the enumeration value.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.ErrorInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">ErrorInfo</code><span class="sig-paren">(</span><em>structure_id=None</em>, <em>documentation=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.ErrorInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ErrorInfo</span></code> class contains the metadata information about the error
|
||
elements contained in an operation element.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>structure_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier for the structure element corresponding to the error
|
||
that is being reported by the operation.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>. When methods return a value of this
|
||
class as a return value, the attribute will be an identifier for
|
||
the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.</p></li>
|
||
<li><p><strong>documentation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The English language documentation for the service element. It can
|
||
contain HTML markup and Javadoc tags.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.FieldInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">FieldInfo</code><span class="sig-paren">(</span><em>name=None</em>, <em>type=None</em>, <em>metadata=None</em>, <em>documentation=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.FieldInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">FieldInfo</span></code> class contains metamodel information of a field element
|
||
contained in a structure element.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the field element in a canonical format. The format is
|
||
lower case with underscores. Each underscore represents a word
|
||
boundary. If there are acronyms in the word, the capitalization is
|
||
preserved. This format makes it easy to translate the segment into
|
||
a different naming convention.</p></li>
|
||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Type" title="com.vmware.vapi.metadata.metamodel_client.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></a>) – Type information.</p></li>
|
||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ElementMap" title="com.vmware.vapi.metadata.metamodel_client.ElementMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">ElementMap</span></code></a>) – <p>Generic metadata elements for the field element. The key in the
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the name of the metadata element and the value is
|
||
the data associated with that metadata element.</p>
|
||
<p>The <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier" title="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetadataIdentifier</span></code></a> contains possible string values for
|
||
keys in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code>.</p>
|
||
</p></li>
|
||
<li><p><strong>documentation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – English language documentation for the service element. It can
|
||
contain HTML markup and Javadoc tags.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">GenericInstantiation</code><span class="sig-paren">(</span><em>generic_type=None</em>, <em>element_type=None</em>, <em>map_key_type=None</em>, <em>map_value_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">GenericInstantiation</span></code> class describes the type information of a
|
||
typed element when the type is an instantiation of one of the generic types
|
||
provided by the infrastructure.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>generic_type</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType" title="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType"><code class="xref py py-class docutils literal notranslate"><span class="pre">GenericInstantiation.GenericType</span></code></a>) – The generic type that is being instantiated.</p></li>
|
||
<li><p><strong>element_type</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Type" title="com.vmware.vapi.metadata.metamodel_client.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></a>) – Type of the element parameter if the generic type instantiation is
|
||
a <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.LIST" title="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.LIST"><code class="xref py py-attr docutils literal notranslate"><span class="pre">GenericInstantiation.GenericType.LIST</span></code></a>,
|
||
<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.OPTIONAL" title="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.OPTIONAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">GenericInstantiation.GenericType.OPTIONAL</span></code></a> or
|
||
<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.SET" title="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.SET"><code class="xref py py-attr docutils literal notranslate"><span class="pre">GenericInstantiation.GenericType.SET</span></code></a>.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">genericType</span></code> is one of
|
||
<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.LIST" title="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.LIST"><code class="xref py py-attr docutils literal notranslate"><span class="pre">GenericInstantiation.GenericType.LIST</span></code></a>,
|
||
<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.OPTIONAL" title="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.OPTIONAL"><code class="xref py py-attr docutils literal notranslate"><span class="pre">GenericInstantiation.GenericType.OPTIONAL</span></code></a>, or
|
||
<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.SET" title="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.SET"><code class="xref py py-attr docutils literal notranslate"><span class="pre">GenericInstantiation.GenericType.SET</span></code></a>.</p></li>
|
||
<li><p><strong>map_key_type</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Type" title="com.vmware.vapi.metadata.metamodel_client.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></a>) – Type of the key parameter of the map generic type instantiation.
|
||
The map generic type has a key parameter and value parameter. The
|
||
type of the value parameter is described by
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">GenericInstantiation.map_value_type</span></code>..
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">genericType</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.MAP" title="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.MAP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">GenericInstantiation.GenericType.MAP</span></code></a>.</p></li>
|
||
<li><p><strong>map_value_type</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Type" title="com.vmware.vapi.metadata.metamodel_client.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></a>) – Type of the value parameter of the map generic type instantiation.
|
||
The map generic type has a key parameter and value parameter. The
|
||
type of the key parameter is described by
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">GenericInstantiation.map_key_type</span></code>..
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">genericType</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.MAP" title="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.MAP"><code class="xref py py-attr docutils literal notranslate"><span class="pre">GenericInstantiation.GenericType.MAP</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType">
|
||
<em class="property">class </em><code class="descname">GenericType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">GenericInstantiation.GenericType</span></code> class provides class attributes
|
||
for each of the generic types provided by the infrastructure.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">GenericType</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.LIST">
|
||
<code class="descname">LIST</code><em class="property"> = GenericType(string='LIST')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.LIST" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates the generic type is a list.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.MAP">
|
||
<code class="descname">MAP</code><em class="property"> = GenericType(string='MAP')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.MAP" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates the generic type is a map.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.OPTIONAL">
|
||
<code class="descname">OPTIONAL</code><em class="property"> = GenericType(string='OPTIONAL')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.OPTIONAL" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates the generic type is an optional.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.SET">
|
||
<code class="descname">SET</code><em class="property"> = GenericType(string='SET')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.SET" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates the generic type is a set.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">MetadataIdentifier</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">MetadataIdentifier</span></code> class provides string constants that can be used
|
||
as identifiers for the metadata elements.</p>
|
||
<p>Most of the types in <a class="reference internal" href="#module-com.vmware.vapi.metadata.metamodel_client" title="com.vmware.vapi.metadata.metamodel_client"><code class="xref py py-mod docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.metamodel_client</span></code></a>
|
||
package has a metadata field whose type is <code class="docutils literal notranslate"><span class="pre">Map<String,</span> <span class="pre">ElementMap></span></code>.
|
||
<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier" title="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetadataIdentifier</span></code></a> contains the identifiers used in the keys of
|
||
the above Map type.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.CANONICAL_NAME">
|
||
<code class="descname">CANONICAL_NAME</code><em class="property"> = 'CanonicalName'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.CANONICAL_NAME" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Identifier representing the CanonicalName metadata.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.COMPONENT">
|
||
<code class="descname">COMPONENT</code><em class="property"> = 'Component'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.COMPONENT" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Identifier representing the Component metadata.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.CREATE">
|
||
<code class="descname">CREATE</code><em class="property"> = 'Create'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.CREATE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Identifier representing the Create metadata.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.CRUD">
|
||
<code class="descname">CRUD</code><em class="property"> = 'Crud'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.CRUD" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Identifier representing the Crud metadata.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.HAS_FIELDS_OF">
|
||
<code class="descname">HAS_FIELDS_OF</code><em class="property"> = 'HasFieldsOf'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.HAS_FIELDS_OF" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Identifier representing the HasFieldsOf metadata.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.INCLUDABLE">
|
||
<code class="descname">INCLUDABLE</code><em class="property"> = 'Includable'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.INCLUDABLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Identifier representing the Includable metadata.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.INCLUDE">
|
||
<code class="descname">INCLUDE</code><em class="property"> = 'Include'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.INCLUDE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Identifier representing the Include metadata.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.IS_ONE_OF">
|
||
<code class="descname">IS_ONE_OF</code><em class="property"> = 'IsOneOf'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.IS_ONE_OF" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Identifier representing the IsOneOf metadata.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.MODEL">
|
||
<code class="descname">MODEL</code><em class="property"> = 'Model'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.MODEL" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Identifier representing the Model metadata.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.READ">
|
||
<code class="descname">READ</code><em class="property"> = 'Read'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.READ" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Identifier representing the Read metadata.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.RESOURCE">
|
||
<code class="descname">RESOURCE</code><em class="property"> = 'Resource'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.RESOURCE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Identifier representing the Resource metadata.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.UNION_CASE">
|
||
<code class="descname">UNION_CASE</code><em class="property"> = 'UnionCase'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.UNION_CASE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Identifier representing the UnionCase metadata.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.UNION_TAG">
|
||
<code class="descname">UNION_TAG</code><em class="property"> = 'UnionTag'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.UNION_TAG" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Identifier representing the UnionTag metadata.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.UPDATE">
|
||
<code class="descname">UPDATE</code><em class="property"> = 'Update'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier.UPDATE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Identifier representing the Update metadata.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.OperationInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">OperationInfo</code><span class="sig-paren">(</span><em>name=None</em>, <em>params=None</em>, <em>output=None</em>, <em>errors=None</em>, <em>metadata=None</em>, <em>documentation=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.OperationInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">OperationInfo</span></code> class contains metamodel information of an operation
|
||
element.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the operation element in a canonical format. The format is
|
||
lower case with underscores. Each underscore represents a word
|
||
boundary. If there are acronyms in the word, the capitalization is
|
||
preserved. This format makes it easy to translate the segment into
|
||
a different naming convention.</p></li>
|
||
<li><p><strong>params</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.FieldInfo" title="com.vmware.vapi.metadata.metamodel_client.FieldInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">FieldInfo</span></code></a>) – Metamodel information for the parameter elements. The order of the
|
||
parameters elements in the list is same as the order of the
|
||
parameters declared in the interface definition file.</p></li>
|
||
<li><p><strong>output</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.OperationResultInfo" title="com.vmware.vapi.metadata.metamodel_client.OperationResultInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">OperationResultInfo</span></code></a>) – Metamodel type for the output element.</p></li>
|
||
<li><p><strong>errors</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ErrorInfo" title="com.vmware.vapi.metadata.metamodel_client.ErrorInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ErrorInfo</span></code></a>) – List of error elements that might be reported by the operation
|
||
element. If the operation reports the same error for more than one
|
||
reason, the list contains the error element associated with the
|
||
error more than once with different documentation elements.</p></li>
|
||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ElementMap" title="com.vmware.vapi.metadata.metamodel_client.ElementMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">ElementMap</span></code></a>) – <p>Generic metadata elements for the operation element. The key in the
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the name of the metadata element and the value is
|
||
the data associated with that metadata element.</p>
|
||
<p>The <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier" title="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetadataIdentifier</span></code></a> contains possible string values for
|
||
key in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code>.</p>
|
||
</p></li>
|
||
<li><p><strong>documentation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – English language documentation for the service element. It can
|
||
contain HTML markup and Javadoc tags.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.OperationResultInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">OperationResultInfo</code><span class="sig-paren">(</span><em>type=None</em>, <em>metadata=None</em>, <em>documentation=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.OperationResultInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">OperationResultInfo</span></code> class contains the metamodel information of an
|
||
operation result element.</p>
|
||
<p>An operation accepts a list of parameters and returns a result or an error.
|
||
The <code class="docutils literal notranslate"><span class="pre">OperationResultInfo</span></code> describes the result element of an operation.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Type" title="com.vmware.vapi.metadata.metamodel_client.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></a>) – Type information of the operation result element.</p></li>
|
||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ElementMap" title="com.vmware.vapi.metadata.metamodel_client.ElementMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">ElementMap</span></code></a>) – <p>Generic metadata elements for the service element. The key in the
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the name of the metadata element and the value is
|
||
the data associated with that metadata element.</p>
|
||
<p>The <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier" title="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetadataIdentifier</span></code></a> contains possible string values for
|
||
keys in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code>.</p>
|
||
</p></li>
|
||
<li><p><strong>documentation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – English language documentation for the operation result element. It
|
||
can contain HTML markup and Javadoc tags.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Package">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">Package</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Package" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Package</span></code> class provides methods to retrieve metamodel information
|
||
about a package element in the interface definition language.</p>
|
||
<p>A package is a logical grouping of services, structures and enumerations. A
|
||
package element describes the package. It contains the service elements,
|
||
structure elements and enumeration elements that are grouped together.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Package.RESOURCE_TYPE">
|
||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vapi.package'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Package.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resource type for package.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Package.get">
|
||
<code class="descname">get</code><span class="sig-paren">(</span><em>package_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Package.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieves information about the package element corresponding to
|
||
<code class="docutils literal notranslate"><span class="pre">package_id</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>package_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the package element.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.package</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.PackageInfo" title="com.vmware.vapi.metadata.metamodel_client.PackageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackageInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.PackageInfo" title="com.vmware.vapi.metadata.metamodel_client.PackageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackageInfo</span></code></a> instance that corresponds to
|
||
<code class="docutils literal notranslate"><span class="pre">package_id</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the package element associated with <code class="docutils literal notranslate"><span class="pre">package_id</span></code> does not
|
||
exist.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Package.list">
|
||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Package.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the identifiers for the packages elements that are contained in
|
||
all the registered component elements.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Package.list" title="com.vmware.vapi.metadata.metamodel_client.Package.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The list of identifiers for the package elements that are contained
|
||
in all the registered component elements.
|
||
The return value will contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.package</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.PackageInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">PackageInfo</code><span class="sig-paren">(</span><em>name=None</em>, <em>structures=None</em>, <em>enumerations=None</em>, <em>services=None</em>, <em>metadata=None</em>, <em>documentation=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.PackageInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">PackageInfo</span></code> class contains the metamodel information of all the
|
||
service elements, structure elements and enumeration elements contained in
|
||
the package element.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Dot separated name of the package element. The segments in the name
|
||
reflect the organization of the APIs. The format of each segment is
|
||
lower case with underscores. Each underscore represents a word
|
||
boundary. If there are acronyms in the word, the capitalization is
|
||
preserved. This format makes it easy to translate the segment into
|
||
a different naming convention.</p></li>
|
||
<li><p><strong>structures</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.StructureInfo" title="com.vmware.vapi.metadata.metamodel_client.StructureInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">StructureInfo</span></code></a>) – <p>Metamodel information of all the structure elements contained in
|
||
the package element. The key in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the identifier
|
||
of the structure element and the value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the
|
||
metamodel information for the structure element.</p>
|
||
<p>This does not include the structure elements contained in the
|
||
service elements that are contained in this package element.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>. When methods return a value of
|
||
this class as a return value, the key in the attribute
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.</p>
|
||
</p></li>
|
||
<li><p><strong>enumerations</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.EnumerationInfo" title="com.vmware.vapi.metadata.metamodel_client.EnumerationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">EnumerationInfo</span></code></a>) – <p>Metamodel information of all the enumeration elements contained in
|
||
the package element. The key in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the identifier
|
||
of the enumeration element and the value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is
|
||
the metamodel information for the enumeration element.</p>
|
||
<p>This does not include the enumeration elements that are contained
|
||
in the service elements of this package element or structure
|
||
elements of this package element.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.enumeration</span></code>. When methods return a value
|
||
of this class as a return value, the key in the attribute
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.enumeration</span></code>.</p>
|
||
</p></li>
|
||
<li><p><strong>services</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ServiceInfo" title="com.vmware.vapi.metadata.metamodel_client.ServiceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceInfo</span></code></a>) – Metamodel information of all the service elements contained in the
|
||
package element. The key in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the identifier of
|
||
the service element and the value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the
|
||
metamodel information for the service element.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>. When methods return a value of
|
||
this class as a return value, the key in the attribute
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p></li>
|
||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ElementMap" title="com.vmware.vapi.metadata.metamodel_client.ElementMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">ElementMap</span></code></a>) – <p>Generic metadata elements for the package element. The key in the
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the name of the metadata element and the value is
|
||
the data associated with that metadata element.</p>
|
||
<p>The <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier" title="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetadataIdentifier</span></code></a> contains possible string values for
|
||
keys in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code>.</p>
|
||
</p></li>
|
||
<li><p><strong>documentation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>English language documentation for a package. It can contain HTML
|
||
markup and Javadoc tags. The first sentence of the package
|
||
documentation is a complete sentence that identifies the package by
|
||
name and summarizes the purpose of the package.</p>
|
||
<p>The primary purpose of a package documentation is to provide
|
||
high-level context that will provide a framework in which the users
|
||
can put the detail about the package contents.</p>
|
||
</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.PrimitiveValue">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">PrimitiveValue</code><span class="sig-paren">(</span><em>type=None</em>, <em>boolean_value=None</em>, <em>double_value=None</em>, <em>long_value=None</em>, <em>string_value=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">PrimitiveValue</span></code> class contains value of the constant element.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type" title="com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrimitiveValue.Type</span></code></a>) – Type of the constant value.</p></li>
|
||
<li><p><strong>boolean_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Boolean value of the constant.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.BOOLEAN" title="com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.BOOLEAN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PrimitiveValue.Type.BOOLEAN</span></code></a>.</p></li>
|
||
<li><p><strong>double_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>) – Double value of the constant.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.DOUBLE" title="com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.DOUBLE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PrimitiveValue.Type.DOUBLE</span></code></a>.</p></li>
|
||
<li><p><strong>long_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Long value of the constant.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.LONG" title="com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.LONG"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PrimitiveValue.Type.LONG</span></code></a>.</p></li>
|
||
<li><p><strong>string_value</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value of the constant.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.STRING" title="com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.STRING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">PrimitiveValue.Type.STRING</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type">
|
||
<em class="property">class </em><code class="descname">Type</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">PrimitiveValue.Type</span></code> class defines the valid types for values in
|
||
constant elements.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Type" title="com.vmware.vapi.metadata.metamodel_client.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.BOOLEAN">
|
||
<code class="descname">BOOLEAN</code><em class="property"> = Type(string='BOOLEAN')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.BOOLEAN" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates the value is a boolean (true or false).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.DOUBLE">
|
||
<code class="descname">DOUBLE</code><em class="property"> = Type(string='DOUBLE')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.DOUBLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates the value is a double (64 bit floating number).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.LONG">
|
||
<code class="descname">LONG</code><em class="property"> = Type(string='LONG')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.LONG" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates the value is a long (64 bit signed integer).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.STRING">
|
||
<code class="descname">STRING</code><em class="property"> = Type(string='STRING')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.STRING" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Indicates the value is a string (a variable length sequence of characters).
|
||
The encoding is UTF8.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Resource">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">Resource</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Resource" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Resource" title="com.vmware.vapi.metadata.metamodel_client.Resource"><code class="xref py py-class docutils literal notranslate"><span class="pre">Resource</span></code></a> class provides methods to retrieve information about
|
||
resource types.</p>
|
||
<p>A service is a logical grouping of operations that operate on an entity.
|
||
Each entity is identifier by a namespace (or resource type) and an unique
|
||
identifier.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Resource.RESOURCE_TYPE">
|
||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vapi.resource'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Resource.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resource type for resource.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Resource.list">
|
||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Resource.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the set of resource types present across all the service
|
||
elements contained in all the package elements.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">set</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Set of resource types
|
||
The return value will contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.resource</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Service">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">Service</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Service" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Service</span></code> class provides methods to retrieve metamodel information
|
||
about a service element in the interface definition language.</p>
|
||
<p>A service is a logical grouping of operations that operate on some entity.
|
||
A service element describes a service. It contains operation elements that
|
||
describe the operations grouped in the service. It also contains structure
|
||
elements and enumeration elements corresponding to the structures and
|
||
enumerations defined in the service.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Service.RESOURCE_TYPE">
|
||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vapi.service'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Service.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resource type for service.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Service.get">
|
||
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Service.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieves information about the service element corresponding to
|
||
<code class="docutils literal notranslate"><span class="pre">service_id</span></code>.</p>
|
||
<p>The <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ServiceInfo" title="com.vmware.vapi.metadata.metamodel_client.ServiceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceInfo</span></code></a> contains the metamodel information for the
|
||
operation elements, structure elements and enumeration elements
|
||
contained in the service element.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ServiceInfo" title="com.vmware.vapi.metadata.metamodel_client.ServiceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ServiceInfo" title="com.vmware.vapi.metadata.metamodel_client.ServiceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceInfo</span></code></a> instance that corresponds to
|
||
<code class="docutils literal notranslate"><span class="pre">service_id</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the service element associated with <code class="docutils literal notranslate"><span class="pre">service_id</span></code> is not
|
||
registered with the infrastructure.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Service.list">
|
||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Service.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the identifiers for the service elements that are currently
|
||
registered with the infrastructure.</p>
|
||
<p>The list of service elements is an aggregate list of all the service
|
||
elements contained in all the package elements.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Service.list" title="com.vmware.vapi.metadata.metamodel_client.Service.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The list of identifiers for the service elements that are currently
|
||
registered with the infrastructure.
|
||
The return value will contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.ServiceInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">ServiceInfo</code><span class="sig-paren">(</span><em>name=None</em>, <em>operations=None</em>, <em>structures=None</em>, <em>enumerations=None</em>, <em>constants=None</em>, <em>metadata=None</em>, <em>documentation=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.ServiceInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ServiceInfo</span></code> class contains the metamodel information of all the
|
||
operation elements, structure elements and enumeration elements containted
|
||
in a service element.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Dot separated name of the service element. The segments in the name
|
||
reflect the organization of the APIs. The format of each segment is
|
||
lower case with underscores. Each underscore represents a word
|
||
boundary. If there are acronyms in the word, the capitalization is
|
||
preserved. This format makes it easy to translate the segment into
|
||
a different naming convention.</p></li>
|
||
<li><p><strong>operations</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.OperationInfo" title="com.vmware.vapi.metadata.metamodel_client.OperationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">OperationInfo</span></code></a>) – Metamodel information of all the operation elements contained in
|
||
the service element. The key in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the identifier
|
||
of the operation element and the value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the
|
||
metamodel information for the operation element.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>. When methods return a value of
|
||
this class as a return value, the key in the attribute
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p></li>
|
||
<li><p><strong>structures</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.StructureInfo" title="com.vmware.vapi.metadata.metamodel_client.StructureInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">StructureInfo</span></code></a>) – Metamodel information of all the structure elements contained in
|
||
the service element. The key in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the identifier
|
||
of the structure element and the value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the
|
||
metamodel information for the structure element.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>. When methods return a value of
|
||
this class as a return value, the key in the attribute
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.</p></li>
|
||
<li><p><strong>enumerations</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.EnumerationInfo" title="com.vmware.vapi.metadata.metamodel_client.EnumerationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">EnumerationInfo</span></code></a>) – Metamodel information of all the enumeration elements contained in
|
||
the service element. The key in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the identifier
|
||
of the enumeration element and the value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is
|
||
the metamodel information for the enumeration element.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.enumeration</span></code>. When methods return a value
|
||
of this class as a return value, the key in the attribute
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.enumeration</span></code>.</p></li>
|
||
<li><p><strong>constants</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ConstantInfo" title="com.vmware.vapi.metadata.metamodel_client.ConstantInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConstantInfo</span></code></a>) – Metamodel information of all the constant elements contained in the
|
||
service element. The key in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the name of the
|
||
constant element and the value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the
|
||
metamodel information for the contant element.</p></li>
|
||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ElementMap" title="com.vmware.vapi.metadata.metamodel_client.ElementMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">ElementMap</span></code></a>) – <p>Generic metadata elements for the service element. The key in the
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the name of the metadata element and the value is
|
||
the data associated with that metadata element.</p>
|
||
<p>The <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier" title="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetadataIdentifier</span></code></a> contains possible string values for
|
||
keys in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code>.</p>
|
||
</p></li>
|
||
<li><p><strong>documentation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – English language documentation for the service element. It can
|
||
contain HTML markup and Javadoc tags. The first sentence of the
|
||
service documentation is a complete sentence that identifies the
|
||
service by name and summarizes the purpose of the service. The
|
||
remaining part of the documentation provides a summary of how to
|
||
use the operations defined in the service.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Structure">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">Structure</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Structure" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Structure</span></code> class providers methods to retrieve metamodel information
|
||
about a structure element in the interface definition language.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Structure.RESOURCE_TYPE">
|
||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vapi.structure'</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Structure.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resource type for structure.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Structure.get">
|
||
<code class="descname">get</code><span class="sig-paren">(</span><em>structure_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Structure.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieves information about the structure element corresponding to
|
||
<code class="docutils literal notranslate"><span class="pre">structure_id</span></code>.</p>
|
||
<p>The <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.StructureInfo" title="com.vmware.vapi.metadata.metamodel_client.StructureInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">StructureInfo</span></code></a> contains the metamodel information about the
|
||
structure element. It contains information about all the field elements
|
||
and enumeration elements contained in this structure element.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>structure_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the structure element.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.StructureInfo" title="com.vmware.vapi.metadata.metamodel_client.StructureInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">StructureInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.StructureInfo" title="com.vmware.vapi.metadata.metamodel_client.StructureInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">StructureInfo</span></code></a> instance that corresponds to
|
||
<code class="docutils literal notranslate"><span class="pre">structure_id</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the structure element associated with <code class="docutils literal notranslate"><span class="pre">structure_id</span></code> is not
|
||
contained in any of the package elements or service elements.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Structure.list">
|
||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Structure.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the identifiers for the structure elements that are contained
|
||
in all the package elements and service elements.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Structure.list" title="com.vmware.vapi.metadata.metamodel_client.Structure.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The list of identifiers for the structure elements.
|
||
The return value will contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.StructureInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">StructureInfo</code><span class="sig-paren">(</span><em>name=None</em>, <em>type=None</em>, <em>enumerations=None</em>, <em>constants=None</em>, <em>fields=None</em>, <em>metadata=None</em>, <em>documentation=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.StructureInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">StructureInfo</span></code> class contains the metamodel information of all the
|
||
field elements, constant elements and enumeration elements contained in the
|
||
structure element.</p>
|
||
<p>In the interface definition language, API designers have the ability to
|
||
include all the fields from one structure to another structure. This is
|
||
done by using an annotation <code class="docutils literal notranslate"><span class="pre">\\@Include</span></code> on the structure in which we
|
||
want to add the fields. If this annotation is present, the list of fields
|
||
in the <code class="docutils literal notranslate"><span class="pre">StructureInfo</span></code> will also contain the fields that are being
|
||
included. The annotation information is also retained in the
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">StructureInfo.metadata</span></code> element as well.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Dot separated name of the structure element. The segments in the
|
||
name reflect the organization of the APIs. The format of each
|
||
segment is lower case with underscores. Each underscore represents
|
||
a word boundary. If there are acronyms in the word, the
|
||
capitalization is preserved. This format makes it easy to translate
|
||
the segment into a different naming convention.</p></li>
|
||
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.StructureInfo.Type" title="com.vmware.vapi.metadata.metamodel_client.StructureInfo.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">StructureInfo.Type</span></code></a>) – Type of the structure.</p></li>
|
||
<li><p><strong>enumerations</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.EnumerationInfo" title="com.vmware.vapi.metadata.metamodel_client.EnumerationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">EnumerationInfo</span></code></a>) – Metamodel information of all the enumeration elements contained in
|
||
the structure element. The key in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the
|
||
identifier of the enumeration element and the value is the
|
||
metamodel information of the enumeration element.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.enumeration</span></code>. When methods return a value
|
||
of this class as a return value, the key in the attribute
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.enumeration</span></code>.</p></li>
|
||
<li><p><strong>constants</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ConstantInfo" title="com.vmware.vapi.metadata.metamodel_client.ConstantInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ConstantInfo</span></code></a>) – Metamodel information of all the constant elements contained in the
|
||
structure element. The key in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the name of the
|
||
constant element and the value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the
|
||
metamodel information for the constant element.</p></li>
|
||
<li><p><strong>fields</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.FieldInfo" title="com.vmware.vapi.metadata.metamodel_client.FieldInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">FieldInfo</span></code></a>) – Metamodel information of all the field elements. The order of the
|
||
field elements in the list matches the order in which the fields
|
||
are defined in the service.</p></li>
|
||
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.ElementMap" title="com.vmware.vapi.metadata.metamodel_client.ElementMap"><code class="xref py py-class docutils literal notranslate"><span class="pre">ElementMap</span></code></a>) – <p>Generic metadata elements for the structure element. The key in the
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the name of the metadata element and the value is
|
||
the data associated with that metadata element.</p>
|
||
<p>The <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier" title="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">MetadataIdentifier</span></code></a> contains possible string values for
|
||
keys in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code>.</p>
|
||
</p></li>
|
||
<li><p><strong>documentation</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – English language documentation for a structure element. It can
|
||
contain HTML markup and Javadoc tags. The first sentence of the
|
||
structure documentation is a complete sentence that identifies the
|
||
structure by name and summarizes the purpose of the structure.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.StructureInfo.Type">
|
||
<em class="property">class </em><code class="descname">Type</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.StructureInfo.Type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">StructureInfo.Type</span></code> class defines the kind of this structure
|
||
element. In the interface definition language, structure element and error
|
||
element have similar characteristics. The difference is that only error
|
||
elements can be used to describe the exceptions of an operation element.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Type" title="com.vmware.vapi.metadata.metamodel_client.Type"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type</span></code></a> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.StructureInfo.Type.ERROR">
|
||
<code class="descname">ERROR</code><em class="property"> = Type(string='ERROR')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.StructureInfo.Type.ERROR" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>If the type is an error element.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.StructureInfo.Type.STRUCTURE">
|
||
<code class="descname">STRUCTURE</code><em class="property"> = Type(string='STRUCTURE')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.StructureInfo.Type.STRUCTURE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>If the type is a structure element.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.StubFactory">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Type">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">Type</code><span class="sig-paren">(</span><em>category=None</em>, <em>builtin_type=None</em>, <em>user_defined_type=None</em>, <em>generic_instantiation=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Type</span></code> class describes the type information of a typed element in the
|
||
interface definiton language. The following elements in the metamodel are
|
||
typed:</p>
|
||
<ul class="simple">
|
||
<li><p>Field element in a structure element. See <code class="xref py py-attr docutils literal notranslate"><span class="pre">StructureInfo.fields</span></code></p></li>
|
||
<li><p>Parameter element in an operation element. See
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">OperationInfo.params</span></code></p></li>
|
||
<li><p>Result element in an operation element. See <code class="xref py py-attr docutils literal notranslate"><span class="pre">OperationInfo.output</span></code></p></li>
|
||
</ul>
|
||
<blockquote>
|
||
<div><p>The type could be one of the three following categories:</p>
|
||
</div></blockquote>
|
||
<ul class="simple">
|
||
<li><p>Built-in types: These are types present in the interface definition
|
||
language type system. They are provided by the infrastructure.</p></li>
|
||
<li><p>User defined named type: API designers can create custom types and use
|
||
them for the typed elements. These types have a unique identifier.</p></li>
|
||
<li><p>Generic type instantiation: The language infrastructure also provides
|
||
generic types such as list, map, set and so on. An instantiation of one of
|
||
these generic types could also be used for the typed elements.</p></li>
|
||
</ul>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>category</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Type.Category" title="com.vmware.vapi.metadata.metamodel_client.Type.Category"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type.Category</span></code></a>) – Category of this type.</p></li>
|
||
<li><p><strong>builtin_type</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType" title="com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type.BuiltinType</span></code></a>) – Category of the built-in type.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Type.Category.BUILTIN" title="com.vmware.vapi.metadata.metamodel_client.Type.Category.BUILTIN"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Type.Category.BUILTIN</span></code></a>.</p></li>
|
||
<li><p><strong>user_defined_type</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.UserDefinedType" title="com.vmware.vapi.metadata.metamodel_client.UserDefinedType"><code class="xref py py-class docutils literal notranslate"><span class="pre">UserDefinedType</span></code></a>) – Identifier and type of the user defined type.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Type.Category.USER_DEFINED" title="com.vmware.vapi.metadata.metamodel_client.Type.Category.USER_DEFINED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Type.Category.USER_DEFINED</span></code></a>.</p></li>
|
||
<li><p><strong>generic_instantiation</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation" title="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation"><code class="xref py py-class docutils literal notranslate"><span class="pre">GenericInstantiation</span></code></a>) – Instantiation of one of the generic types available in the
|
||
interface definition language.
|
||
This attribute is optional and it is only relevant when the value
|
||
of <code class="docutils literal notranslate"><span class="pre">category</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Type.Category.GENERIC" title="com.vmware.vapi.metadata.metamodel_client.Type.Category.GENERIC"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Type.Category.GENERIC</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType">
|
||
<em class="property">class </em><code class="descname">BuiltinType</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Type.BuiltinType</span></code> class provides class attribute for each of the
|
||
built-in types present in the interface definition language type system.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">BuiltinType</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.ANY_ERROR">
|
||
<code class="descname">ANY_ERROR</code><em class="property"> = BuiltinType(string='ANY_ERROR')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.ANY_ERROR" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The built-in type is an arbitrary exception type. This is used if the value
|
||
of a typed element can be one of any user defined named type which is an
|
||
exception.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.BINARY">
|
||
<code class="descname">BINARY</code><em class="property"> = BuiltinType(string='BINARY')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.BINARY" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The built-in type is a binary. The value is a variable-length sequence of
|
||
zero or more bytes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.BOOLEAN">
|
||
<code class="descname">BOOLEAN</code><em class="property"> = BuiltinType(string='BOOLEAN')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.BOOLEAN" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The built-in type is a boolean. The value is true or false.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.DATE_TIME">
|
||
<code class="descname">DATE_TIME</code><em class="property"> = BuiltinType(string='DATE_TIME')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.DATE_TIME" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The built-in type is a datetime. The value should be in the UTC timezone
|
||
and the precision is milliseconds.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.DOUBLE">
|
||
<code class="descname">DOUBLE</code><em class="property"> = BuiltinType(string='DOUBLE')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.DOUBLE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The built-in type is a double. The value is a 64 bit floating point number.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.DYNAMIC_STRUCTURE">
|
||
<code class="descname">DYNAMIC_STRUCTURE</code><em class="property"> = BuiltinType(string='DYNAMIC_STRUCTURE')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.DYNAMIC_STRUCTURE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The built-in type is a dynamic structure. This is used if the value of a
|
||
typed element can be one of any user defined named type.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.ID">
|
||
<code class="descname">ID</code><em class="property"> = BuiltinType(string='ID')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.ID" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The built-in type is an ID. The value represents an identifier for a
|
||
resource.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.LONG">
|
||
<code class="descname">LONG</code><em class="property"> = BuiltinType(string='LONG')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.LONG" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The built-in type is a long. The value is a 64 bit signed integer.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.OPAQUE">
|
||
<code class="descname">OPAQUE</code><em class="property"> = BuiltinType(string='OPAQUE')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.OPAQUE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The built-in type is an opaque. This is used if the value of a typed
|
||
element could be of any type and the actual type will be known only during
|
||
the execution of the API. This is mostly used in infrastructure classes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.SECRET">
|
||
<code class="descname">SECRET</code><em class="property"> = BuiltinType(string='SECRET')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.SECRET" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The built-in type is a secret. The value is a variable-length sequence of
|
||
zero or more unicode characters. The value contains sensitive data that
|
||
should not be printed or displayed anywhere.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.STRING">
|
||
<code class="descname">STRING</code><em class="property"> = BuiltinType(string='STRING')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.STRING" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The built-in type is a string. The value is a variable-length sequence of
|
||
zero or more unicode characters.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.URI">
|
||
<code class="descname">URI</code><em class="property"> = BuiltinType(string='URI')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.URI" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The built-in type is an URI. The value follows the IRI specification in RFC
|
||
3987.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.VOID">
|
||
<code class="descname">VOID</code><em class="property"> = BuiltinType(string='VOID')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType.VOID" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The built-in type is a void. The value is None.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Type.Category">
|
||
<em class="property">class </em><code class="descname">Category</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Type.Category" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Type.Category</span></code> class provides class attribute for each category of
|
||
the type.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This class represents an enumerated type in the interface language
|
||
definition. The class contains class attributes which represent the
|
||
values in the current version of the enumerated type. Newer versions of
|
||
the enumerated type may contain new values. To use new values of the
|
||
enumerated type in communication with a server that supports the newer
|
||
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
||
type description page</span></a>.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">Category</span></code> instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Type.Category.BUILTIN">
|
||
<code class="descname">BUILTIN</code><em class="property"> = Category(string='BUILTIN')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Type.Category.BUILTIN" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The type is one of the built-in types specified in
|
||
<a class="reference internal" href="#com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType" title="com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType"><code class="xref py py-class docutils literal notranslate"><span class="pre">Type.BuiltinType</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Type.Category.GENERIC">
|
||
<code class="descname">GENERIC</code><em class="property"> = Category(string='GENERIC')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Type.Category.GENERIC" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The type is an instantiation of one of the generic types.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.Type.Category.USER_DEFINED">
|
||
<code class="descname">USER_DEFINED</code><em class="property"> = Category(string='USER_DEFINED')</em><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.Type.Category.USER_DEFINED" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The type is one of the user defined named types.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.metamodel_client.UserDefinedType">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><code class="descname">UserDefinedType</code><span class="sig-paren">(</span><em>resource_type=None</em>, <em>resource_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.metamodel_client.UserDefinedType" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">UserDefinedType</span></code> class contains the metamodel type information of a
|
||
typed element whose type is a user defined named type.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>resource_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Category of the user defined named type. The named type could be a
|
||
structure element or an enumeration element.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be one of <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code> or
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.enumeration</span></code>. When methods return a value of
|
||
this class as a return value, the attribute will be one of
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code> or <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.enumeration</span></code>.</p></li>
|
||
<li><p><strong>resource_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the user defined named type.
|
||
When clients pass a value of this class as a parameter, the
|
||
attribute must be an identifier for one of these resource types:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code> or <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.enumeration</span></code>.
|
||
When methods return a value of this class as a return value, the
|
||
attribute will be an identifier for one of these resource types:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.structure</span></code> or <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.enumeration</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-com.vmware.vapi.metadata.privilege_client">
|
||
<span id="com-vmware-vapi-metadata-privilege-client-module"></span><h2>com.vmware.vapi.metadata.privilege_client module<a class="headerlink" href="#module-com.vmware.vapi.metadata.privilege_client" title="Permalink to this headline">¶</a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.privilege_client</span></code> module provides classes that
|
||
expose privilege information for operation elements across all the service
|
||
elements.</p>
|
||
<p>An entity has a unique identifier and a resource type. An entity can either be
|
||
present in one of the parameter elements or if a parameter is a structure
|
||
element, it could also be present in one of the field elements.</p>
|
||
<p>Privileges can be assigned to either operation elements or entities used in the
|
||
operation element. A list of privileges can also be applied on a package
|
||
element. This list of privileges would be used as a default for all the
|
||
operation elements and the entities that do not have any defined privileges.</p>
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.privilege_client.Component">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.privilege_client.</code><code class="descname">Component</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege_client.Component" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Component</span></code> class provides methods to retrieve privilege information
|
||
of a component element.</p>
|
||
<p>A component element is said to contain privilege information if any one of
|
||
package elements in it contains privilege information.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.privilege_client.Component.RESOURCE_TYPE">
|
||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vapi.component'</em><a class="headerlink" href="#com.vmware.vapi.metadata.privilege_client.Component.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resource type for vAPI component.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.privilege_client.Component.fingerprint">
|
||
<code class="descname">fingerprint</code><span class="sig-paren">(</span><em>component_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege_client.Component.fingerprint" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieves the fingerprint computed from the privilege metadata of the
|
||
component element corresponding to <code class="docutils literal notranslate"><span class="pre">component_id</span></code>.</p>
|
||
<p>The fingerprint provides clients an efficient way to check if the
|
||
metadata for a particular component has been modified on the server.
|
||
The client can do this by comparing the result of this operation with
|
||
the fingerprint returned in the result of <a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.Component.get" title="com.vmware.vapi.metadata.privilege_client.Component.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Component.get()</span></code></a>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>component_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component element.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.component</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The fingerprint computed from the privilege metadata of the
|
||
component.</p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the component element associated with <code class="docutils literal notranslate"><span class="pre">component_id</span></code> does not
|
||
have any privilege information.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.privilege_client.Component.get">
|
||
<code class="descname">get</code><span class="sig-paren">(</span><em>component_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege_client.Component.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieves privilege information about the component element
|
||
corresponding to <code class="docutils literal notranslate"><span class="pre">component_id</span></code>.</p>
|
||
<p>The <a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.ComponentData" title="com.vmware.vapi.metadata.privilege_client.ComponentData"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentData</span></code></a> contains the privilege information about the
|
||
component element and its fingerprint. It contains information about
|
||
all the package elements that belong to this component element.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>component_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the component element.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.component</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.ComponentData" title="com.vmware.vapi.metadata.privilege_client.ComponentData"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentData</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.ComponentData" title="com.vmware.vapi.metadata.privilege_client.ComponentData"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentData</span></code></a> instance that corresponds to
|
||
<code class="docutils literal notranslate"><span class="pre">component_id</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the component element associated with <code class="docutils literal notranslate"><span class="pre">component_id</span></code> does not
|
||
have any privilege information.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.privilege_client.Component.list">
|
||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege_client.Component.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the identifiers for the component elements that have privilege
|
||
information.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.Component.list" title="com.vmware.vapi.metadata.privilege_client.Component.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The list of identifiers for the component elements that have
|
||
privilege information.
|
||
The return value will contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.component</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.privilege_client.ComponentData">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.privilege_client.</code><code class="descname">ComponentData</code><span class="sig-paren">(</span><em>info=None</em>, <em>fingerprint=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege_client.ComponentData" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ComponentData</span></code> class contains the privilege information of the
|
||
component along with its fingerprint.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>info</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.ComponentInfo" title="com.vmware.vapi.metadata.privilege_client.ComponentInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ComponentInfo</span></code></a>) – Privilege information of the component. This includes information
|
||
about all the modules in the component.</p></li>
|
||
<li><p><strong>fingerprint</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Fingerprint of the metadata of the component.</p>
|
||
<p>Privilege information could change when there is an infrastructure
|
||
update. Since the data present in <code class="xref py py-attr docutils literal notranslate"><span class="pre">ComponentData.info</span></code> could
|
||
be quite large, <code class="docutils literal notranslate"><span class="pre">fingerprint</span></code> provides a convenient way to check
|
||
if the data for a particular component is updated.</p>
|
||
<p>You should store the fingerprint associated with a component. After
|
||
an update, by invoking the <a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.Component.fingerprint" title="com.vmware.vapi.metadata.privilege_client.Component.fingerprint"><code class="xref py py-func docutils literal notranslate"><span class="pre">Component.fingerprint()</span></code></a> method,
|
||
you can retrieve the new fingerprint for the component. If the new
|
||
fingerprint and the previously stored fingerprint do not match,
|
||
clients can then use the <a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.Component.get" title="com.vmware.vapi.metadata.privilege_client.Component.get"><code class="xref py py-func docutils literal notranslate"><span class="pre">Component.get()</span></code></a> to retrieve the new
|
||
privilege information for the component.</p>
|
||
</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.privilege_client.ComponentInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.privilege_client.</code><code class="descname">ComponentInfo</code><span class="sig-paren">(</span><em>packages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege_client.ComponentInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ComponentInfo</span></code> class contains the privilege information of a
|
||
component element.</p>
|
||
<p>For an explanation of privilege information contained within component
|
||
elements, see <a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.Component" title="com.vmware.vapi.metadata.privilege_client.Component"><code class="xref py py-class docutils literal notranslate"><span class="pre">Component</span></code></a>.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>packages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.PackageInfo" title="com.vmware.vapi.metadata.privilege_client.PackageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackageInfo</span></code></a>) – <p>Privilege information of all the package elements. The key in the
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the identifier of the package element and the
|
||
value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the privilege information for the
|
||
package element.</p>
|
||
<p>For an explanation of privilege information containment within
|
||
package elements, see <a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.Package" title="com.vmware.vapi.metadata.privilege_client.Package"><code class="xref py py-class docutils literal notranslate"><span class="pre">Package</span></code></a>.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.package</span></code>. When methods return a value of
|
||
this class as a return value, the key in the attribute
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.package</span></code>.</p>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.privilege_client.OperationInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.privilege_client.</code><code class="descname">OperationInfo</code><span class="sig-paren">(</span><em>privileges=None</em>, <em>privilege_info=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege_client.OperationInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">OperationInfo</span></code> class contains privilege information of an operation
|
||
element.</p>
|
||
<p>For an explanation of containment within operation elements, see
|
||
<a class="reference internal" href="com.vmware.vapi.metadata.privilege.html#com.vmware.vapi.metadata.privilege.service_client.Operation" title="com.vmware.vapi.metadata.privilege.service_client.Operation"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.privilege.service_client.Operation</span></code></a>.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>privileges</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of all privileges assigned to the operation element.</p></li>
|
||
<li><p><strong>privilege_info</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.PrivilegeInfo" title="com.vmware.vapi.metadata.privilege_client.PrivilegeInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrivilegeInfo</span></code></a>) – Privilege information of all the parameter elements of the
|
||
operation element. For an explanation of containment of privilege
|
||
information within parameter elements, see <a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.PrivilegeInfo" title="com.vmware.vapi.metadata.privilege_client.PrivilegeInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PrivilegeInfo</span></code></a>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.privilege_client.Package">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.privilege_client.</code><code class="descname">Package</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege_client.Package" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Package</span></code> class provides methods to retrieve privilege information of
|
||
a package element.</p>
|
||
<p>A package element is said to contain privilege information if there is a
|
||
default privilege assigned to all service elements contained in the package
|
||
element or if one of the operation elements contained in one of the service
|
||
elements in this package element has privilege information.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.privilege_client.Package.RESOURCE_TYPE">
|
||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vapi.package'</em><a class="headerlink" href="#com.vmware.vapi.metadata.privilege_client.Package.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resource type for package.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.privilege_client.Package.get">
|
||
<code class="descname">get</code><span class="sig-paren">(</span><em>package_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege_client.Package.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieves privilege information about the package element corresponding
|
||
to <code class="docutils literal notranslate"><span class="pre">package_id</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>package_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the package element.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.package</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.PackageInfo" title="com.vmware.vapi.metadata.privilege_client.PackageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackageInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.PackageInfo" title="com.vmware.vapi.metadata.privilege_client.PackageInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">PackageInfo</span></code></a> instance that corresponds to
|
||
<code class="docutils literal notranslate"><span class="pre">package_id</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the package element associated with <code class="docutils literal notranslate"><span class="pre">package_id</span></code> does not have
|
||
any privilege information.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.privilege_client.Package.list">
|
||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege_client.Package.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the identifiers for the package elements that have privilege
|
||
information.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.Package.list" title="com.vmware.vapi.metadata.privilege_client.Package.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The list of identifiers for the package elements that have
|
||
privilege information.
|
||
The return value will contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.package</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.privilege_client.PackageInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.privilege_client.</code><code class="descname">PackageInfo</code><span class="sig-paren">(</span><em>privileges=None</em>, <em>services=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege_client.PackageInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">PackageInfo</span></code> class contains the privilege information of a package
|
||
element.</p>
|
||
<p>For an explanation of privilege information contained within package
|
||
elements, see <a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.Package" title="com.vmware.vapi.metadata.privilege_client.Package"><code class="xref py py-class docutils literal notranslate"><span class="pre">Package</span></code></a>.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>privileges</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of default privileges to be used for all the operations
|
||
present in this package. If a particular operation element has no
|
||
explicit privileges defined in the privilege definition file, these
|
||
privileges are used for enforcing authorization.</p></li>
|
||
<li><p><strong>services</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.ServiceInfo" title="com.vmware.vapi.metadata.privilege_client.ServiceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceInfo</span></code></a>) – Information about all service elements contained in this package
|
||
element that contain privilege information. The key in the
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the identifier of the service element and the
|
||
value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the privilege information for the
|
||
service element. For an explanation of privilege information
|
||
containment within service elements, see <a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.Service" title="com.vmware.vapi.metadata.privilege_client.Service"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service</span></code></a>.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>. When methods return a value of
|
||
this class as a return value, the key in the attribute
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.privilege_client.PrivilegeInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.privilege_client.</code><code class="descname">PrivilegeInfo</code><span class="sig-paren">(</span><em>property_path=None</em>, <em>privileges=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege_client.PrivilegeInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">PrivilegeInfo</span></code> class contains the privilege information for a
|
||
parameter element in an operation element.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>property_path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>The <code class="docutils literal notranslate"><span class="pre">propertyPath</span></code> points to an entity that is used in the
|
||
operation element. An entity can either be present in one of the
|
||
parameter elements or if a parameter is a structure element, it
|
||
could also be present in one of the field elements.</p>
|
||
<p>If the privilege is assigned to an entity used in the parameter,
|
||
<code class="docutils literal notranslate"><span class="pre">propertyPath</span></code> will just contain the name of the parameter field.
|
||
If the privilege is assigned to an entity in one of the field
|
||
elements of a parameter element that is a structure element, then
|
||
<code class="docutils literal notranslate"><span class="pre">propertyPath</span></code> will contain a path to the field element starting
|
||
from the parameter name.</p>
|
||
</p></li>
|
||
<li><p><strong>privileges</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – List of privileges assigned to the entity that is being referred by
|
||
<code class="xref py py-attr docutils literal notranslate"><span class="pre">PrivilegeInfo.property_path</span></code>.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.privilege_client.Service">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.privilege_client.</code><code class="descname">Service</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege_client.Service" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">Service</span></code> class provides methods to retrieve privilege information of
|
||
a service element.</p>
|
||
<p>A service element is said to contain privilege information if one of the
|
||
operation elements contained in this service element has privilege
|
||
information.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="attribute">
|
||
<dt id="com.vmware.vapi.metadata.privilege_client.Service.RESOURCE_TYPE">
|
||
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.vapi.service'</em><a class="headerlink" href="#com.vmware.vapi.metadata.privilege_client.Service.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Resource type for service.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.privilege_client.Service.get">
|
||
<code class="descname">get</code><span class="sig-paren">(</span><em>service_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege_client.Service.get" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Retrieves privilege information about the service element corresponding
|
||
to <code class="docutils literal notranslate"><span class="pre">service_id</span></code>.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>service_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the service element.
|
||
The parameter must be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.ServiceInfo" title="com.vmware.vapi.metadata.privilege_client.ServiceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceInfo</span></code></a></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.ServiceInfo" title="com.vmware.vapi.metadata.privilege_client.ServiceInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ServiceInfo</span></code></a> instance that corresponds to
|
||
<code class="docutils literal notranslate"><span class="pre">service_id</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Raise</dt>
|
||
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
|
||
if the service element associated with <code class="docutils literal notranslate"><span class="pre">service_id</span></code> does not have
|
||
any privilege information.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="com.vmware.vapi.metadata.privilege_client.Service.list">
|
||
<code class="descname">list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege_client.Service.list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the identifiers for the service elements that have privilege
|
||
information.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p><a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.Service.list" title="com.vmware.vapi.metadata.privilege_client.Service.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The list of identifiers for the service elements that have
|
||
privilege information.
|
||
The return value will contain identifiers for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.service</span></code>.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.privilege_client.ServiceInfo">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.privilege_client.</code><code class="descname">ServiceInfo</code><span class="sig-paren">(</span><em>operations=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege_client.ServiceInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">ServiceInfo</span></code> class contains privilege information of a service
|
||
element.</p>
|
||
<p>For an explanation of privilege information contained within service
|
||
elements, see <a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.Service" title="com.vmware.vapi.metadata.privilege_client.Service"><code class="xref py py-class docutils literal notranslate"><span class="pre">Service</span></code></a>.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Tip</p>
|
||
<p>The arguments are used to initialize data attributes with the same
|
||
names.</p>
|
||
</div>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>operations</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.metadata.privilege_client.OperationInfo" title="com.vmware.vapi.metadata.privilege_client.OperationInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">OperationInfo</span></code></a>) – <p>Information about all operation elements contained in this service
|
||
element that contain privilege information. The key in the
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the identifier of the operation element and the
|
||
value in the <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> is the privilege information for the
|
||
operation element.</p>
|
||
<p>For an explanation of containment of privilege information within
|
||
operation elements, see
|
||
<a class="reference internal" href="com.vmware.vapi.metadata.privilege.html#com.vmware.vapi.metadata.privilege.service_client.Operation" title="com.vmware.vapi.metadata.privilege.service_client.Operation"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.privilege.service_client.Operation</span></code></a>.
|
||
When clients pass a value of this class as a parameter, the key in
|
||
the attribute <code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> must be an identifier for the resource
|
||
type: <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>. When methods return a value of
|
||
this class as a return value, the key in the attribute
|
||
<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> will be an identifier for the resource type:
|
||
<code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.operation</span></code>.</p>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="com.vmware.vapi.metadata.privilege_client.StubFactory">
|
||
<em class="property">class </em><code class="descclassname">com.vmware.vapi.metadata.privilege_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata.privilege_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
||
<p>Initialize StubFactoryBase</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="com.vmware.vapi.metadata.authentication.html" class="btn btn-neutral float-right" title="com.vmware.vapi.metadata.authentication package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="com.vmware.vapi.html" class="btn btn-neutral float-left" title="com.vmware.vapi package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2019, VMware, Inc.
|
||
|
||
</p>
|
||
</div>
|
||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |