<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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vapi.metadata_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SourceCreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">filepath</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">address</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vapi.metadata_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SourceInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">file_name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">remote_addr</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">msg_protocol</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vapi.metadata_client.</span></code><codeclass="sig-name descname"><spanclass="pre">SourceType</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></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="sig-name descname"><spanclass="pre">FILE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SourceType(string='FILE')</span></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="sig-name descname"><spanclass="pre">REMOTE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">SourceType(string='REMOTE')</span></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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vapi.metadata_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vapi.std_client.</span></code><codeclass="sig-name descname"><spanclass="pre">AuthenticationScheme</span></code><aclass="headerlink"href="#com.vmware.vapi.std_client.AuthenticationScheme"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">NO_AUTHENTICATION</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vapi.std.security.no_authentication'</span></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="sig-name descname"><spanclass="pre">OAUTH_ACCESS_TOKEN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vapi.std.security.oauth'</span></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="sig-name descname"><spanclass="pre">SAML_BEARER_TOKEN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vapi.std.security.saml_bearer_token'</span></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="sig-name descname"><spanclass="pre">SAML_HOK_TOKEN</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vapi.std.security.saml_hok_token'</span></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
the request. The timestamp should match the following format -
<codeclass="sig-name descname"><spanclass="pre">SESSION_ID</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vapi.std.security.session_id'</span></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="sig-name descname"><spanclass="pre">USER_PASSWORD</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'com.vmware.vapi.std.security.user_pass'</span></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="py class">
<dtid="com.vmware.vapi.std_client.DynamicID">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vapi.std_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DynamicID</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.std_client.DynamicID"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DynamicID</span></code> class represents an identifier for a resource of an
arbitrary type.</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>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>The type of resource being identified (for example
<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> (<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"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vapi.std_client.</span></code><codeclass="sig-name descname"><spanclass="pre">LocalizableMessage</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">default_message</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">args</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">params</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">localized</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.std_client.LocalizableMessage"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<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>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<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 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> (<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
no arguments.</p></li>
<li><p><strong>params</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.std_client.LocalizationParam"title="com.vmware.vapi.std_client.LocalizationParam"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LocalizationParam</span></code></a>) or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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>
<p>This class holds a single message parameter and formatting settings for it.
The class has fields for <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>, <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">int</span></code>,
<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">decimal.Decimal</span></code>, date time and nested messages. Only one will be
used depending on the type of data sent. For date, <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">decimal.Decimal</span></code>
and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">int</span></code> it is possible to set additional formatting details. This
class was added in vSphere API 7.0.0.0.</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>s</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> value is used.</p></li>
<li><p><strong>dt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Date and time value associated with the parameter. Use the
<codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">int</span></code> value is used.</p></li>
<li><p><strong>d</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">float</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">decimal.Decimal</span></code> value associated with the parameter.
The number of displayed fractional digits is changed via
<codeclass="docutils literal notranslate"><spanclass="pre">precision</span></code> attribute. This attribute was added in vSphere API
7.0.0.0.
this attribute will be set when <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">decimal.Decimal</span></code> value is
used.</p></li>
<li><p><strong>l</strong> (<aclass="reference internal"href="#com.vmware.vapi.std_client.NestedLocalizableMessage"title="com.vmware.vapi.std_client.NestedLocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">NestedLocalizableMessage</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Nested localizable value associated with the parameter. This is
useful construct to convert to human readable localized form class
and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> values. It can also be used for proper handling
of pluralization and gender forms in localization. Recursive
<codeclass="docutils literal notranslate"><spanclass="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> (<aclass="reference internal"href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat"title="com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LocalizationParam.DateTimeFormat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Format associated with the date and time value in <codeclass="docutils literal notranslate"><spanclass="pre">dt</span></code> attribute.
The class attribute <codeclass="docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">SHORT_DATETIME</span></code> default
format is appropriate</p></li>
<li><p><strong>precision</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of fractional digits to include in formatted
<codeclass="xref py py-class docutils literal notranslate"><spanclass="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
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">DateTimeFormat</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.std_client.LocalizationParam.DateTimeFormat"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<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 <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DateTimeFormat</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">FULL_DATE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DateTimeFormat(string='FULL_DATE')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">FULL_DATE_TIME</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DateTimeFormat(string='FULL_DATE_TIME')</span></em><aclass="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
<codeclass="sig-name descname"><spanclass="pre">FULL_TIME</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DateTimeFormat(string='FULL_TIME')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">LONG_DATE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DateTimeFormat(string='LONG_DATE')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">LONG_DATE_TIME</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DateTimeFormat(string='LONG_DATE_TIME')</span></em><aclass="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
<codeclass="sig-name descname"><spanclass="pre">LONG_TIME</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DateTimeFormat(string='LONG_TIME')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">MED_DATE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DateTimeFormat(string='MED_DATE')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">MED_DATE_TIME</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DateTimeFormat(string='MED_DATE_TIME')</span></em><aclass="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
<codeclass="sig-name descname"><spanclass="pre">MED_TIME</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DateTimeFormat(string='MED_TIME')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">SHORT_DATE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DateTimeFormat(string='SHORT_DATE')</span></em><aclass="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>
<codeclass="sig-name descname"><spanclass="pre">SHORT_DATE_TIME</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DateTimeFormat(string='SHORT_DATE_TIME')</span></em><aclass="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
<codeclass="sig-name descname"><spanclass="pre">SHORT_TIME</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DateTimeFormat(string='SHORT_TIME')</span></em><aclass="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>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vapi.std_client.</span></code><codeclass="sig-name descname"><spanclass="pre">NestedLocalizableMessage</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">id</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">params</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.std_client.NestedLocalizableMessage"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<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>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> ((<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.std_client.LocalizationParam"title="com.vmware.vapi.std_client.LocalizationParam"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LocalizationParam</span></code></a>) or <codeclass="docutils literal notranslate"><spanclass="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>
<dlclass="py class">
<dtid="com.vmware.vapi.std_client.StubFactory">
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vapi.std_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vapi.std_client.StubFactory"title="Permalink to this definition">¶</a></dt>
