<spanid="com-vmware-vapi-metadata-package"></span><h1>com.vmware.vapi.metadata package<aclass="headerlink"href="#module-com.vmware.vapi.metadata"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="subpackages">
<h2>Subpackages<aclass="headerlink"href="#subpackages"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-vapi-metadata-authentication-client-module"></span><h2>com.vmware.vapi.metadata.authentication_client module<aclass="headerlink"href="#module-com.vmware.vapi.metadata.authentication_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.authentication_client.</code><codeclass="descname">AuthenticationInfo</code><spanclass="sig-paren">(</span><em>scheme_type=None</em>, <em>session_manager=None</em>, <em>scheme=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.AuthenticationInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>scheme_type</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.authentication_client.AuthenticationInfo.SchemeType"title="com.vmware.vapi.metadata.authentication_client.AuthenticationInfo.SchemeType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AuthenticationInfo.SchemeType</span></code></a>) – The type of the authentication scheme.</li>
<li><strong>session_manager</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – In a session aware authentication scheme, a session manager is
required that supports <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">delete</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">keepAlive</span></code>
methods. The fully qualified class name of the session manager is
provided in <codeclass="xref py py-attr docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">schemeType</span></code> is
<emclass="property">class </em><codeclass="descname">SchemeType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.AuthenticationInfo.SchemeType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">AuthenticationInfo.SchemeType</span></code> class provides class attributes for
the set of valid authentication scheme types.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">SESSIONLESS</code><emclass="property"> = SchemeType(string='SESSIONLESS')</em><aclass="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
<codeclass="descname">SESSION_AWARE</code><emclass="property"> = SchemeType(string='SESSION_AWARE')</em><aclass="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
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.authentication_client.</code><codeclass="descname">Component</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.Component"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vapi.component'</em><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.Component.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">fingerprint</code><spanclass="sig-paren">(</span><em>component_id</em><spanclass="sig-paren">)</span><aclass="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 <codeclass="docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.authentication_client.Component.get"title="com.vmware.vapi.metadata.authentication_client.Component.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Component.get()</span></code></a>.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>component_id</em><spanclass="sig-paren">)</span><aclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">component_id</span></code>.</p>
<p>The <aclass="reference internal"href="#com.vmware.vapi.metadata.authentication_client.ComponentData"title="com.vmware.vapi.metadata.authentication_client.ComponentData"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.authentication_client.</code><codeclass="descname">ComponentData</code><spanclass="sig-paren">(</span><em>info=None</em>, <em>fingerprint=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.ComponentData"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>info</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.authentication_client.ComponentInfo"title="com.vmware.vapi.metadata.authentication_client.ComponentInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComponentInfo</span></code></a>) – Authentication information of the component. This includes
information about all the modules in the component.</li>
<li><strong>fingerprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ComponentData.info</span></code> could be quite large, <codeclass="docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.authentication_client.Component.fingerprint"title="com.vmware.vapi.metadata.authentication_client.Component.fingerprint"><codeclass="xref py py-func docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.authentication_client.Component.get"title="com.vmware.vapi.metadata.authentication_client.Component.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Component.get()</span></code></a> to retrieve the new
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.authentication_client.</code><codeclass="descname">ComponentInfo</code><spanclass="sig-paren">(</span><em>packages=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.ComponentInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>packages</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.authentication_client.PackageInfo"title="com.vmware.vapi.metadata.authentication_client.PackageInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PackageInfo</span></code></a>) –<p>Authentication information of all the package elements. The key in
the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the identifier of the package element and the
value in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.authentication_client.Package"title="com.vmware.vapi.metadata.authentication_client.Package"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Package</span></code></a>.
When clients pass a value of this class as a parameter, the key in
the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.package</span></code>. When methods return a value of
this class as a return value, the key in the attribute
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.authentication_client.</code><codeclass="descname">OperationInfo</code><spanclass="sig-paren">(</span><em>schemes=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.OperationInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>schemes</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vapi.metadata.authentication_client.AuthenticationInfo"title="com.vmware.vapi.metadata.authentication_client.AuthenticationInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</td>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.authentication_client.</code><codeclass="descname">Package</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.Package"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vapi.package'</em><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.Package.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>package_id</em><spanclass="sig-paren">)</span><aclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">package_id</span></code>.</p>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.authentication_client.</code><codeclass="descname">PackageInfo</code><spanclass="sig-paren">(</span><em>schemes=None</em>, <em>services=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.PackageInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>schemes</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vapi.metadata.authentication_client.AuthenticationInfo"title="com.vmware.vapi.metadata.authentication_client.AuthenticationInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<li><strong>services</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.authentication_client.ServiceInfo"title="com.vmware.vapi.metadata.authentication_client.ServiceInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ServiceInfo</span></code></a>) –<p>Information about all service elements contained in this package
element that contain authentication information. The key in the
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the identifier of the service element and the
value in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.authentication_client.Service"title="com.vmware.vapi.metadata.authentication_client.Service"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Service</span></code></a>.
When clients pass a value of this class as a parameter, the key in
the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>. When methods return a value of
this class as a return value, the key in the attribute
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.authentication_client.</code><codeclass="descname">Service</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.Service"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vapi.service'</em><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.Service.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>service_id</em><spanclass="sig-paren">)</span><aclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">service_id</span></code>.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>service_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the service element.
The parameter must be an identifier for the resource type:
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.authentication_client.</code><codeclass="descname">ServiceInfo</code><spanclass="sig-paren">(</span><em>schemes=None</em>, <em>operations=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.ServiceInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>schemes</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vapi.metadata.authentication_client.AuthenticationInfo"title="com.vmware.vapi.metadata.authentication_client.AuthenticationInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<li><strong>operations</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.authentication_client.OperationInfo"title="com.vmware.vapi.metadata.authentication_client.OperationInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">OperationInfo</span></code></a>) –<p>Information about all operation elements contained in this service
element that contain authentication information. The key in the
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the identifier of the operation element and the
value in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the authentication information for
the operation element.</p>
<p>For an explanation of containment of authentication information
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.authentication_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vapi-metadata-cli-client-module"></span><h2>com.vmware.vapi.metadata.cli_client module<aclass="headerlink"href="#module-com.vmware.vapi.metadata.cli_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="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
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.cli_client.</code><codeclass="descname">Command</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Command"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<emclass="property">class </em><codeclass="descname">FormatterType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Command.FormatterType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Command.FormatterType</span></code> class defines supported CLI output formatter
types. See <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Command.Info.formatter</span></code>.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">CSV</code><emclass="property"> = FormatterType(string='CSV')</em><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Command.FormatterType.CSV"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">HTML</code><emclass="property"> = FormatterType(string='HTML')</em><aclass="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>
<codeclass="descname">JSON</code><emclass="property"> = FormatterType(string='JSON')</em><aclass="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>
<codeclass="descname">SIMPLE</code><emclass="property"> = FormatterType(string='SIMPLE')</em><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Command.FormatterType.SIMPLE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">TABLE</code><emclass="property"> = FormatterType(string='TABLE')</em><aclass="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>
<codeclass="descname">XML</code><emclass="property"> = FormatterType(string='XML')</em><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Command.FormatterType.XML"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descname">GenericType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Command.GenericType"title="Permalink to this definition">¶</a></dt>
<pclass="last">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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">LIST</code><emclass="property"> = GenericType(string='LIST')</em><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Command.GenericType.LIST"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">LIST_OPTIONAL</code><emclass="property"> = GenericType(string='LIST_OPTIONAL')</em><aclass="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
<codeclass="descname">NONE</code><emclass="property"> = GenericType(string='NONE')</em><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Command.GenericType.NONE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">OPTIONAL</code><emclass="property"> = GenericType(string='OPTIONAL')</em><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Command.GenericType.OPTIONAL"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">OPTIONAL_LIST</code><emclass="property"> = GenericType(string='OPTIONAL_LIST')</em><aclass="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
<emclass="property">class </em><codeclass="descname">Identity</code><spanclass="sig-paren">(</span><em>path=None</em>, <em>name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Command.Identity"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The dot-separated path of the namespace containing the command in
the CLI command tree.</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the command.</li>
<li><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The text description displayed to the user in help output.</li>
<li><strong>service_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>.</li>
<li><strong>operation_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>.</li>
<li><strong>options</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vapi.metadata.cli_client.Command.OptionInfo"title="com.vmware.vapi.metadata.cli_client.Command.OptionInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Command.OptionInfo</span></code></a>) – The input for this command.</li>
<li><strong>formatter</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.cli_client.Command.FormatterType"title="com.vmware.vapi.metadata.cli_client.Command.FormatterType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Command.FormatterType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="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.</li>
<li><strong>output_field_list</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vapi.metadata.cli_client.Command.OutputInfo"title="com.vmware.vapi.metadata.cli_client.Command.OutputInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Command.OutputInfo</span></code></a>) – List of output structure name and output field info.</li>
<emclass="property">class </em><codeclass="descname">OptionInfo</code><spanclass="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><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Command.OptionInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>long_option</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The long option name of the parameter as used by the user.</li>
<li><strong>short_option</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The single character value option name.
If not present, there’s no single character option for the
parameter.</li>
<li><strong>field_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The fully qualified name of the option referred to by the operation
element in <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Command.Info.operation_id</span></code>.</li>
<li><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The description of the option to be displayed to the user when they
request usage information for a CLI command.</li>
<li><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<li><strong>generic</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.cli_client.Command.GenericType"title="com.vmware.vapi.metadata.cli_client.Command.GenericType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<emclass="property">class </em><codeclass="descname">OutputFieldInfo</code><spanclass="sig-paren">(</span><em>field_name=None</em>, <em>display_name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Command.OutputFieldInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>field_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the attribute.</li>
<li><strong>display_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name used by the CLI to display the attribute.</li>
<emclass="property">class </em><codeclass="descname">OutputInfo</code><spanclass="sig-paren">(</span><em>structure_id=None</em>, <em>output_fields=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Command.OutputInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>structure_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.structure</span></code>.</li>
<li><strong>output_fields</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vapi.metadata.cli_client.Command.OutputFieldInfo"title="com.vmware.vapi.metadata.cli_client.Command.OutputFieldInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<codeclass="descname">fingerprint</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">Fingerprint of all the command metadata present on the server.</td>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>identity</em><spanclass="sig-paren">)</span><aclass="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
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>identity</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.cli_client.Command.Identity"title="com.vmware.vapi.metadata.cli_client.Command.Identity"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Command.Identity</span></code></a>) – Identifier of the command for which to retreive information.</td>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>path=None</em><spanclass="sig-paren">)</span><aclass="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
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.cli_client.</code><codeclass="descname">Namespace</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Namespace"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<emclass="property">class </em><codeclass="descname">Identity</code><spanclass="sig-paren">(</span><em>path=None</em>, <em>name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Namespace.Identity"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name displayed to the user for this namespace.</li>
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>identity=None</em>, <em>description=None</em>, <em>children=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Namespace.Info"title="Permalink to this definition">¶</a></dt>
<li><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The text description displayed to the user in help output.</li>
<li><strong>children</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vapi.metadata.cli_client.Namespace.Identity"title="com.vmware.vapi.metadata.cli_client.Namespace.Identity"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Namespace.Identity</span></code></a>) – The children of this namespace in the tree of CLI namespaces.</li>
<codeclass="descname">fingerprint</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">Fingerprint of all the namespace metadata present on the server.</td>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>identity</em><spanclass="sig-paren">)</span><aclass="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
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>identity</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.cli_client.Namespace.Identity"title="com.vmware.vapi.metadata.cli_client.Namespace.Identity"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Namespace.Identity</span></code></a>) – Identifier of the namespace for which to retreive information.</td>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.cli_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vapi-metadata-metamodel-client-module"></span><h2>com.vmware.vapi.metadata.metamodel_client module<aclass="headerlink"href="#module-com.vmware.vapi.metadata.metamodel_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<ulclass="simple">
<li>Enumeration: An enumeration element that has a list of enumeration value
elements.</li>
<li>Constant: A constant element has a name and a value.</li>
<li>Structure: A structure element can have field elements, constant elements and
enumeration elements.</li>
<li>Operation: An operation has a list of parameter elements, result element and
error elements.</li>
<li>Service: A service is a collection of operation elements, structure elements,
enumerated elements and constant elements.</li>
<li>Package: A package is a collection of service elements, structure elements
and enumeration elements.</li>
<li>Component: A component is a collection of package elements.</li>
</ul>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.metadata.metamodel_client</span></code> module has classes that
enables two styles of client applications:</p>
<ulclass="simple">
<li>A client can retrieve the exact pieces of information it requires using the
various granularities the API supports (that is <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.Component"title="com.vmware.vapi.metadata.metamodel_client.Component"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Component</span></code></a>,
and <aclass="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"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<li>A client can retrieve all the metamodel information in fewer method
invocations using the <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.Component"title="com.vmware.vapi.metadata.metamodel_client.Component"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Component</span></code></a> class and cache the output locally. It
can then poll on the fingerprint information exposed by the <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.Component"title="com.vmware.vapi.metadata.metamodel_client.Component"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Component</span></code></a>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">Component</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Component"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>The methods for package elements are provided by class <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.Package"title="com.vmware.vapi.metadata.metamodel_client.Package"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Package</span></code></a>.</div></blockquote>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vapi.component'</em><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Component.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">fingerprint</code><spanclass="sig-paren">(</span><em>component_id</em><spanclass="sig-paren">)</span><aclass="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 <codeclass="docutils literal notranslate"><spanclass="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
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>component_id</em><spanclass="sig-paren">)</span><aclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">component_id</span></code>.</p>
<p>The <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ComponentData"title="com.vmware.vapi.metadata.metamodel_client.ComponentData"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">ComponentData</code><spanclass="sig-paren">(</span><em>info=None</em>, <em>fingerprint=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.ComponentData"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>info</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ComponentInfo"title="com.vmware.vapi.metadata.metamodel_client.ComponentInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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>
</li>
<li><strong>fingerprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ComponentData.info</span></code> could be quite
large, <codeclass="docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.Component.fingerprint"title="com.vmware.vapi.metadata.metamodel_client.Component.fingerprint"><codeclass="xref py py-func docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.Component.get"title="com.vmware.vapi.metadata.metamodel_client.Component.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Component.get()</span></code></a> to retrieve the new
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">ComponentInfo</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>packages=None</em>, <em>metadata=None</em>, <em>documentation=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.ComponentInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<li><strong>packages</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.PackageInfo"title="com.vmware.vapi.metadata.metamodel_client.PackageInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PackageInfo</span></code></a>) – Metamodel metadata information of all the package elements
contained in the component element. The key in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is
the identifier of the package element and the value in the
<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.package</span></code>. When methods return a value of
this class as a return value, the key in the attribute
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<li><strong>metadata</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ElementMap"title="com.vmware.vapi.metadata.metamodel_client.ElementMap"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ElementMap</span></code></a>) –<p>Generic metadata for the component element. The key in the
<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"title="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MetadataIdentifier</span></code></a> contains possible string values for
keys in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code>.</p>
</li>
<li><strong>documentation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">ConstantInfo</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>value=None</em>, <em>documentation=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.ConstantInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.Type"title="com.vmware.vapi.metadata.metamodel_client.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Type</span></code></a>) – Type of the constant element.</li>
<li><strong>value</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ConstantValue"title="com.vmware.vapi.metadata.metamodel_client.ConstantValue"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ConstantValue</span></code></a>) – Value of the constant element.</li>
<li><strong>documentation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – English language documentation for the constant element. It can
contain HTML markup and documentation tags (similar to Javadoc
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">ConstantValue</code><spanclass="sig-paren">(</span><em>category=None</em>, <em>primitive_value=None</em>, <em>list_value=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.ConstantValue"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>category</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category"title="com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ConstantValue.Category</span></code></a>) – Category of the type of constant value.</li>
<li><strong>primitive_value</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue"title="com.vmware.vapi.metadata.metamodel_client.PrimitiveValue"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PrimitiveValue</span></code></a>) – Primitive value of the constant element.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category.PRIMITIVE"title="com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category.PRIMITIVE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ConstantValue.Category.PRIMITIVE</span></code></a>.</li>
<li><strong>list_value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue"title="com.vmware.vapi.metadata.metamodel_client.PrimitiveValue"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PrimitiveValue</span></code></a>) – List value of the constant element.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category.LIST"title="com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category.LIST"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ConstantValue.Category.LIST</span></code></a>.</li>
<emclass="property">class </em><codeclass="descname">Category</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ConstantValue.Category</span></code> class defines class attributes for the valid
kinds of values.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">LIST</code><emclass="property"> = Category(string='LIST')</em><aclass="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>
<codeclass="descname">PRIMITIVE</code><emclass="property"> = Category(string='PRIMITIVE')</em><aclass="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>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">ElementMap</code><spanclass="sig-paren">(</span><em>elements=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.ElementMap"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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
<codeclass="docutils literal notranslate"><spanclass="pre">ElementMap</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">ElementMap</span></code> describes the data specified in the
arguments for the annotation.</p>
<p>For example, in <codeclass="docutils literal notranslate"><spanclass="pre">\\@UnionCase(tag="tag",</span><spanclass="pre">value="SELECT")</span></code>, ElementMap
describes the keyword arguments tag and value.</p>
<divclass="admonition tip">
<pclass="first admonition-title">Tip</p>
<pclass="last">The arguments are used to initialize data attributes with the same
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">ElementValue</code><spanclass="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><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.ElementValue"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ElementValue.Type"title="com.vmware.vapi.metadata.metamodel_client.ElementValue.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ElementValue.Type</span></code></a>) – Type of the value.</li>
<li><strong>long_value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Long value of the metadata element.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.LONG"title="com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.LONG"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ElementValue.Type.LONG</span></code></a>.</li>
<li><strong>string_value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value of the metadata element.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRING"title="com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRING"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ElementValue.Type.STRING</span></code></a>.</li>
<li><strong>list_value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRING_LIST"title="com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRING_LIST"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ElementValue.Type.STRING_LIST</span></code></a>.</li>
<li><strong>structure_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.structure</span></code>.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRUCTURE_REFERENCE"title="com.vmware.vapi.metadata.metamodel_client.ElementValue.Type.STRUCTURE_REFERENCE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ElementValue.Type.STRUCTURE_REFERENCE</span></code></a>.</li>
<li><strong>structure_ids</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.structure</span></code>.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="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"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ElementValue.Type.STRUCTURE_REFERENCE_LIST</span></code></a>.</li>
<emclass="property">class </em><codeclass="descname">Type</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.ElementValue.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">ElementValue.Type</span></code> class defines the valid types for values in
metadata elements.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">LONG</code><emclass="property"> = Type(string='LONG')</em><aclass="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>
<codeclass="descname">STRING</code><emclass="property"> = Type(string='STRING')</em><aclass="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
<codeclass="descname">STRING_LIST</code><emclass="property"> = Type(string='STRING_LIST')</em><aclass="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>
<codeclass="descname">STRUCTURE_REFERENCE</code><emclass="property"> = Type(string='STRUCTURE_REFERENCE')</em><aclass="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>
<codeclass="descname">STRUCTURE_REFERENCE_LIST</code><emclass="property"> = Type(string='STRUCTURE_REFERENCE_LIST')</em><aclass="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
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">Enumeration</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Enumeration"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Enumeration</span></code> class provides methods to retrieve metamodel
information about an enumeration element in the interface definition
language.</p>
<blockquote>
<div>The <codeclass="docutils literal notranslate"><spanclass="pre">Enumeration</span></code> has a list of enumeration value elements.</div></blockquote>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vapi.enumeration'</em><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Enumeration.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>enumeration_id</em><spanclass="sig-paren">)</span><aclass="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
<p>The <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.EnumerationInfo"title="com.vmware.vapi.metadata.metamodel_client.EnumerationInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">EnumerationInfo</span></code></a> contains the metamodel information about
the enumeration value element contained in the enumeration element.</p>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">EnumerationInfo</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>values=None</em>, <em>metadata=None</em>, <em>documentation=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.EnumerationInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<li><strong>values</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.EnumerationValueInfo"title="com.vmware.vapi.metadata.metamodel_client.EnumerationValueInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<li><strong>metadata</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ElementMap"title="com.vmware.vapi.metadata.metamodel_client.ElementMap"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ElementMap</span></code></a>) –<p>Generic metadata elements for an enumeration element. The key in
the <codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"title="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MetadataIdentifier</span></code></a> contains possible string values for
keys in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code>.</p>
</li>
<li><strong>documentation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">EnumerationValueInfo</code><spanclass="sig-paren">(</span><em>value=None</em>, <em>metadata=None</em>, <em>documentation=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.EnumerationValueInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Value in the enumerated type. All the characters in the string are
capitalized.</li>
<li><strong>metadata</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ElementMap"title="com.vmware.vapi.metadata.metamodel_client.ElementMap"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ElementMap</span></code></a>) –<p>Additional metadata for enumeration value in the enumerated type.
The key in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"title="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MetadataIdentifier</span></code></a> contains possible string values for
keys in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code>.</p>
</li>
<li><strong>documentation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">ErrorInfo</code><spanclass="sig-paren">(</span><em>structure_id=None</em>, <em>documentation=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.ErrorInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>structure_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.structure</span></code>.</li>
<li><strong>documentation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The English language documentation for the service element. It can
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">FieldInfo</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>type=None</em>, <em>metadata=None</em>, <em>documentation=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.FieldInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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
<li><strong>metadata</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ElementMap"title="com.vmware.vapi.metadata.metamodel_client.ElementMap"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ElementMap</span></code></a>) –<p>Generic metadata elements for the field element. The key in the
<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"title="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MetadataIdentifier</span></code></a> contains possible string values for
keys in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code>.</p>
</li>
<li><strong>documentation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – English language documentation for the service element. It can
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">GenericInstantiation</code><spanclass="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><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>generic_type</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType"title="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">GenericInstantiation.GenericType</span></code></a>) – The generic type that is being instantiated.</li>
<li><strong>element_type</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.Type"title="com.vmware.vapi.metadata.metamodel_client.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Type</span></code></a>) – Type of the element parameter if the generic type instantiation is
a <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.LIST"title="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.LIST"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">GenericInstantiation.GenericType.LIST</span></code></a>,
<aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.OPTIONAL"title="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.OPTIONAL"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">GenericInstantiation.GenericType.OPTIONAL</span></code></a> or
<li><strong>map_key_type</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.Type"title="com.vmware.vapi.metadata.metamodel_client.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">genericType</span></code> is <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.MAP"title="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.MAP"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">GenericInstantiation.GenericType.MAP</span></code></a>.</li>
<li><strong>map_value_type</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.Type"title="com.vmware.vapi.metadata.metamodel_client.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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
<emclass="property">class </em><codeclass="descname">GenericType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">GenericInstantiation.GenericType</span></code> class provides class attributes
for each of the generic types provided by the infrastructure.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">LIST</code><emclass="property"> = GenericType(string='LIST')</em><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.LIST"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">MAP</code><emclass="property"> = GenericType(string='MAP')</em><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.MAP"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">OPTIONAL</code><emclass="property"> = GenericType(string='OPTIONAL')</em><aclass="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>
<codeclass="descname">SET</code><emclass="property"> = GenericType(string='SET')</em><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType.SET"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">MetadataIdentifier</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#module-com.vmware.vapi.metadata.metamodel_client"title="com.vmware.vapi.metadata.metamodel_client"><codeclass="xref py py-mod docutils literal notranslate"><spanclass="pre">com.vmware.vapi.metadata.metamodel_client</span></code></a>
package has a metadata field whose type is <codeclass="docutils literal notranslate"><spanclass="pre">Map<String,</span><spanclass="pre">ElementMap></span></code>.
<aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"title="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MetadataIdentifier</span></code></a> contains the identifiers used in the keys of
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">CANONICAL_NAME</code><emclass="property"> = 'CanonicalName'</em><aclass="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>
<codeclass="descname">COMPONENT</code><emclass="property"> = 'Component'</em><aclass="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>
<codeclass="descname">CREATE</code><emclass="property"> = 'Create'</em><aclass="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>
<codeclass="descname">CRUD</code><emclass="property"> = 'Crud'</em><aclass="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>
<codeclass="descname">HAS_FIELDS_OF</code><emclass="property"> = 'HasFieldsOf'</em><aclass="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>
<codeclass="descname">INCLUDABLE</code><emclass="property"> = 'Includable'</em><aclass="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>
<codeclass="descname">INCLUDE</code><emclass="property"> = 'Include'</em><aclass="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>
<codeclass="descname">IS_ONE_OF</code><emclass="property"> = 'IsOneOf'</em><aclass="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>
<codeclass="descname">MODEL</code><emclass="property"> = 'Model'</em><aclass="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>
<codeclass="descname">READ</code><emclass="property"> = 'Read'</em><aclass="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>
<codeclass="descname">RESOURCE</code><emclass="property"> = 'Resource'</em><aclass="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>
<codeclass="descname">UNION_CASE</code><emclass="property"> = 'UnionCase'</em><aclass="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>
<codeclass="descname">UNION_TAG</code><emclass="property"> = 'UnionTag'</em><aclass="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>
<codeclass="descname">UPDATE</code><emclass="property"> = 'Update'</em><aclass="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>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">OperationInfo</code><spanclass="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><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.OperationInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<li><strong>params</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.FieldInfo"title="com.vmware.vapi.metadata.metamodel_client.FieldInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<li><strong>output</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.OperationResultInfo"title="com.vmware.vapi.metadata.metamodel_client.OperationResultInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">OperationResultInfo</span></code></a>) – Metamodel type for the output element.</li>
<li><strong>errors</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ErrorInfo"title="com.vmware.vapi.metadata.metamodel_client.ErrorInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<li><strong>metadata</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ElementMap"title="com.vmware.vapi.metadata.metamodel_client.ElementMap"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ElementMap</span></code></a>) –<p>Generic metadata elements for the operation element. The key in the
<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"title="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MetadataIdentifier</span></code></a> contains possible string values for
key in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code>.</p>
</li>
<li><strong>documentation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – English language documentation for the service element. It can
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">OperationResultInfo</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>metadata=None</em>, <em>documentation=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.OperationResultInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.Type"title="com.vmware.vapi.metadata.metamodel_client.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Type</span></code></a>) – Type information of the operation result element.</li>
<li><strong>metadata</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ElementMap"title="com.vmware.vapi.metadata.metamodel_client.ElementMap"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ElementMap</span></code></a>) –<p>Generic metadata elements for the service element. The key in the
<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"title="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MetadataIdentifier</span></code></a> contains possible string values for
keys in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code>.</p>
</li>
<li><strong>documentation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – English language documentation for the operation result element. It
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">Package</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Package"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vapi.package'</em><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Package.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>package_id</em><spanclass="sig-paren">)</span><aclass="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
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">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:
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">PackageInfo</code><spanclass="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><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.PackageInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<li><strong>structures</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.StructureInfo"title="com.vmware.vapi.metadata.metamodel_client.StructureInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StructureInfo</span></code></a>) –<p>Metamodel information of all the structure elements contained in
the package element. The key in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the identifier
of the structure element and the value in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.structure</span></code>. When methods return a value of
this class as a return value, the key in the attribute
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<li><strong>enumerations</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.EnumerationInfo"title="com.vmware.vapi.metadata.metamodel_client.EnumerationInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">EnumerationInfo</span></code></a>) –<p>Metamodel information of all the enumeration elements contained in
the package element. The key in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the identifier
of the enumeration element and the value in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.enumeration</span></code>. When methods return a value
of this class as a return value, the key in the attribute
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<li><strong>services</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ServiceInfo"title="com.vmware.vapi.metadata.metamodel_client.ServiceInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ServiceInfo</span></code></a>) – Metamodel information of all the service elements contained in the
package element. The key in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the identifier of
the service element and the value in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>. When methods return a value of
this class as a return value, the key in the attribute
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<li><strong>metadata</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ElementMap"title="com.vmware.vapi.metadata.metamodel_client.ElementMap"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ElementMap</span></code></a>) –<p>Generic metadata elements for the package element. The key in the
<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"title="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MetadataIdentifier</span></code></a> contains possible string values for
keys in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code>.</p>
</li>
<li><strong>documentation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">PrimitiveValue</code><spanclass="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><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type"title="com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PrimitiveValue.Type</span></code></a>) – Type of the constant value.</li>
<li><strong>boolean_value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Boolean value of the constant.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.BOOLEAN"title="com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.BOOLEAN"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PrimitiveValue.Type.BOOLEAN</span></code></a>.</li>
<li><strong>double_value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">float</span></code>) – Double value of the constant.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.DOUBLE"title="com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.DOUBLE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PrimitiveValue.Type.DOUBLE</span></code></a>.</li>
<li><strong>long_value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Long value of the constant.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.LONG"title="com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.LONG"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PrimitiveValue.Type.LONG</span></code></a>.</li>
<li><strong>string_value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value of the constant.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.STRING"title="com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type.STRING"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PrimitiveValue.Type.STRING</span></code></a>.</li>
<emclass="property">class </em><codeclass="descname">Type</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">PrimitiveValue.Type</span></code> class defines the valid types for values in
constant elements.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">BOOLEAN</code><emclass="property"> = Type(string='BOOLEAN')</em><aclass="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>
<codeclass="descname">DOUBLE</code><emclass="property"> = Type(string='DOUBLE')</em><aclass="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>
<codeclass="descname">LONG</code><emclass="property"> = Type(string='LONG')</em><aclass="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>
<codeclass="descname">STRING</code><emclass="property"> = Type(string='STRING')</em><aclass="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).
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">Resource</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Resource"title="Permalink to this definition">¶</a></dt>
<p>The <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.Resource"title="com.vmware.vapi.metadata.metamodel_client.Resource"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vapi.resource'</em><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Resource.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">Service</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Service"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vapi.service'</em><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Service.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>service_id</em><spanclass="sig-paren">)</span><aclass="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
<p>The <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ServiceInfo"title="com.vmware.vapi.metadata.metamodel_client.ServiceInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ServiceInfo</span></code></a> contains the metamodel information for the
operation elements, structure elements and enumeration elements
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>service_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the service element.
The parameter must be an identifier for the resource type:
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">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:
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<li><strong>operations</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.OperationInfo"title="com.vmware.vapi.metadata.metamodel_client.OperationInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">OperationInfo</span></code></a>) – Metamodel information of all the operation elements contained in
the service element. The key in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the identifier
of the operation element and the value in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>. When methods return a value of
this class as a return value, the key in the attribute
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<li><strong>structures</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.StructureInfo"title="com.vmware.vapi.metadata.metamodel_client.StructureInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StructureInfo</span></code></a>) – Metamodel information of all the structure elements contained in
the service element. The key in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the identifier
of the structure element and the value in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.structure</span></code>. When methods return a value of
this class as a return value, the key in the attribute
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<li><strong>enumerations</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.EnumerationInfo"title="com.vmware.vapi.metadata.metamodel_client.EnumerationInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">EnumerationInfo</span></code></a>) – Metamodel information of all the enumeration elements contained in
the service element. The key in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the identifier
of the enumeration element and the value in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.enumeration</span></code>. When methods return a value
of this class as a return value, the key in the attribute
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<li><strong>constants</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ConstantInfo"title="com.vmware.vapi.metadata.metamodel_client.ConstantInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ConstantInfo</span></code></a>) – Metamodel information of all the constant elements contained in the
service element. The key in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the name of the
constant element and the value in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the
metamodel information for the contant element.</li>
<li><strong>metadata</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ElementMap"title="com.vmware.vapi.metadata.metamodel_client.ElementMap"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ElementMap</span></code></a>) –<p>Generic metadata elements for the service element. The key in the
<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"title="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MetadataIdentifier</span></code></a> contains possible string values for
keys in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code>.</p>
</li>
<li><strong>documentation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">Structure</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Structure"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vapi.structure'</em><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Structure.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>structure_id</em><spanclass="sig-paren">)</span><aclass="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
<p>The <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.StructureInfo"title="com.vmware.vapi.metadata.metamodel_client.StructureInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<li><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.StructureInfo.Type"title="com.vmware.vapi.metadata.metamodel_client.StructureInfo.Type"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">StructureInfo.Type</span></code></a>) – Type of the structure.</li>
<li><strong>enumerations</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.EnumerationInfo"title="com.vmware.vapi.metadata.metamodel_client.EnumerationInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">EnumerationInfo</span></code></a>) – Metamodel information of all the enumeration elements contained in
the structure element. The key in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.enumeration</span></code>. When methods return a value
of this class as a return value, the key in the attribute
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<li><strong>constants</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ConstantInfo"title="com.vmware.vapi.metadata.metamodel_client.ConstantInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ConstantInfo</span></code></a>) – Metamodel information of all the constant elements contained in the
structure element. The key in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the name of the
constant element and the value in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the
metamodel information for the constant element.</li>
<li><strong>fields</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.FieldInfo"title="com.vmware.vapi.metadata.metamodel_client.FieldInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<li><strong>metadata</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.ElementMap"title="com.vmware.vapi.metadata.metamodel_client.ElementMap"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ElementMap</span></code></a>) –<p>Generic metadata elements for the structure element. The key in the
<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"title="com.vmware.vapi.metadata.metamodel_client.MetadataIdentifier"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MetadataIdentifier</span></code></a> contains possible string values for
keys in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code>.</p>
</li>
<li><strong>documentation</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<emclass="property">class </em><codeclass="descname">Type</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.StructureInfo.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">ERROR</code><emclass="property"> = Type(string='ERROR')</em><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.StructureInfo.Type.ERROR"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STRUCTURE</code><emclass="property"> = Type(string='STRUCTURE')</em><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.StructureInfo.Type.STRUCTURE"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">Type</code><spanclass="sig-paren">(</span><em>category=None</em>, <em>builtin_type=None</em>, <em>user_defined_type=None</em>, <em>generic_instantiation=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Type"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<ulclass="simple">
<li>Field element in a structure element. See <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">StructureInfo.fields</span></code></li>
<li>Parameter element in an operation element. See
<li>Result element in an operation element. See <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OperationInfo.output</span></code></li>
</ul>
<blockquote>
<div>The type could be one of the three following categories:</div></blockquote>
<ulclass="simple">
<li>Built-in types: These are types present in the interface definition
language type system. They are provided by the infrastructure.</li>
<li>User defined named type: API designers can create custom types and use
them for the typed elements. These types have a unique identifier.</li>
<li>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.</li>
</ul>
<divclass="admonition tip">
<pclass="first admonition-title">Tip</p>
<pclass="last">The arguments are used to initialize data attributes with the same
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>category</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.Type.Category"title="com.vmware.vapi.metadata.metamodel_client.Type.Category"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Type.Category</span></code></a>) – Category of this type.</li>
<li><strong>builtin_type</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType"title="com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.Type.Category.BUILTIN"title="com.vmware.vapi.metadata.metamodel_client.Type.Category.BUILTIN"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Type.Category.BUILTIN</span></code></a>.</li>
<li><strong>user_defined_type</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.UserDefinedType"title="com.vmware.vapi.metadata.metamodel_client.UserDefinedType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.Type.Category.USER_DEFINED"title="com.vmware.vapi.metadata.metamodel_client.Type.Category.USER_DEFINED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Type.Category.USER_DEFINED</span></code></a>.</li>
<li><strong>generic_instantiation</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation"title="com.vmware.vapi.metadata.metamodel_client.GenericInstantiation"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">category</span></code> is <aclass="reference internal"href="#com.vmware.vapi.metadata.metamodel_client.Type.Category.GENERIC"title="com.vmware.vapi.metadata.metamodel_client.Type.Category.GENERIC"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Type.Category.GENERIC</span></code></a>.</li>
<emclass="property">class </em><codeclass="descname">BuiltinType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">ANY_ERROR</code><emclass="property"> = BuiltinType(string='ANY_ERROR')</em><aclass="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
<codeclass="descname">BINARY</code><emclass="property"> = BuiltinType(string='BINARY')</em><aclass="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
<codeclass="descname">BOOLEAN</code><emclass="property"> = BuiltinType(string='BOOLEAN')</em><aclass="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>
<codeclass="descname">DATE_TIME</code><emclass="property"> = BuiltinType(string='DATE_TIME')</em><aclass="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
<codeclass="descname">DOUBLE</code><emclass="property"> = BuiltinType(string='DOUBLE')</em><aclass="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>
<codeclass="descname">DYNAMIC_STRUCTURE</code><emclass="property"> = BuiltinType(string='DYNAMIC_STRUCTURE')</em><aclass="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>
<codeclass="descname">ID</code><emclass="property"> = BuiltinType(string='ID')</em><aclass="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
<codeclass="descname">LONG</code><emclass="property"> = BuiltinType(string='LONG')</em><aclass="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>
<codeclass="descname">OPAQUE</code><emclass="property"> = BuiltinType(string='OPAQUE')</em><aclass="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>
<codeclass="descname">SECRET</code><emclass="property"> = BuiltinType(string='SECRET')</em><aclass="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
<codeclass="descname">STRING</code><emclass="property"> = BuiltinType(string='STRING')</em><aclass="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
<codeclass="descname">URI</code><emclass="property"> = BuiltinType(string='URI')</em><aclass="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
<codeclass="descname">VOID</code><emclass="property"> = BuiltinType(string='VOID')</em><aclass="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>
<emclass="property">class </em><codeclass="descname">Category</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Type.Category"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Type.Category</span></code> class provides class attribute for each category of
the type.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">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 <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">BUILTIN</code><emclass="property"> = Category(string='BUILTIN')</em><aclass="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
<codeclass="descname">GENERIC</code><emclass="property"> = Category(string='GENERIC')</em><aclass="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>
<codeclass="descname">USER_DEFINED</code><emclass="property"> = Category(string='USER_DEFINED')</em><aclass="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>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="descname">UserDefinedType</code><spanclass="sig-paren">(</span><em>resource_type=None</em>, <em>resource_id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.UserDefinedType"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>resource_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.structure</span></code> or
<codeclass="docutils literal notranslate"><spanclass="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
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.structure</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.enumeration</span></code>.</li>
<li><strong>resource_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.structure</span></code> or <codeclass="docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.structure</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.enumeration</span></code>.</li>
<spanid="com-vmware-vapi-metadata-privilege-client-module"></span><h2>com.vmware.vapi.metadata.privilege_client module<aclass="headerlink"href="#module-com.vmware.vapi.metadata.privilege_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.privilege_client.</code><codeclass="descname">Component</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.Component"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vapi.component'</em><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.Component.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">fingerprint</code><spanclass="sig-paren">(</span><em>component_id</em><spanclass="sig-paren">)</span><aclass="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 <codeclass="docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.privilege_client.Component.get"title="com.vmware.vapi.metadata.privilege_client.Component.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Component.get()</span></code></a>.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>component_id</em><spanclass="sig-paren">)</span><aclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">component_id</span></code>.</p>
<p>The <aclass="reference internal"href="#com.vmware.vapi.metadata.privilege_client.ComponentData"title="com.vmware.vapi.metadata.privilege_client.ComponentData"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.privilege_client.</code><codeclass="descname">ComponentData</code><spanclass="sig-paren">(</span><em>info=None</em>, <em>fingerprint=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.ComponentData"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>info</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata.privilege_client.ComponentInfo"title="com.vmware.vapi.metadata.privilege_client.ComponentInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ComponentInfo</span></code></a>) – Privilege information of the component. This includes information
about all the modules in the component.</li>
<li><strong>fingerprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">ComponentData.info</span></code> could
be quite large, <codeclass="docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.privilege_client.Component.fingerprint"title="com.vmware.vapi.metadata.privilege_client.Component.fingerprint"><codeclass="xref py py-func docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.privilege_client.Component.get"title="com.vmware.vapi.metadata.privilege_client.Component.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Component.get()</span></code></a> to retrieve the new
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.privilege_client.</code><codeclass="descname">ComponentInfo</code><spanclass="sig-paren">(</span><em>packages=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.ComponentInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>packages</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.privilege_client.PackageInfo"title="com.vmware.vapi.metadata.privilege_client.PackageInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PackageInfo</span></code></a>) –<p>Privilege information of all the package elements. The key in the
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the identifier of the package element and the
value in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.privilege_client.Package"title="com.vmware.vapi.metadata.privilege_client.Package"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Package</span></code></a>.
When clients pass a value of this class as a parameter, the key in
the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.package</span></code>. When methods return a value of
this class as a return value, the key in the attribute
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.privilege_client.</code><codeclass="descname">OperationInfo</code><spanclass="sig-paren">(</span><em>privileges=None</em>, <em>privilege_info=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.OperationInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>privileges</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – List of all privileges assigned to the operation element.</li>
<li><strong>privilege_info</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vapi.metadata.privilege_client.PrivilegeInfo"title="com.vmware.vapi.metadata.privilege_client.PrivilegeInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.vapi.metadata.privilege_client.PrivilegeInfo"title="com.vmware.vapi.metadata.privilege_client.PrivilegeInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PrivilegeInfo</span></code></a>.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.privilege_client.</code><codeclass="descname">Package</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.Package"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vapi.package'</em><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.Package.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>package_id</em><spanclass="sig-paren">)</span><aclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">package_id</span></code>.</p>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.privilege_client.</code><codeclass="descname">PackageInfo</code><spanclass="sig-paren">(</span><em>privileges=None</em>, <em>services=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.PackageInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>privileges</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="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.</li>
<li><strong>services</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.privilege_client.ServiceInfo"title="com.vmware.vapi.metadata.privilege_client.ServiceInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ServiceInfo</span></code></a>) – Information about all service elements contained in this package
element that contain privilege information. The key in the
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the identifier of the service element and the
value in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the privilege information for the
service element. For an explanation of privilege information
containment within service elements, see <aclass="reference internal"href="#com.vmware.vapi.metadata.privilege_client.Service"title="com.vmware.vapi.metadata.privilege_client.Service"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Service</span></code></a>.
When clients pass a value of this class as a parameter, the key in
the attribute <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> must be an identifier for the resource
type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.service</span></code>. When methods return a value of
this class as a return value, the key in the attribute
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> will be an identifier for the resource type:
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.privilege_client.</code><codeclass="descname">PrivilegeInfo</code><spanclass="sig-paren">(</span><em>property_path=None</em>, <em>privileges=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.PrivilegeInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>property_path</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>The <codeclass="docutils literal notranslate"><spanclass="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,
<codeclass="docutils literal notranslate"><spanclass="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
<codeclass="docutils literal notranslate"><spanclass="pre">propertyPath</span></code> will contain a path to the field element starting
from the parameter name.</p>
</li>
<li><strong>privileges</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – List of privileges assigned to the entity that is being referred by
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.privilege_client.</code><codeclass="descname">Service</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.Service"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vapi.service'</em><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.Service.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>service_id</em><spanclass="sig-paren">)</span><aclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">service_id</span></code>.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>service_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the service element.
The parameter must be an identifier for the resource type:
<codeclass="descname">list</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="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
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.privilege_client.</code><codeclass="descname">ServiceInfo</code><spanclass="sig-paren">(</span><em>operations=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.ServiceInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>operations</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vapi.metadata.privilege_client.OperationInfo"title="com.vmware.vapi.metadata.privilege_client.OperationInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">OperationInfo</span></code></a>) –<p>Information about all operation elements contained in this service
element that contain privilege information. The key in the
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the identifier of the operation element and the
value in the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> is the privilege information for the
operation element.</p>
<p>For an explanation of containment of privilege information within
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata.privilege_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.StubFactory"title="Permalink to this definition">¶</a></dt>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.
