<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="sig-prename descclassname">com.vmware.vapi.metadata.authentication_client.</code><codeclass="sig-name descname">AuthenticationInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">scheme_type=None</em>, <emclass="sig-param">session_manager=None</em>, <emclass="sig-param">scheme=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.AuthenticationInfo"title="Permalink to this definition">¶</a></dt>
<li><p><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.</p></li>
<li><p><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
<emclass="property">class </em><codeclass="sig-name descname">SchemeType</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.AuthenticationInfo.SchemeType"title="Permalink to this definition">¶</a></dt>
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="sig-name 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>
<codeclass="sig-name 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>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.authentication_client.</code><codeclass="sig-name descname">Component</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.Component"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<codeclass="sig-name 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="sig-name descname">fingerprint</code><spanclass="sig-paren">(</span><emclass="sig-param">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="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
<codeclass="sig-name 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>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.authentication_client.</code><codeclass="sig-name descname">ComponentData</code><spanclass="sig-paren">(</span><emclass="sig-param">info=None</em>, <emclass="sig-param">fingerprint=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.ComponentData"title="Permalink to this definition">¶</a></dt>
<li><p><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.</p></li>
<li><p><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="sig-prename descclassname">com.vmware.vapi.metadata.authentication_client.</code><codeclass="sig-name descname">ComponentInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">packages=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.ComponentInfo"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.authentication_client.</code><codeclass="sig-name descname">OperationInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">schemes=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.OperationInfo"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.authentication_client.</code><codeclass="sig-name descname">Package</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.Package"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<codeclass="sig-name 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="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
<codeclass="sig-name 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>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.authentication_client.</code><codeclass="sig-name descname">PackageInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">schemes=None</em>, <emclass="sig-param">services=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.PackageInfo"title="Permalink to this definition">¶</a></dt>
<li><p><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
<li><p><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="sig-prename descclassname">com.vmware.vapi.metadata.authentication_client.</code><codeclass="sig-name descname">Service</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.Service"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<codeclass="sig-name 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="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
<ddclass="field-odd"><p><strong>service_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the service element.
<codeclass="sig-name 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>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.authentication_client.</code><codeclass="sig-name descname">ServiceInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">schemes=None</em>, <emclass="sig-param">operations=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.authentication_client.ServiceInfo"title="Permalink to this definition">¶</a></dt>
<li><p><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
<li><p><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
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.authentication_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">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="sig-prename descclassname">com.vmware.vapi.metadata.cli_client.</code><codeclass="sig-name descname">Command</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Command"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<emclass="property">class </em><codeclass="sig-name descname">FormatterType</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Command.FormatterType"title="Permalink to this definition">¶</a></dt>
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="sig-name 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="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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="sig-name 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>
<codeclass="sig-name 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="sig-name descname">GenericType</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Command.GenericType"title="Permalink to this definition">¶</a></dt>
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="sig-name 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="sig-name 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>
<codeclass="sig-name 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="sig-name 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="sig-name 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>
<emclass="property">class </em><codeclass="sig-name descname">Identity</code><spanclass="sig-paren">(</span><emclass="sig-param">path=None</em>, <emclass="sig-param">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>
<li><p><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.</p></li>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the command.</p></li>
<li><p><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.</p></li>
<li><p><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
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.operation</span></code>.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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.
<li><p><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>.</p></li>
<li><p><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.</p></li>
<li><p><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
class this stores the fully qualified class id.</p></li>
<li><p><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.</p></li>
<emclass="property">class </em><codeclass="sig-name descname">OutputFieldInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">field_name=None</em>, <emclass="sig-param">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>
<li><p><strong>field_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the attribute.</p></li>
<li><p><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.</p></li>
<emclass="property">class </em><codeclass="sig-name descname">OutputInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">structure_id=None</em>, <emclass="sig-param">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>
<li><p><strong>structure_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the class.
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.structure</span></code>.</p></li>
<li><p><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.</p></li>
<codeclass="sig-name 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>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">identity</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Command.get"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
<ddclass="field-odd"><p><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
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.cli_client.</code><codeclass="sig-name descname">Namespace</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Namespace"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<emclass="property">class </em><codeclass="sig-name descname">Identity</code><spanclass="sig-paren">(</span><emclass="sig-param">path=None</em>, <emclass="sig-param">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>
<li><p><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.</p></li>
<li><p><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.</p></li>
<emclass="property">class </em><codeclass="sig-name descname">Info</code><spanclass="sig-paren">(</span><emclass="sig-param">identity=None</em>, <emclass="sig-param">description=None</em>, <emclass="sig-param">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><p><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.</p></li>
<li><p><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.</p></li>
<codeclass="sig-name 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>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">identity</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.cli_client.Namespace.get"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<codeclass="sig-name 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>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.cli_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">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
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
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="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">Component</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Component"title="Permalink to this definition">¶</a></dt>
<div><p>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>.</p>
</div></blockquote>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><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.</p>
<codeclass="sig-name 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="sig-name descname">fingerprint</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">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="sig-name 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>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">ComponentData</code><spanclass="sig-paren">(</span><emclass="sig-param">info=None</em>, <emclass="sig-param">fingerprint=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.ComponentData"title="Permalink to this definition">¶</a></dt>
<li><p><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
<li><p><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="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">ComponentInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">name=None</em>, <emclass="sig-param">packages=None</em>, <emclass="sig-param">metadata=None</em>, <emclass="sig-param">documentation=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.ComponentInfo"title="Permalink to this definition">¶</a></dt>
<li><p><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
the segment into a different naming convention.</p></li>
<li><p><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
<li><p><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
<li><p><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
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">ConstantInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">type=None</em>, <emclass="sig-param">value=None</em>, <emclass="sig-param">documentation=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.ConstantInfo"title="Permalink to this definition">¶</a></dt>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><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
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">ConstantValue</code><spanclass="sig-paren">(</span><emclass="sig-param">category=None</em>, <emclass="sig-param">primitive_value=None</em>, <emclass="sig-param">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>
<li><p><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.</p></li>
<li><p><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.
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>.</p></li>
<li><p><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.
<emclass="property">class </em><codeclass="sig-name descname">Category</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.ConstantValue.Category"title="Permalink to this definition">¶</a></dt>
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="sig-name 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>
<codeclass="sig-name 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>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">ElementMap</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
<li><p><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.</p></li>
<li><p><strong>long_value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Long value of the metadata element.
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>.</p></li>
<li><p><strong>string_value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value of the metadata element.
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>.</p></li>
<li><p><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.
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>.</p></li>
<li><p><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.
<emclass="property">class </em><codeclass="sig-name descname">Type</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.ElementValue.Type"title="Permalink to this definition">¶</a></dt>
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="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">Enumeration</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Enumeration"title="Permalink to this definition">¶</a></dt>
<div><p>The <codeclass="docutils literal notranslate"><spanclass="pre">Enumeration</span></code> has a list of enumeration value elements.</p>
</div></blockquote>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><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.</p>
<codeclass="sig-name 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="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
<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="sig-name 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>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">EnumerationInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">name=None</em>, <emclass="sig-param">values=None</em>, <emclass="sig-param">metadata=None</em>, <emclass="sig-param">documentation=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.EnumerationInfo"title="Permalink to this definition">¶</a></dt>
<li><p><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
the segment into a different naming convention.</p></li>
<li><p><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
defined in the interface definition file.</p></li>
<li><p><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
<li><p><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
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">EnumerationValueInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">value=None</em>, <emclass="sig-param">metadata=None</em>, <emclass="sig-param">documentation=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.EnumerationValueInfo"title="Permalink to this definition">¶</a></dt>
<li><p><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.</p></li>
<li><p><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.
<li><p><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
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">ErrorInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">structure_id=None</em>, <emclass="sig-param">documentation=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.ErrorInfo"title="Permalink to this definition">¶</a></dt>
<li><p><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
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.structure</span></code>.</p></li>
<li><p><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="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">FieldInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">name=None</em>, <emclass="sig-param">type=None</em>, <emclass="sig-param">metadata=None</em>, <emclass="sig-param">documentation=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.FieldInfo"title="Permalink to this definition">¶</a></dt>
<li><p><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
<li><p><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
<li><p><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="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">GenericInstantiation</code><spanclass="sig-paren">(</span><emclass="sig-param">generic_type=None</em>, <emclass="sig-param">element_type=None</em>, <emclass="sig-param">map_key_type=None</em>, <emclass="sig-param">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>
<li><p><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.</p></li>
<li><p><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
<li><p><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.
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>.</p></li>
<li><p><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.
<emclass="property">class </em><codeclass="sig-name descname">GenericType</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.GenericInstantiation.GenericType"title="Permalink to this definition">¶</a></dt>
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="sig-name 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="sig-name 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="sig-name 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>
<codeclass="sig-name 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="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">MetadataIdentifier</code><spanclass="sig-paren">(</span><emclass="sig-param">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
<ddclass="field-odd"><p><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.</p>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<li><p><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
<li><p><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 declared in the interface definition file.</p></li>
<li><p><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.</p></li>
<li><p><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
error more than once with different documentation elements.</p></li>
<li><p><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
<li><p><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="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">OperationResultInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">type=None</em>, <emclass="sig-param">metadata=None</em>, <emclass="sig-param">documentation=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.OperationResultInfo"title="Permalink to this definition">¶</a></dt>
<li><p><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.</p></li>
<li><p><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
<li><p><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
can contain HTML markup and Javadoc tags.</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">Package</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Package"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<codeclass="sig-name 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="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
<codeclass="sig-name 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>
<li><p><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
<li><p><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
<li><p><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
<li><p><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
<li><p><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
<li><p><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
<li><p><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.</p></li>
<li><p><strong>boolean_value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Boolean value of the constant.
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>.</p></li>
<li><p><strong>double_value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">float</span></code>) – Double value of the constant.
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>.</p></li>
<li><p><strong>long_value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Long value of the constant.
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>.</p></li>
<li><p><strong>string_value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value of the constant.
<emclass="property">class </em><codeclass="sig-name descname">Type</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.PrimitiveValue.Type"title="Permalink to this definition">¶</a></dt>
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="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">Resource</code><spanclass="sig-paren">(</span><emclass="sig-param">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
<ddclass="field-odd"><p><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.</p>
<codeclass="sig-name 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="sig-name 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>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">Service</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Service"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<codeclass="sig-name 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="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
<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
<ddclass="field-odd"><p><strong>service_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the service element.
<codeclass="sig-name 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>
<li><p><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
<li><p><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
<li><p><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
<li><p><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
<li><p><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
metamodel information for the contant element.</p></li>
<li><p><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
<li><p><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="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">Structure</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Structure"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<codeclass="sig-name 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="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
<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="sig-name 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>
<li><p><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
the segment into a different naming convention.</p></li>
<li><p><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.</p></li>
<li><p><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
<li><p><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
metamodel information for the constant element.</p></li>
<li><p><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
<li><p><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
<li><p><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
<emclass="property">class </em><codeclass="sig-name descname">Type</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.StructureInfo.Type"title="Permalink to this definition">¶</a></dt>
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="sig-name 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="sig-name 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="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">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="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">Type</code><spanclass="sig-paren">(</span><emclass="sig-param">category=None</em>, <emclass="sig-param">builtin_type=None</em>, <emclass="sig-param">user_defined_type=None</em>, <emclass="sig-param">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>
<li><p>Field element in a structure element. See <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">StructureInfo.fields</span></code></p></li>
<li><p>Parameter element in an operation element. See
<li><p>Result element in an operation element. See <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">OperationInfo.output</span></code></p></li>
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>.</p></li>
<li><p><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.
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>.</p></li>
<li><p><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
<emclass="property">class </em><codeclass="sig-name descname">BuiltinType</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Type.BuiltinType"title="Permalink to this definition">¶</a></dt>
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="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<emclass="property">class </em><codeclass="sig-name descname">Category</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.metamodel_client.Type.Category"title="Permalink to this definition">¶</a></dt>
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="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.metamodel_client.</code><codeclass="sig-name descname">UserDefinedType</code><spanclass="sig-paren">(</span><emclass="sig-param">resource_type=None</em>, <emclass="sig-param">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>
<li><p><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
<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>.</p></li>
<li><p><strong>resource_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the user defined named type.
<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="sig-prename descclassname">com.vmware.vapi.metadata.privilege_client.</code><codeclass="sig-name descname">Component</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.Component"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<codeclass="sig-name 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="sig-name descname">fingerprint</code><spanclass="sig-paren">(</span><emclass="sig-param">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="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">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="sig-name 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>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.privilege_client.</code><codeclass="sig-name descname">ComponentData</code><spanclass="sig-paren">(</span><emclass="sig-param">info=None</em>, <emclass="sig-param">fingerprint=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.ComponentData"title="Permalink to this definition">¶</a></dt>
<li><p><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.</p></li>
<li><p><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="sig-prename descclassname">com.vmware.vapi.metadata.privilege_client.</code><codeclass="sig-name descname">ComponentInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">packages=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.ComponentInfo"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.privilege_client.</code><codeclass="sig-name descname">OperationInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">privileges=None</em>, <emclass="sig-param">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>
<li><p><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.</p></li>
<li><p><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
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>.</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.privilege_client.</code><codeclass="sig-name descname">Package</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.Package"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<codeclass="sig-name 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="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
<codeclass="sig-name 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>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.privilege_client.</code><codeclass="sig-name descname">PackageInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">privileges=None</em>, <emclass="sig-param">services=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.PackageInfo"title="Permalink to this definition">¶</a></dt>
<li><p><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
privileges are used for enforcing authorization.</p></li>
<li><p><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="sig-prename descclassname">com.vmware.vapi.metadata.privilege_client.</code><codeclass="sig-name descname">PrivilegeInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">property_path=None</em>, <emclass="sig-param">privileges=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.PrivilegeInfo"title="Permalink to this definition">¶</a></dt>
<li><p><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
<li><p><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="sig-prename descclassname">com.vmware.vapi.metadata.privilege_client.</code><codeclass="sig-name descname">Service</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.Service"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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.</p>
<codeclass="sig-name 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="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
<ddclass="field-odd"><p><strong>service_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the service element.
<codeclass="sig-name 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>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.privilege_client.</code><codeclass="sig-name descname">ServiceInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">operations=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata.privilege_client.ServiceInfo"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><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
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.vapi.metadata.privilege_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">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>.
