Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 01:39:58 -05:00
Code
0c2294f46c
vsphere-automation-sdk-python/vsphere/8.0.2.0/com.vmware.vapi.html
Ankit Agrawal fee6f16acc Updated VC docs for v8.0.2.0. 
Signed-off-by: Ankit Agrawal <aagrawal3@vmware.com>
2023-09-25 09:28:29 +05:30

722 lines
62 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.vapi package &mdash; vSphere Automation SDK for Python. 8.0.2.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="com.vmware.vapi.metadata package" href="com.vmware.vapi.metadata.html" />
<link rel="prev" title="com.vmware.oauth2 package" href="com.vmware.oauth2.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
vSphere Automation SDK for Python.
</a>
<div class="version">
8.0.2.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.oauth2_client">com.vmware.oauth2_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vapi_client">com.vmware.vapi_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vstats_client">com.vmware.vstats_client module</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vSphere Automation SDK for Python.</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="com.html">com package</a></li>
<li class="breadcrumb-item"><a href="com.vmware.html">com.vmware package</a></li>
<li class="breadcrumb-item active">com.vmware.vapi package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vapi.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-com.vmware.vapi">
<span id="com-vmware-vapi-package"></span><h1>com.vmware.vapi package<a class="headerlink" href="#module-com.vmware.vapi" title="Permalink to this headline"></a></h1>
<section id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vapi.metadata.html">com.vmware.vapi.metadata package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html">com.vmware.vapi.metadata.authentication package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.authentication.html#module-com.vmware.vapi.metadata.authentication.service_client">com.vmware.vapi.metadata.authentication.service_client module</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html">com.vmware.vapi.metadata.metamodel package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#module-com.vmware.vapi.metadata.metamodel.resource_client">com.vmware.vapi.metadata.metamodel.resource_client module</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.metamodel.html#module-com.vmware.vapi.metadata.metamodel.service_client">com.vmware.vapi.metadata.metamodel.service_client module</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html">com.vmware.vapi.metadata.privilege package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="com.vmware.vapi.metadata.privilege.html#module-com.vmware.vapi.metadata.privilege.service_client">com.vmware.vapi.metadata.privilege.service_client module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.authentication_client">com.vmware.vapi.metadata.authentication_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.cli_client">com.vmware.vapi.metadata.cli_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.metamodel_client">com.vmware.vapi.metadata.metamodel_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.privilege_client">com.vmware.vapi.metadata.privilege_client module</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="com.vmware.vapi.std.html">com.vmware.vapi.std package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.std.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.std.html#module-com.vmware.vapi.std.errors_client">com.vmware.vapi.std.errors_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.vapi.std.html#module-com.vmware.vapi.std.routing_client">com.vmware.vapi.std.routing_client module</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</section>
<section id="module-com.vmware.vapi.metadata_client">
<span id="com-vmware-vapi-metadata-client-module"></span><h2>com.vmware.vapi.metadata_client module<a class="headerlink" href="#module-com.vmware.vapi.metadata_client" title="Permalink to this headline"></a></h2>
<p>The <a class="reference internal" href="#module-com.vmware.vapi.metadata_client" title="com.vmware.vapi.metadata_client"><code class="xref py py-mod docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata_client</span></code></a> module provides metadata classes.
These are classes that provide different facets of API information. Clients can
use these classes to:</p>
<ul class="simple">
<li><p>Discover APIs available in the infrastructure.</p></li>
<li><p>Fetch metadata that can be used to build presentation layers like CLI, REST,
etc.</p></li>
<li><p>Fetch authentication and authorization metadata.</p></li>
</ul>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vapi.metadata_client.SourceCreateSpec">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vapi.metadata_client.</span></span><span class="sig-name descname"><span class="pre">SourceCreateSpec</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filepath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata_client.SourceCreateSpec" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">SourceCreateSpec</span></code> class contains the registration information for a
metadata source.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – English language human readable description of the source.</p></li>
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType" title="com.vmware.vapi.metadata_client.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">SourceType</span></code></a>) – Type of the metadata source.</p></li>
<li><p><strong>filepath</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType.FILE" title="com.vmware.vapi.metadata_client.SourceType.FILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SourceType.FILE</span></code></a>.</p></li>
<li><p><strong>address</strong> (<code class="xref py py-class docutils literal notranslate"><span class="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
<a class="reference internal" href="com.vmware.vapi.metadata.html#module-com.vmware.vapi.metadata.metamodel_client" title="com.vmware.vapi.metadata.metamodel_client"><code class="xref py py-mod docutils literal notranslate"><span class="pre">com.vmware.vapi.metadata.metamodel_client</span></code></a> module. It could
expose metamodel information of one or more components.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType.REMOTE" title="com.vmware.vapi.metadata_client.SourceType.REMOTE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SourceType.REMOTE</span></code></a>.</p>
</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vapi.metadata_client.SourceInfo">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vapi.metadata_client.</span></span><span class="sig-name descname"><span class="pre">SourceInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remote_addr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">msg_protocol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata_client.SourceInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>Metadata source info</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType" title="com.vmware.vapi.metadata_client.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">SourceType</span></code></a>) – Type of the metadata source</p></li>
<li><p><strong>file_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the metadata source file
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType.FILE" title="com.vmware.vapi.metadata_client.SourceType.FILE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SourceType.FILE</span></code></a>.</p></li>
<li><p><strong>remote_addr</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Address of the remote metadata source
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType.REMOTE" title="com.vmware.vapi.metadata_client.SourceType.REMOTE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SourceType.REMOTE</span></code></a>.</p></li>
<li><p><strong>msg_protocol</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Message protocol to be used
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">type</span></code> is <a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType.REMOTE" title="com.vmware.vapi.metadata_client.SourceType.REMOTE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SourceType.REMOTE</span></code></a>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vapi.metadata_client.SourceType">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vapi.metadata_client.</span></span><span class="sig-name descname"><span class="pre">SourceType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata_client.SourceType" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">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>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <a class="reference internal" href="#com.vmware.vapi.metadata_client.SourceType" title="com.vmware.vapi.metadata_client.SourceType"><code class="xref py py-class docutils literal notranslate"><span class="pre">SourceType</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vapi.metadata_client.SourceType.FILE">
<span class="sig-name descname"><span class="pre">FILE</span></span><em class="property"> <span class="pre">=</span> <span class="pre">SourceType(string='FILE')</span></em><a class="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>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vapi.metadata_client.SourceType.REMOTE">
<span class="sig-name descname"><span class="pre">REMOTE</span></span><em class="property"> <span class="pre">=</span> <span class="pre">SourceType(string='REMOTE')</span></em><a class="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>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vapi.metadata_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vapi.metadata_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.metadata_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-com.vmware.vapi.std_client">
<span id="com-vmware-vapi-std-client-module"></span><h2>com.vmware.vapi.std_client module<a class="headerlink" href="#module-com.vmware.vapi.std_client" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client</span></code> module provides standard types that can be
used in the interface specification of any class.</p>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.AuthenticationScheme">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vapi.std_client.</span></span><span class="sig-name descname"><span class="pre">AuthenticationScheme</span></span><a class="headerlink" href="#com.vmware.vapi.std_client.AuthenticationScheme" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <a class="reference internal" href="#com.vmware.vapi.std_client.AuthenticationScheme" title="com.vmware.vapi.std_client.AuthenticationScheme"><code class="xref py py-class docutils literal notranslate"><span class="pre">AuthenticationScheme</span></code></a> class defines constants for
authentication scheme identifiers for authentication mechanisms present in
the vAPI infrastructure shipped by VMware.</p>
<p>A third party extension can define and implements it’s own authentication
mechanism and define a constant in a different IDL file.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.AuthenticationScheme.NO_AUTHENTICATION">
<span class="sig-name descname"><span class="pre">NO_AUTHENTICATION</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vapi.std.security.no_authentication'</span></em><a class="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>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.AuthenticationScheme.OAUTH_ACCESS_TOKEN">
<span class="sig-name descname"><span class="pre">OAUTH_ACCESS_TOKEN</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vapi.std.security.oauth'</span></em><a class="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>
<ul class="simple">
<li><p>The scheme identifier - com.vmware.vapi.std.security.oauth</p></li>
<li><p>Valid OAuth2 access token - This is usually acquired by OAuth2 Authorization
Server after successful authentication of the end user.</p></li>
</ul>
<p>Sample security context in JSON format that matches the specification: <code class="docutils literal notranslate"><span class="pre">{</span>
<span class="pre">'schemeId':</span> <span class="pre">'com.vmware.vapi.std.security.oauth',</span>
<span class="pre">'accesstoken':</span> <span class="pre">....</span>
<span class="pre">}</span></code>
vAPI runtime provides convenient factory methods that takes OAuth2 access token
as input parameter and creates a security context that conforms to the above
format.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.AuthenticationScheme.SAML_BEARER_TOKEN">
<span class="sig-name descname"><span class="pre">SAML_BEARER_TOKEN</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vapi.std.security.saml_bearer_token'</span></em><a class="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>
<ul class="simple">
<li><p>The scheme identifier: com.vmware.vapi.std.security.saml_bearer_token</p></li>
<li><p>The token itself</p></li>
</ul>
<p>Sample security context in JSON format that matches the specification: <code class="docutils literal notranslate"><span class="pre">{</span>
<span class="pre">'schemeId':</span> <span class="pre">'com.vmware.vapi.std.security.saml_bearer_token',</span>
<span class="pre">'token':</span> <span class="pre">'the</span> <span class="pre">token</span> <span class="pre">itself'</span>
<span class="pre">}</span></code> vAPI runtime provide convenient factory methods that take SAML bearer token
and to create the security context that conforms to the above mentioned format.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.AuthenticationScheme.SAML_HOK_TOKEN">
<span class="sig-name descname"><span class="pre">SAML_HOK_TOKEN</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vapi.std.security.saml_hok_token'</span></em><a class="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>
<ul class="simple">
<li><p>The scheme identifier: com.vmware.vapi.std.security.saml_hok_token</p></li>
<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 <code class="docutils literal notranslate"><span class="pre">created</span></code> and <code class="docutils literal notranslate"><span class="pre">expires</span></code> timestamp of
the request. The timestamp should match the following format -
YYYY-MM-DDThh:mm:ss.sssZ (e.g. 1878-03-03T19:20:30.451Z).</p></li>
</ul>
<p>Sample security context in JSON format that matches the specification: <code class="docutils literal notranslate"><span class="pre">{</span>
<span class="pre">'schemeId':</span> <span class="pre">'com.vmware.vapi.std.security.saml_hok_token',</span>
<span class="pre">'signature':</span> <span class="pre">{</span>
<span class="pre">'alg':</span> <span class="pre">'RS256',</span>
<span class="pre">'samlToken':</span> <span class="pre">...,</span>
<span class="pre">'value':</span> <span class="pre">...,</span></code>, ‘timestamp’: { ‘created’: ‘2012-10-26T12:24:18.941Z’,
‘expires’: ‘2012-10-26T12:44:18.941Z’, } } } vAPI runtime provide convenient
factory methods that take SAML holder of key token and private key to create
the security context that conforms to the above mentioned format.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.AuthenticationScheme.SESSION_ID">
<span class="sig-name descname"><span class="pre">SESSION_ID</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vapi.std.security.session_id'</span></em><a class="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>
<ul class="simple">
<li><p>The scheme identifier - com.vmware.vapi.std.security.session_id</p></li>
<li><p>Valid session identifier - This is usually returned by a login method of a
session manager interface for a particular vAPI service of this authentication
scheme</p></li>
</ul>
<p>Sample security context in JSON format that matches the specification: <code class="docutils literal notranslate"><span class="pre">{</span>
<span class="pre">'schemeId':</span> <span class="pre">'com.vmware.vapi.std.security.session_id',</span>
<span class="pre">'sessionId':</span> <span class="pre">....,</span>
<span class="pre">}</span></code> vAPI runtime provides convenient factory methods that take session
identifier as input parameter and create a security context that conforms to
the above format.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.AuthenticationScheme.USER_PASSWORD">
<span class="sig-name descname"><span class="pre">USER_PASSWORD</span></span><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.vapi.std.security.user_pass'</span></em><a class="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>
<ul class="simple">
<li><p>The scheme identifier - com.vmware.vapi.std.security.user_pass</p></li>
<li><p>Username</p></li>
<li><p>Password</p></li>
</ul>
<p>Sample security context in JSON format that matches the specification: <code class="docutils literal notranslate"><span class="pre">{</span>
<span class="pre">'schemeId':</span> <span class="pre">'com.vmware.vapi.std.security.user_pass',</span>
<span class="pre">'userName':</span> <span class="pre">....,</span>
<span class="pre">'password':</span> <span class="pre">...</span>
<span class="pre">}</span></code>
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>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.DynamicID">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vapi.std_client.</span></span><span class="sig-name descname"><span class="pre">DynamicID</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std_client.DynamicID" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DynamicID</span></code> class represents an identifier for a resource of an
arbitrary type.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>The type of resource being identified (for example
<code class="docutils literal notranslate"><span class="pre">com.acme.Person</span></code>).</p>
<p>Classes that contain methods for creating and deleting resources
typically contain a class attribute specifying the resource type
for the resources being created and deleted. The API metamodel
metadata classes include a class that allows retrieving all the
known resource types.</p>
</p></li>
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier for a resource whose type is specified by
<code class="xref py py-attr docutils literal notranslate"><span class="pre">DynamicID.type</span></code>.
When clients pass a value of this class as a parameter, the
attribute <code class="docutils literal notranslate"><span class="pre">type</span></code> must contain the actual resource type. When
methods return a value of this class as a return value, the
attribute <code class="docutils literal notranslate"><span class="pre">type</span></code> will contain the actual resource type.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.LocalizableMessage">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vapi.std_client.</span></span><span class="sig-name descname"><span class="pre">LocalizableMessage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default_message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">localized</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizableMessage" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LocalizableMessage</span></code> class represents localizable string and message
template. Classes include one or more localizable message templates in the
exceptions they report so that clients can display diagnostic messages in
the native language of the user. Classes can include localizable strings in
the data returned from methods to allow clients to display localized status
information in the native language of the user.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Unique identifier of the localizable string or message template.</p>
<p>This identifier is typically used to retrieve a locale-specific
string or message template from a message catalog.</p>
</p></li>
<li><p><strong>default_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The value of this localizable string or message template in the
<code class="docutils literal notranslate"><span class="pre">en_US</span></code> (English) locale. If <code class="xref py py-attr docutils literal notranslate"><span class="pre">LocalizableMessage.id</span></code> refers
to a message template, the default message will contain the
substituted arguments. This value can be used by clients that do
not need to display strings and messages in the native language of
the user. It could also be used as a fallback if a client is unable
to access the appropriate message catalog.</p></li>
<li><p><strong>args</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Positional arguments to be substituted into the message template.
This list will be empty if the message uses named arguments or has
no arguments.</p></li>
<li><p><strong>params</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.std_client.LocalizationParam" title="com.vmware.vapi.std_client.LocalizationParam"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalizationParam</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Named arguments to be substituted into the message template. This
attribute was added in vSphere API 7.0.0.0.
None means that the message template requires no arguments or
positional arguments are used.</p></li>
<li><p><strong>localized</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Localized string value as per request requirements. This attribute
was added in vSphere API 7.0.0.0.
when the client has not requested specific locale the
implementation may not populate this field to conserve resources.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.LocalizationParam">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vapi.std_client.</span></span><span class="sig-name descname"><span class="pre">LocalizationParam</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">s</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">i</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">d</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">l</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">format</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">precision</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>This class holds a single message parameter and formatting settings for it.
The class has fields for <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>,
<code class="xref py py-class docutils literal notranslate"><span class="pre">decimal.Decimal</span></code>, date time and nested messages. Only one will be
used depending on the type of data sent. For date, <code class="xref py py-class docutils literal notranslate"><span class="pre">decimal.Decimal</span></code>
and <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code> it is possible to set additional formatting details. This
class was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>s</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> value associated with the parameter. This attribute
was added in vSphere API 7.0.0.0.
this attribute will be set when <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> value is used.</p></li>
<li><p><strong>dt</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Date and time value associated with the parameter. Use the
<code class="docutils literal notranslate"><span class="pre">format</span></code> attribute to specify date and time display style. This
attribute was added in vSphere API 7.0.0.0.
this attribute will be set when date and time value is used.</p></li>
<li><p><strong>i</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code> value associated with the parameter. This attribute
was added in vSphere API 7.0.0.0.
this attribute will be set when <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code> value is used.</p></li>
<li><p><strong>d</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The <code class="xref py py-class docutils literal notranslate"><span class="pre">decimal.Decimal</span></code> value associated with the parameter.
The number of displayed fractional digits is changed via
<code class="docutils literal notranslate"><span class="pre">precision</span></code> attribute. This attribute was added in vSphere API
7.0.0.0.
this attribute will be set when <code class="xref py py-class docutils literal notranslate"><span class="pre">decimal.Decimal</span></code> value is
used.</p></li>
<li><p><strong>l</strong> (<a class="reference internal" href="#com.vmware.vapi.std_client.NestedLocalizableMessage" title="com.vmware.vapi.std_client.NestedLocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">NestedLocalizableMessage</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Nested localizable value associated with the parameter. This is
useful construct to convert to human readable localized form class
and <code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> values. It can also be used for proper handling
of pluralization and gender forms in localization. Recursive
<code class="docutils literal notranslate"><span class="pre">NestedLocalizableMessage</span></code> instances can be used for localizing
short lists of items. This attribute was added in vSphere API
7.0.0.0.
this attribute will be set when nested localization message value
is used.</p></li>
<li><p><strong>format</strong> (<a class="reference internal" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat" title="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalizationParam.DateTimeFormat</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Format associated with the date and time value in <code class="docutils literal notranslate"><span class="pre">dt</span></code> attribute.
The class attribute <code class="docutils literal notranslate"><span class="pre">SHORT_DATETIME</span></code> will be used as default.
This attribute was added in vSphere API 7.0.0.0.
this may not be set if class attribute <code class="docutils literal notranslate"><span class="pre">SHORT_DATETIME</span></code> default
format is appropriate</p></li>
<li><p><strong>precision</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Number of fractional digits to include in formatted
<code class="xref py py-class docutils literal notranslate"><span class="pre">decimal.Decimal</span></code> value. This attribute was added in vSphere
API 7.0.0.0.
this will be set when exact precision is required for rendering
<code class="xref py py-class docutils literal notranslate"><span class="pre">decimal.Decimal</span></code> numbers.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">DateTimeFormat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">LocalizationParam.DateTimeFormat</span></code> class lists possible date and time
formatting options. It combines the Unicode CLDR format types - full, long,
medium and short with 3 different presentations - date only, time only and
combined date and time presentation. This enumeration was added in vSphere
API 7.0.0.0.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
type description page</span></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>string</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – String value for the <code class="xref py py-class docutils literal notranslate"><span class="pre">DateTimeFormat</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.FULL_DATE">
<span class="sig-name descname"><span class="pre">FULL_DATE</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='FULL_DATE')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.FULL_DATE" title="Permalink to this definition"></a></dt>
<dd><p>The date and time value will be formatted as full date, for example <em>2019
Jan 28, Mon</em>. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.FULL_DATE_TIME">
<span class="sig-name descname"><span class="pre">FULL_DATE_TIME</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='FULL_DATE_TIME')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.FULL_DATE_TIME" title="Permalink to this definition"></a></dt>
<dd><p>The date and time value will be formatted as full date and time, for
example <em>2019 Jan 28, Mon 12:59:01 Z</em>. This class attribute was added in
vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.FULL_TIME">
<span class="sig-name descname"><span class="pre">FULL_TIME</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='FULL_TIME')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.FULL_TIME" title="Permalink to this definition"></a></dt>
<dd><p>The date and time value will be formatted as full time, for example
<em>12:59:01 Z</em>. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.LONG_DATE">
<span class="sig-name descname"><span class="pre">LONG_DATE</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='LONG_DATE')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.LONG_DATE" title="Permalink to this definition"></a></dt>
<dd><p>The date and time value will be formatted as long date, for example <em>2019
Jan 28</em>. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.LONG_DATE_TIME">
<span class="sig-name descname"><span class="pre">LONG_DATE_TIME</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='LONG_DATE_TIME')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.LONG_DATE_TIME" title="Permalink to this definition"></a></dt>
<dd><p>The date and time value will be formatted as long date and time, for
example <em>2019 Jan 28 12:59:01 Z</em>. This class attribute was added in vSphere
API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.LONG_TIME">
<span class="sig-name descname"><span class="pre">LONG_TIME</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='LONG_TIME')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.LONG_TIME" title="Permalink to this definition"></a></dt>
<dd><p>The date and time value will be formatted as long time, for example
<em>12:59:01 Z</em>. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.MED_DATE">
<span class="sig-name descname"><span class="pre">MED_DATE</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='MED_DATE')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.MED_DATE" title="Permalink to this definition"></a></dt>
<dd><p>The date and time value will be formatted as medium date, for example <em>2019
Jan 28</em>. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.MED_DATE_TIME">
<span class="sig-name descname"><span class="pre">MED_DATE_TIME</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='MED_DATE_TIME')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.MED_DATE_TIME" title="Permalink to this definition"></a></dt>
<dd><p>The date and time value will be formatted as medium date and time, for
example <em>2019 Jan 28 12:59:01</em>. This class attribute was added in vSphere
API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.MED_TIME">
<span class="sig-name descname"><span class="pre">MED_TIME</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='MED_TIME')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.MED_TIME" title="Permalink to this definition"></a></dt>
<dd><p>The date and time value will be formatted as medium time, for example
<em>12:59:01</em>. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.SHORT_DATE">
<span class="sig-name descname"><span class="pre">SHORT_DATE</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='SHORT_DATE')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.SHORT_DATE" title="Permalink to this definition"></a></dt>
<dd><p>The date and time value will be formatted as short date, for example
<em>2019-01-28</em>. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.SHORT_DATE_TIME">
<span class="sig-name descname"><span class="pre">SHORT_DATE_TIME</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='SHORT_DATE_TIME')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.SHORT_DATE_TIME" title="Permalink to this definition"></a></dt>
<dd><p>The date and time value will be formatted as short date and time, for
example <em>2019-01-28 12:59</em>. This class attribute was added in vSphere API
7.0.0.0.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.SHORT_TIME">
<span class="sig-name descname"><span class="pre">SHORT_TIME</span></span><em class="property"> <span class="pre">=</span> <span class="pre">DateTimeFormat(string='SHORT_TIME')</span></em><a class="headerlink" href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat.SHORT_TIME" title="Permalink to this definition"></a></dt>
<dd><p>The date and time value will be formatted as short time, for example
<em>12:59</em>. This class attribute was added in vSphere API 7.0.0.0.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.NestedLocalizableMessage">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vapi.std_client.</span></span><span class="sig-name descname"><span class="pre">NestedLocalizableMessage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std_client.NestedLocalizableMessage" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">NestedLocalizableMessage</span></code> class represents a nested within a
parameter localizable string or message template. This class is useful for
modeling composite messages. Such messages are necessary to do correct
pluralization of phrases, represent lists of several items etc. This class
was added in vSphere API 7.0.0.0.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Unique identifier of the localizable string or message template.</p>
<p>This identifier is typically used to retrieve a locale-specific
string or message template from a message catalog.. This attribute
was added in vSphere API 7.0.0.0.</p>
</p></li>
<li><p><strong>params</strong> ((<code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> and <a class="reference internal" href="#com.vmware.vapi.std_client.LocalizationParam" title="com.vmware.vapi.std_client.LocalizationParam"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalizationParam</span></code></a>) or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Named Arguments to be substituted into the message template. This
attribute was added in vSphere API 7.0.0.0.
services will not populate this field when there are no parameters
to be substituted</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="com.vmware.vapi.std_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">com.vmware.vapi.std_client.</span></span><span class="sig-name descname"><span class="pre">StubFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stub_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vapi.std_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</p>
</dd>
</dl>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="com.vmware.oauth2.html" class="btn btn-neutral float-left" title="com.vmware.oauth2 package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="com.vmware.vapi.metadata.html" class="btn btn-neutral float-right" title="com.vmware.vapi.metadata package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023, VMware, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
View Git Blame Copy Permalink