<spanid="com-vmware-vapi-package"></span><h1>com.vmware.vapi package<aclass="headerlink"href="#module-com.vmware.vapi"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-client-module"></span><h2>com.vmware.vapi.metadata_client module<aclass="headerlink"href="#module-com.vmware.vapi.metadata_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata_client.</code><codeclass="descname">SourceCreateSpec</code><spanclass="sig-paren">(</span><em>description=None</em>, <em>type=None</em>, <em>filepath=None</em>, <em>address=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata_client.SourceCreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SourceCreateSpec</span></code> class contains the registration information for a
metadata source.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – English language human readable description of the source.</p></li>
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata_client.SourceType"title="com.vmware.vapi.metadata_client.SourceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SourceType</span></code></a>) – Type of the metadata source.</p></li>
<li><p><strong>filepath</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Absolute file path of the metamodel metadata file that has the
metamodel information about one component element.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vapi.metadata_client.SourceType.FILE"title="com.vmware.vapi.metadata_client.SourceType.FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">SourceType.FILE</span></code></a>.</p></li>
<li><p><strong>address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>Connection information of the remote server. This should be of the
format http(s)://IP:port/namespace.</p>
<p>The remote server should contain the classes in
<aclass="reference internal"href="com.vmware.vapi.metadata.html#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> module. It could
expose metamodel information of one or more components.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vapi.metadata_client.SourceType.REMOTE"title="com.vmware.vapi.metadata_client.SourceType.REMOTE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">SourceType.REMOTE</span></code></a>.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata_client.</code><codeclass="descname">SourceInfo</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>file_name=None</em>, <em>remote_addr=None</em>, <em>msg_protocol=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata_client.SourceInfo"title="Permalink to this definition">¶</a></dt>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vapi.metadata_client.SourceType"title="com.vmware.vapi.metadata_client.SourceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SourceType</span></code></a>) – Type of the metadata source</p></li>
<li><p><strong>file_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the metadata source file
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vapi.metadata_client.SourceType.FILE"title="com.vmware.vapi.metadata_client.SourceType.FILE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">SourceType.FILE</span></code></a>.</p></li>
<li><p><strong>remote_addr</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Address of the remote metadata source
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vapi.metadata_client.SourceType.REMOTE"title="com.vmware.vapi.metadata_client.SourceType.REMOTE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">SourceType.REMOTE</span></code></a>.</p></li>
<li><p><strong>msg_protocol</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Message protocol to be used
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vapi.metadata_client.SourceType.REMOTE"title="com.vmware.vapi.metadata_client.SourceType.REMOTE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">SourceType.REMOTE</span></code></a>.</p></li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata_client.</code><codeclass="descname">SourceType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata_client.SourceType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">SourceType</span></code> class defines the types of sources for API metadata. You
specify the type of source when adding a metadata source to a metadata
service.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <aclass="reference internal"href="#com.vmware.vapi.metadata_client.SourceType"title="com.vmware.vapi.metadata_client.SourceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SourceType</span></code></a> instance.</p>
<codeclass="descname">FILE</code><emclass="property"> = SourceType(string='FILE')</em><aclass="headerlink"href="#com.vmware.vapi.metadata_client.SourceType.FILE"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates the metadata source is a JSON file.</p>
<codeclass="descname">REMOTE</code><emclass="property"> = SourceType(string='REMOTE')</em><aclass="headerlink"href="#com.vmware.vapi.metadata_client.SourceType.REMOTE"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates the metadata source is a remote server.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.metadata_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.metadata_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-vapi-std-client-module"></span><h2>com.vmware.vapi.std_client module<aclass="headerlink"href="#module-com.vmware.vapi.std_client"title="Permalink to this headline">¶</a></h2>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client</span></code> module provides standard types that can be
used in the interface specification of any class.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.std_client.</code><codeclass="descname">AuthenticationScheme</code><aclass="headerlink"href="#com.vmware.vapi.std_client.AuthenticationScheme"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">NO_AUTHENTICATION</code><emclass="property"> = 'com.vmware.vapi.std.security.no_authentication'</em><aclass="headerlink"href="#com.vmware.vapi.std_client.AuthenticationScheme.NO_AUTHENTICATION"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the request doesn’t need any authentication.</p>
<codeclass="descname">OAUTH_ACCESS_TOKEN</code><emclass="property"> = 'com.vmware.vapi.std.security.oauth'</em><aclass="headerlink"href="#com.vmware.vapi.std_client.AuthenticationScheme.OAUTH_ACCESS_TOKEN"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the security context in a request is using OAuth2 based
authentication scheme.</p>
<p>In this scheme, the following pieces of information has to be passed in the
SecurityContext structure in the execution context of the request:</p>
<codeclass="descname">SAML_BEARER_TOKEN</code><emclass="property"> = 'com.vmware.vapi.std.security.saml_bearer_token'</em><aclass="headerlink"href="#com.vmware.vapi.std_client.AuthenticationScheme.SAML_BEARER_TOKEN"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the security context in a request is using a SAML bearer token
based authentication scheme.</p>
<p>In this scheme, the following pieces of information has to be passed in the
SecurityContext structure in the execution context of the request:</p>
<codeclass="descname">SAML_HOK_TOKEN</code><emclass="property"> = 'com.vmware.vapi.std.security.saml_hok_token'</em><aclass="headerlink"href="#com.vmware.vapi.std_client.AuthenticationScheme.SAML_HOK_TOKEN"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the security context in a request is using a SAML holder-of-key
token based authentication scheme.</p>
<p>In this scheme, the following pieces of information has to be passed in the
SecurityContext structure in the execution context of the request:</p>
<li><p>Signature of the request: This includes - algorithm used for signing the
request, SAML holder of key token and signature digest</p></li>
<li><p>Request timestamp: This includes the <codeclass="docutils literal notranslate"><spanclass="pre">created</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">expires</span></code> timestamp of
<codeclass="descname">SESSION_ID</code><emclass="property"> = 'com.vmware.vapi.std.security.session_id'</em><aclass="headerlink"href="#com.vmware.vapi.std_client.AuthenticationScheme.SESSION_ID"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the security context in a request is using a session identifier
based authentication scheme.</p>
<p>In this scheme, the following pieces of information has to be passed in the
SecurityContext structure in the execution context of the request:</p>
<codeclass="descname">USER_PASSWORD</code><emclass="property"> = 'com.vmware.vapi.std.security.user_pass'</em><aclass="headerlink"href="#com.vmware.vapi.std_client.AuthenticationScheme.USER_PASSWORD"title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the security context in a request is using username/password
based authentication scheme.</p>
<p>In this scheme, the following pieces of information has to be passed in the
SecurityContext structure in the execution context of the request:</p>
vAPI runtime provides convenient factory methods that take username and
password as input parameters and create a security context that conforms to the
above format.</p>
</dd></dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vapi.std_client.DynamicID">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.std_client.</code><codeclass="descname">DynamicID</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.std_client.DynamicID"title="Permalink to this definition">¶</a></dt>
<li><p><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>The type of resource being identified (for example
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier for a resource whose type is specified by
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.std_client.</code><codeclass="descname">LocalizableMessage</code><spanclass="sig-paren">(</span><em>id=None</em>, <em>default_message=None</em>, <em>args=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.std_client.LocalizableMessage"title="Permalink to this definition">¶</a></dt>
<li><p><strong>default_message</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The value of this localizable string or message template in the
to access the appropriate message catalog.</p></li>
<li><p><strong>args</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>) – Positional arguments to be substituted into the message template.
This list will be empty if the message uses named arguments or has
<emclass="property">class </em><codeclass="descclassname">com.vmware.vapi.std_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.std_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>.
