Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 17:39:59 -05:00
Code
621aa7b28d
vsphere-automation-sdk-python/vsphere/7.0.3.2/com.vmware.content.library.html
Vandit Mehta b18fe14f5a
Update docs for vSphere 7.0.3.2 
Signed-off-by: Vandit Mehta <vmehta@vmware.com>
2022-04-12 12:11:18 +05:30

1913 lines
169 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="viewport" content="width=device-width, initial-scale=1.0" />
<title>com.vmware.content.library package &mdash; vSphere Automation SDK for Python. 7.0.3.2 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" 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 type="text/javascript" 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.content.library.item package" href="com.vmware.content.library.item.html" />
<link rel="prev" title="com.vmware.content package" href="com.vmware.content.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">
7.0.3.2
</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" />
<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="main navigation">
<p class="caption"><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>
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<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="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.content.html">com.vmware.content package</a> &raquo;</li>
<li>com.vmware.content.library package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.content.library.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">
<div class="section" id="module-com.vmware.content.library">
<span id="com-vmware-content-library-package"></span><h1>com.vmware.content.library package<a class="headerlink" href="#module-com.vmware.content.library" title="Permalink to this headline"></a></h1>
<div class="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.content.library.item.html">com.vmware.content.library.item package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.library.item.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.library.item.html#module-com.vmware.content.library.item.downloadsession_client">com.vmware.content.library.item.downloadsession_client module</a></li>
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.library.item.html#module-com.vmware.content.library.item.updatesession_client">com.vmware.content.library.item.updatesession_client module</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-com.vmware.content.library.item_client">
<span id="com-vmware-content-library-item-client-module"></span><h2>com.vmware.content.library.item_client module<a class="headerlink" href="#module-com.vmware.content.library.item_client" title="Permalink to this headline"></a></h2>
<p>The Content Library Item module provides classes and classes for managing files
in a library item.</p>
<dl class="py class">
<dt id="com.vmware.content.library.item_client.CertVerificationStatus">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item_client.</span></code><code class="sig-name descname"><span class="pre">CertVerificationStatus</span></code><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.content.library.item_client.CertVerificationStatus" 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">CertVerificationStatus</span></code> class defines the certificate verification
status of a library item. Currently applicable only to ovf item type. This
enumeration was added in vSphere API 7.0.3.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 <a class="reference internal" href="#com.vmware.content.library.item_client.CertVerificationStatus" title="com.vmware.content.library.item_client.CertVerificationStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertVerificationStatus</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.CertVerificationStatus.INTERNAL">
<code class="sig-name descname"><span class="pre">INTERNAL</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CertVerificationStatus(string='INTERNAL')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.CertVerificationStatus.INTERNAL" title="Permalink to this definition"></a></dt>
<dd><p>The Item is cloned/created through vCenter. This class attribute was added
in vSphere API 7.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.CertVerificationStatus.NOT_AVAILABLE">
<code class="sig-name descname"><span class="pre">NOT_AVAILABLE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CertVerificationStatus(string='NOT_AVAILABLE')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.CertVerificationStatus.NOT_AVAILABLE" title="Permalink to this definition"></a></dt>
<dd><p>Existing library item which can not be verified. Applying security policy
to an existing library may result in this status for items. This class
attribute was added in vSphere API 7.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.CertVerificationStatus.UNTRUSTED">
<code class="sig-name descname"><span class="pre">UNTRUSTED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CertVerificationStatus(string='UNTRUSTED')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.CertVerificationStatus.UNTRUSTED" title="Permalink to this definition"></a></dt>
<dd><p>Certificate used to sign the item is not trusted. This class attribute was
added in vSphere API 7.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.CertVerificationStatus.VERIFICATION_FAILURE">
<code class="sig-name descname"><span class="pre">VERIFICATION_FAILURE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CertVerificationStatus(string='VERIFICATION_FAILURE')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.CertVerificationStatus.VERIFICATION_FAILURE" title="Permalink to this definition"></a></dt>
<dd><p>Item’s certificate or manifest validation failed. This class attribute was
added in vSphere API 7.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.CertVerificationStatus.VERIFICATION_IN_PROGRESS">
<code class="sig-name descname"><span class="pre">VERIFICATION_IN_PROGRESS</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CertVerificationStatus(string='VERIFICATION_IN_PROGRESS')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.CertVerificationStatus.VERIFICATION_IN_PROGRESS" title="Permalink to this definition"></a></dt>
<dd><p>Item certificate verification is in progress. This class attribute was
added in vSphere API 7.0.3.0.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.CertVerificationStatus.VERIFIED">
<code class="sig-name descname"><span class="pre">VERIFIED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">CertVerificationStatus(string='VERIFIED')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.CertVerificationStatus.VERIFIED" title="Permalink to this definition"></a></dt>
<dd><p>Item has been fully validated during importing or file syncing. This class
attribute was added in vSphere API 7.0.3.0.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.content.library.item_client.CertificateVerificationInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item_client.</span></code><code class="sig-name descname"><span class="pre">CertificateVerificationInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">status</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">cert_chain</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.content.library.item_client.CertificateVerificationInfo" 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>Currently, this field will available only in following cases 1. This item
belongs to a secure content library 2. The item if of type ovf. This class
was added in vSphere API 7.0.3.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>status</strong> (<a class="reference internal" href="#com.vmware.content.library.item_client.CertVerificationStatus" title="com.vmware.content.library.item_client.CertVerificationStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">CertVerificationStatus</span></code></a>) – The certificate verification status of item. This attribute was
added in vSphere API 7.0.3.0.</p></li>
<li><p><strong>cert_chain</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> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A certificate in base64 encoding. This attribute was added in
vSphere API 7.0.3.0.
Certificate chain is unset if the item not signed</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.content.library.item_client.Changes">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item_client.</span></code><code class="sig-name descname"><span class="pre">Changes</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Changes" 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.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Changes</span></code> class provides methods to get a history of the content
changes made to a library item. This class was added in vSphere API 6.9.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.content.library.item_client.Changes.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</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">user</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">message</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.content.library.item_client.Changes.Info" 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">Changes.Info</span></code> class contains information about a library item
change. This class was added in vSphere API 6.9.1.</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>time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – The date and time when the item content was changed. This attribute
was added in vSphere API 6.9.1.</p></li>
<li><p><strong>user</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>) – The user who made the content change. This attribute was added in
vSphere API 6.9.1.
This attribute will be None if the user could not be determined.</p></li>
<li><p><strong>message</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>) – The full message describing the content change. This attribute was
added in vSphere API 6.9.1.
This attribute will be None if a message was not provided when the
item content was changed.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.Changes.RESOURCE_TYPE">
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.content.library.item.Version'</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.Changes.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for library item versions. This class attribute was added in
vSphere API 6.9.1.</p>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.content.library.item_client.Changes.Summary">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Summary</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">version</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">time</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">user</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">short_message</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.content.library.item_client.Changes.Summary" 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">Changes.Summary</span></code> class contains commonly used information about a
library item change. This class was added in vSphere API 6.9.1.</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>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The version of the library item. This attribute was added in
vSphere API 6.9.1.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.Version</span></code>. When methods return a
value of this class as a return value, the attribute will be an
identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.Version</span></code>.</p></li>
<li><p><strong>time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – The date and time when the item content was changed. This attribute
was added in vSphere API 6.9.1.</p></li>
<li><p><strong>user</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>) – The user who made the content change. This attribute was added in
vSphere API 6.9.1.
This attribute will be None if the user could not be determined.</p></li>
<li><p><strong>short_message</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>) – The short message describing the content change. The message is
truncated to the first 80 characters or first non-leading newline
character, whichever length is shorter. This attribute was added in
vSphere API 6.9.1.
This attribute will be None if a message was not provided when the
item content was changed.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.Changes.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">library_item</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Changes.get" title="Permalink to this definition"></a></dt>
<dd><p>Returns information about a library item change. This method was added
in vSphere API 6.9.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Library item identifer.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Library item version.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.Version</span></code>.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content.library.item_client.Changes.Info" title="com.vmware.content.library.item_client.Changes.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Changes.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Information about the specified library item change.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the library item or version is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user that requested the method cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user that requested the method is not authorized to perform
the method.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the parameter <code class="docutils literal notranslate"><span class="pre">library_item</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.Changes.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">library_item</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Changes.list" title="Permalink to this definition"></a></dt>
<dd><p>Returns commonly used information about the content changes made to a
library item. This method was added in vSphere API 6.9.1.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>library_item</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Library item identifier.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content.library.item_client.Changes.list" title="com.vmware.content.library.item_client.Changes.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.content.library.item_client.Changes.Summary" title="com.vmware.content.library.item_client.Changes.Summary"><code class="xref py py-class docutils literal notranslate"><span class="pre">Changes.Summary</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>List of commonly used information about the library item changes.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the library item is not found.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthenticated" title="com.vmware.vapi.std.errors_client.Unauthenticated"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code></a>
if the user that requested the method cannot be authenticated.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if the user that requested the method is not authorized to perform
the method.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Error" title="com.vmware.vapi.std.errors_client.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Error</span></code></a>
if the system reports an error while responding to the request.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the parameter <code class="docutils literal notranslate"><span class="pre">library_item</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.content.library.item_client.DownloadSession">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item_client.</span></code><code class="sig-name descname"><span class="pre">DownloadSession</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession" 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.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">DownloadSession</span></code> class manipulates download sessions, which are used
to download content from the Content Library Service.</p>
<p>A download session is an object that tracks the download of content (that
is, downloading content from the Content Library Service) and acts as a
lease to keep the download links available.</p>
<p>The <a class="reference internal" href="com.vmware.content.library.item.html#com.vmware.content.library.item.downloadsession_client.File" title="com.vmware.content.library.item.downloadsession_client.File"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library.item.downloadsession_client.File</span></code></a>
class provides access to the download links.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.DownloadSession.RESOURCE_TYPE">
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.content.library.item.DownloadSession'</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for a download session.</p>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.DownloadSession.cancel">
<code class="sig-name descname"><span class="pre">cancel</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">download_session_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.cancel" title="Permalink to this definition"></a></dt>
<dd><p>Cancels the download session. This method will abort any ongoing
transfers and invalidate transfer urls that the client may be
downloading from.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>download_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifer of the download session that should be canceled.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if no download session with the given identifier exists.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the download session is not in the
<a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DownloadSessionModel.State.ACTIVE</span></code></a> state.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.DownloadSession.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">create_spec</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_token</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.content.library.item_client.DownloadSession.create" title="Permalink to this definition"></a></dt>
<dd><p>Creates a new download session.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>client_token</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>) – A unique token generated by the client for each creation request.
The token should be a universally unique identifier (UUID), for
example: <code class="docutils literal notranslate"><span class="pre">b8a2a2e3-2314-43cd-a871-6ede0f429751</span></code>. This token can
be used to guarantee idempotent creation.
If not specified creation is not idempotent.</p></li>
<li><p><strong>create_spec</strong> (<a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSessionModel" title="com.vmware.content.library.item_client.DownloadSessionModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">DownloadSessionModel</span></code></a>) – Specification for the new download session to be created.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Identifier of the new download session being created.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the session specification is not valid.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
format.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the library item targeted by the download does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">DownloadSessionModel.library_item_id</span></code> requires
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.DownloadSession</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.DownloadSession.delete">
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">download_session_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.delete" title="Permalink to this definition"></a></dt>
<dd><p>Deletes a download session. This removes the session and all
information associated with it.</p>
<p>Removing a download session leaves any current transfers for that
session in an indeterminate state (there is no guarantee that the
transfers will be able to complete). However there will no longer be a
means of inspecting the status of those downloads except by seeing the
effect on the library item.</p>
<p>Download sessions for which there is no download activity or which are
complete will automatically be expired and then deleted after a period
of time.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>download_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the download session to be deleted.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the download session does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.DownloadSession.fail">
<code class="sig-name descname"><span class="pre">fail</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">download_session_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_error_message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.fail" title="Permalink to this definition"></a></dt>
<dd><p>Terminates the download session with a client specified error message.</p>
<p>This is useful in transmitting client side failures (for example, not
being able to download a file) to the server side.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>download_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the download session to fail.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>.</p></li>
<li><p><strong>client_error_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Client side error message. This can be useful in providing some
extra details about the client side failure. Note that the message
won’t be translated to the user’s locale.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the download session does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the download session is not in the
<a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DownloadSessionModel.State.ACTIVE</span></code></a> state.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.DownloadSession.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">download_session_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.get" title="Permalink to this definition"></a></dt>
<dd><p>Gets the download session with the specified identifier, including the
most up-to-date status information for the session.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>download_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the download session to retrieve.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSessionModel" title="com.vmware.content.library.item_client.DownloadSessionModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">DownloadSessionModel</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSessionModel" title="com.vmware.content.library.item_client.DownloadSessionModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">DownloadSessionModel</span></code></a> instance with the given
<code class="docutils literal notranslate"><span class="pre">download_session_id</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if no download session with the given <code class="docutils literal notranslate"><span class="pre">download_session_id</span></code>
exists.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.DownloadSession.keep_alive">
<code class="sig-name descname"><span class="pre">keep_alive</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">download_session_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">progress</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.content.library.item_client.DownloadSession.keep_alive" title="Permalink to this definition"></a></dt>
<dd><p>Keeps a download session alive. This operation is allowed only if the
session is in the <a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DownloadSessionModel.State.ACTIVE</span></code></a> state.</p>
<p>If there is no activity for a download session for a certain period of
time, the download session will expire. The download session expiration
timeout is configurable in the Content Library Service system
configuration. The default is five minutes. Invoking this method
enables a client to specifically extend the lifetime of an active
download session.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>download_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the download session whose lifetime should be
extended.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>.</p></li>
<li><p><strong>progress</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>) – Optional update to the progress property of the session. If
specified, the new progress should be greater then the current
progress. See <code class="xref py py-attr docutils literal notranslate"><span class="pre">DownloadSessionModel.client_progress</span></code>.
If not specified the progress is not updated.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if no download session with the given identifier exists.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the download session is not in the
<a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DownloadSessionModel.State.ACTIVE</span></code></a> state.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.DownloadSession.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">library_item_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.content.library.item_client.DownloadSession.list" title="Permalink to this definition"></a></dt>
<dd><p>Lists the identifiers of the download sessions created by the calling
user. Optionally may filter by library item.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>library_item_id</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>) – Library item identifier on which to filter results.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>.
If not specified all download session identifiers are listed.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSession.list" title="com.vmware.content.library.item_client.DownloadSession.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSession.list" title="com.vmware.content.library.item_client.DownloadSession.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of identifiers of all download sessions created
by the calling user.
The return value will contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if a library item identifier is given for an item which does not
exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>
referenced by the parameter <code class="docutils literal notranslate"><span class="pre">library_item_id</span></code> requires
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.DownloadSession</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.content.library.item_client.DownloadSessionModel">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item_client.</span></code><code class="sig-name descname"><span class="pre">DownloadSessionModel</span></code><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">library_item_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">library_item_content_version</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">error_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">client_progress</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">state</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">expiration_time</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.content.library.item_client.DownloadSessionModel" 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">DownloadSessionModel</span></code> class provides information on an active
<a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSession" title="com.vmware.content.library.item_client.DownloadSession"><code class="xref py py-class docutils literal notranslate"><span class="pre">DownloadSession</span></code></a> resource.</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>) – The identifier of this download session.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>. When methods
return a value of this class as a return value, the attribute will
be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>.
This attribute is not used for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will not
be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code> methods.
It is not used for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
<li><p><strong>library_item_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the library item whose content is being
downloaded.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.
This attribute must be provided for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
always be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>
methods. It is not used for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
<li><p><strong>library_item_content_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The content version of the library item whose content is being
downloaded. This value is the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library_client.ItemModel.content_version</span></code>
at the time when the session is created for the library item.
This attribute is not used for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
always be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>
methods. It is not used for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
<li><p><strong>error_message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – If the session is in the <a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ERROR" title="com.vmware.content.library.item_client.DownloadSessionModel.State.ERROR"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DownloadSessionModel.State.ERROR</span></code></a>
status this property will have more details about the error.
This attribute is not used for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It is
optional in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code> methods. It
is not used for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
<li><p><strong>client_progress</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The progress that has been made with the download. This property is
to be updated by the client during the download process to indicate
the progress of its work in completing the download. The initial
progress is 0 until updated by the client. The maximum value is
100, which indicates that the download is complete.
This attribute is not used for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
always be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>
methods. It is optional for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSessionModel.State" title="com.vmware.content.library.item_client.DownloadSessionModel.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">DownloadSessionModel.State</span></code></a>) – The current state (ACTIVE, CANCELED, ERROR) of the download
session.
This attribute is not used for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
always be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>
methods. It is not used for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
<li><p><strong>expiration_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Indicates the time after which the session will expire. The session
is guaranteed not to expire before this time.
This attribute is not used for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
always be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>
methods. It is not used for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.content.library.item_client.DownloadSessionModel.State">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">State</span></code><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.content.library.item_client.DownloadSessionModel.State" 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 state of the download session.</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">State</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE">
<code class="sig-name descname"><span class="pre">ACTIVE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='ACTIVE')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE" title="Permalink to this definition"></a></dt>
<dd><p>The session is active. Individual files may be in the process of being
transferred and may become ready for download at different times.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.DownloadSessionModel.State.CANCELED">
<code class="sig-name descname"><span class="pre">CANCELED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='CANCELED')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.CANCELED" title="Permalink to this definition"></a></dt>
<dd><p>The session has been canceled. On-going downloads may fail. The session
will stay in this state until it is either deleted by the user or
automatically cleaned up by the Content Library Service.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.DownloadSessionModel.State.ERROR">
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Indicates there was an error during the session lifecycle.</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.content.library.item_client.File">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item_client.</span></code><code class="sig-name descname"><span class="pre">File</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File" 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.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">File</span></code> class can be used to query for information on the files within
a library item. Files are objects which are added to a library item through
the <a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSession" title="com.vmware.content.library.item_client.UpdateSession"><code class="xref py py-class docutils literal notranslate"><span class="pre">UpdateSession</span></code></a> and
<a class="reference internal" href="com.vmware.content.library.item.html#com.vmware.content.library.item.updatesession_client.File" title="com.vmware.content.library.item.updatesession_client.File"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library.item.updatesession_client.File</span></code></a> classes.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.content.library.item_client.File.ChecksumAlgorithm">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ChecksumAlgorithm</span></code><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.content.library.item_client.File.ChecksumAlgorithm" 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">File.ChecksumAlgorithm</span></code> class defines the valid checksum algorithms.</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">ChecksumAlgorithm</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.File.ChecksumAlgorithm.MD5">
<code class="sig-name descname"><span class="pre">MD5</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ChecksumAlgorithm(string='MD5')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm.MD5" title="Permalink to this definition"></a></dt>
<dd><p>Checksum algorithm: MD5</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA1">
<code class="sig-name descname"><span class="pre">SHA1</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ChecksumAlgorithm(string='SHA1')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA1" title="Permalink to this definition"></a></dt>
<dd><p>Checksum algorithm: SHA-1</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA256">
<code class="sig-name descname"><span class="pre">SHA256</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ChecksumAlgorithm(string='SHA256')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA256" title="Permalink to this definition"></a></dt>
<dd><p>Checksum algorithm: SHA-256. This class attribute was added in vSphere API
6.8.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA512">
<code class="sig-name descname"><span class="pre">SHA512</span></code><em class="property"> <span class="pre">=</span> <span class="pre">ChecksumAlgorithm(string='SHA512')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA512" title="Permalink to this definition"></a></dt>
<dd><p>Checksum algorithm: SHA-512. This class attribute was added in vSphere API
6.8.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.content.library.item_client.File.ChecksumInfo">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">ChecksumInfo</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">algorithm</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">checksum</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.content.library.item_client.File.ChecksumInfo" 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>Provides checksums for a <a class="reference internal" href="#com.vmware.content.library.item_client.File.Info" title="com.vmware.content.library.item_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a> object.</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>algorithm</strong> (<a class="reference internal" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm" title="com.vmware.content.library.item_client.File.ChecksumAlgorithm"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.ChecksumAlgorithm</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – The checksum algorithm (SHA1, MD5, SHA256, SHA512) used to
calculate the checksum.
If not specified the default checksum algorithm is
<a class="reference internal" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA1" title="com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA1"><code class="xref py py-attr docutils literal notranslate"><span class="pre">File.ChecksumAlgorithm.SHA1</span></code></a>.</p></li>
<li><p><strong>checksum</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The checksum value calculated with
<code class="xref py py-attr docutils literal notranslate"><span class="pre">File.ChecksumInfo.algorithm</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.content.library.item_client.File.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">checksum_info</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">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">size</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">cached</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">version</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.content.library.item_client.File.Info" 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">File.Info</span></code> class provides information about a file in Content
Library Service storage.</p>
<p>A file is an actual stored object for a library item. An item will have
zero files initially, but one or more can be uploaded to the item.</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>checksum_info</strong> (<a class="reference internal" href="#com.vmware.content.library.item_client.File.ChecksumInfo" title="com.vmware.content.library.item_client.File.ChecksumInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.ChecksumInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>A checksum for validating the content of the file.</p>
<p>This value can be used to verify that a transfer was completed
without errors.
A checksum cannot always be calculated, and the value will be None
if the file does not have content.</p>
</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>The name of the file.</p>
<p>This value will be unique within the library item for each file. It
cannot be an empty string.</p>
</p></li>
<li><p><strong>size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The file size, in bytes. The file size is the storage used and not
the uploaded or provisioned size. For example, when uploading a
disk to a datastore, the amount of storage that the disk consumes
may be different from the disk file size. When the file is not
cached, the size is 0.</p></li>
<li><p><strong>cached</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Indicates whether the file is on disk or not.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The version of this file; incremented when a new copy of the file
is uploaded.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.File.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">library_item_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File.get" title="Permalink to this definition"></a></dt>
<dd><p>Retrieves the information for a single file in a library item by its
name.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>library_item_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the library item whose file information should be
returned.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the file in the library item whose information should be
returned.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content.library.item_client.File.Info" title="com.vmware.content.library.item_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.content.library.item_client.File.Info" title="com.vmware.content.library.item_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a> object with information on the specified
file.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">library_item_id</span></code> refers to a library item that does not
exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">name</span></code> refers to a file that does not exist in the library
item.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the parameter <code class="docutils literal notranslate"><span class="pre">library_item_id</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.File.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">library_item_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File.list" title="Permalink to this definition"></a></dt>
<dd><p>Lists all of the files that are stored within a given library item.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>library_item_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the library item whose files should be listed.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content.library.item_client.File.list" title="com.vmware.content.library.item_client.File.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.content.library.item_client.File.Info" title="com.vmware.content.library.item_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.content.library.item_client.File.list" title="com.vmware.content.library.item_client.File.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of all of the files that are stored within the
given library item.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if <code class="docutils literal notranslate"><span class="pre">library_item_id</span></code> refers to a library item that does not
exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the parameter <code class="docutils literal notranslate"><span class="pre">library_item_id</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.content.library.item_client.Storage">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item_client.</span></code><code class="sig-name descname"><span class="pre">Storage</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Storage" 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.VapiInterface</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">Storage</span></code> is a resource that represents a specific instance of a file
stored on a storage backing. Unlike <a class="reference internal" href="#com.vmware.content.library.item_client.File" title="com.vmware.content.library.item_client.File"><code class="xref py py-class docutils literal notranslate"><span class="pre">File</span></code></a>, which is abstract,
storage represents concrete files on the various storage backings. A file
is only represented once in <a class="reference internal" href="#com.vmware.content.library.item_client.File" title="com.vmware.content.library.item_client.File"><code class="xref py py-class docutils literal notranslate"><span class="pre">File</span></code></a>, but will be represented multiple
times (once for each storage backing) in <code class="docutils literal notranslate"><span class="pre">Storage</span></code>. The <code class="docutils literal notranslate"><span class="pre">Storage</span></code> class
provides information on the storage backing and the specific location of
the file in that backing to privileged users who want direct access to the
file on the storage medium.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.content.library.item_client.Storage.Info">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">Info</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">storage_backing</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">storage_uris</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">checksum_info</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">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">size</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">cached</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">version</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.content.library.item_client.Storage.Info" 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">Storage.Info</span></code> class is the expanded form of <a class="reference internal" href="#com.vmware.content.library.item_client.File.Info" title="com.vmware.content.library.item_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a> that
includes details about the storage backing for a file in a library item.</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>storage_backing</strong> (<a class="reference internal" href="com.vmware.content.html#com.vmware.content.library_client.StorageBacking" title="com.vmware.content.library_client.StorageBacking"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library_client.StorageBacking</span></code></a>) – The storage backing on which this object resides. This might not be
the same as the default storage backing associated with the
library.</p></li>
<li><p><strong>storage_uris</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>) – <p>URIs that identify the file on the storage backing.</p>
<p>These URIs may be specific to the backing and may need
interpretation by the client. A client that understands a URI
scheme in this list may use that URI to directly access the file on
the storage backing. This can provide high-performance support for
file manipulation.</p>
</p></li>
<li><p><strong>checksum_info</strong> (<a class="reference internal" href="#com.vmware.content.library.item_client.File.ChecksumInfo" title="com.vmware.content.library.item_client.File.ChecksumInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.ChecksumInfo</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – <p>A checksum for validating the content of the file.</p>
<p>This value can be used to verify that a transfer was completed
without errors.
A checksum cannot always be calculated, and the value will be None
if the file does not have content.</p>
</p></li>
<li><p><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>The name of the file.</p>
<p>This value will be unique within the library item for each file. It
cannot be an empty string.</p>
</p></li>
<li><p><strong>size</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The file size, in bytes. The file size is the storage used and not
the uploaded or provisioned size. For example, when uploading a
disk to a datastore, the amount of storage that the disk consumes
may be different from the disk file size. When the file is not
cached, the size is 0.</p></li>
<li><p><strong>cached</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Indicates whether the file is on disk or not.</p></li>
<li><p><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The version of this file; incremented when a new copy of the file
is uploaded.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.Storage.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">library_item_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Storage.get" title="Permalink to this definition"></a></dt>
<dd><p>Retrieves the storage information for a specific file in a library
item.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>library_item_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the library item whose storage information should be
retrieved.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</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 file for which the storage information should be
listed.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content.library.item_client.Storage.list" title="com.vmware.content.library.item_client.Storage.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.content.library.item_client.Storage.Info" title="com.vmware.content.library.item_client.Storage.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Storage.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.content.library.item_client.Storage.list" title="com.vmware.content.library.item_client.Storage.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of all the storage items for the given file
within the given library item.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the specified library item does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the specified file does not exist in the given library item.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the parameter <code class="docutils literal notranslate"><span class="pre">library_item_id</span></code> requires
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.ReadStorage</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.Storage.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">library_item_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Storage.list" title="Permalink to this definition"></a></dt>
<dd><p>Lists all storage items for a given library item.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>library_item_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the library item whose storage information should be
listed.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content.library.item_client.Storage.list" title="com.vmware.content.library.item_client.Storage.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.content.library.item_client.Storage.Info" title="com.vmware.content.library.item_client.Storage.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Storage.Info</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.content.library.item_client.Storage.list" title="com.vmware.content.library.item_client.Storage.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of all storage items for a given library item.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the specified library item does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the parameter <code class="docutils literal notranslate"><span class="pre">library_item_id</span></code> requires
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.ReadStorage</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.content.library.item_client.StubFactory">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item_client.</span></code><code class="sig-name descname"><span class="pre">StubFactory</span></code><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.content.library.item_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>
<dl class="py class">
<dt id="com.vmware.content.library.item_client.TransferEndpoint">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item_client.</span></code><code class="sig-name descname"><span class="pre">TransferEndpoint</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uri</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">ssl_certificate_thumbprint</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.content.library.item_client.TransferEndpoint" 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">TransferEndpoint</span></code> class encapsulates a URI along with extra
information about it.</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>uri</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – <p>Transfer endpoint URI. The supported URI schemes are: <code class="docutils literal notranslate"><span class="pre">http</span></code>,
<code class="docutils literal notranslate"><span class="pre">https</span></code>, and <code class="docutils literal notranslate"><span class="pre">ds</span></code>.</p>
<p>An endpoint URI with the <code class="docutils literal notranslate"><span class="pre">ds</span></code> scheme specifies the location of
the file on the datastore. The format of the datastore URI is:</p>
<ul>
<li><p>ds:///vmfs/volumes/uuid/path</p></li>
</ul>
<p>When the transfer endpoint is a datastore location, the server can
import the file directly from the storage backing without the
overhead of streaming over HTTP.</p>
</p></li>
<li><p><strong>ssl_certificate_thumbprint</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>) – Thumbprint of the expected SSL certificate for this endpoint. Only
used for HTTPS connections. The thumbprint is the SHA-1 hash of the
DER encoding of the remote endpoint’s SSL certificate. If set, the
remote endpoint’s SSL certificate is only accepted if it matches
this thumbprint, and no other certificate validation is performed.
If not specified, standard certificate validation is performed.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.content.library.item_client.TransferStatus">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item_client.</span></code><code class="sig-name descname"><span class="pre">TransferStatus</span></code><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.content.library.item_client.TransferStatus" 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">TransferStatus</span></code> class defines the transfer state of a file.</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.content.library.item_client.TransferStatus" title="com.vmware.content.library.item_client.TransferStatus"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransferStatus</span></code></a> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.TransferStatus.ERROR">
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">TransferStatus(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>Indicates that there was an error transferring or validating the file.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.TransferStatus.READY">
<code class="sig-name descname"><span class="pre">READY</span></code><em class="property"> <span class="pre">=</span> <span class="pre">TransferStatus(string='READY')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus.READY" title="Permalink to this definition"></a></dt>
<dd><p>Indicates that the file has been fully transferred and is ready to be used.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.TransferStatus.TRANSFERRING">
<code class="sig-name descname"><span class="pre">TRANSFERRING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">TransferStatus(string='TRANSFERRING')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus.TRANSFERRING" title="Permalink to this definition"></a></dt>
<dd><p>Indicates that data is being transferred to the file.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.TransferStatus.VALIDATING">
<code class="sig-name descname"><span class="pre">VALIDATING</span></code><em class="property"> <span class="pre">=</span> <span class="pre">TransferStatus(string='VALIDATING')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus.VALIDATING" title="Permalink to this definition"></a></dt>
<dd><p>Indicates that the file is being validated (checksum, type adapters).</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.TransferStatus.WAITING_FOR_TRANSFER">
<code class="sig-name descname"><span class="pre">WAITING_FOR_TRANSFER</span></code><em class="property"> <span class="pre">=</span> <span class="pre">TransferStatus(string='WAITING_FOR_TRANSFER')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus.WAITING_FOR_TRANSFER" title="Permalink to this definition"></a></dt>
<dd><p>Indicates that a file has been defined for a library item and its content
needs to be uploaded.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.content.library.item_client.UpdateSession">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item_client.</span></code><code class="sig-name descname"><span class="pre">UpdateSession</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession" 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.VapiInterface</span></code></p>
<p>The <code class="docutils literal notranslate"><span class="pre">UpdateSession</span></code> class manipulates sessions that are used to upload
content into the Content Library Service, and/or to remove files from a
library item.</p>
<p>An update session is a resource which tracks changes to content. An update
session is created with a set of files that are intended to be uploaded to
a specific <a class="reference internal" href="com.vmware.content.html#com.vmware.content.library_client.ItemModel" title="com.vmware.content.library_client.ItemModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library_client.ItemModel</span></code></a>, or removed
from an item. The session object can be used to track the uploads and
inspect the changes that are being made to the item by that upload. It can
also serve as a channel to check on the result of the upload, and status
messages such as errors and warnings for the upload.</p>
<p>Modifications are not visible to other clients unless the session is
completed and all necessary files have been received.</p>
<p>The management of the files within the session is done through the
<a class="reference internal" href="com.vmware.content.library.item.html#com.vmware.content.library.item.updatesession_client.File" title="com.vmware.content.library.item.updatesession_client.File"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library.item.updatesession_client.File</span></code></a> class.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.UpdateSession.RESOURCE_TYPE">
<code class="sig-name descname"><span class="pre">RESOURCE_TYPE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">'com.vmware.content.library.item.UpdateSession'</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.RESOURCE_TYPE" title="Permalink to this definition"></a></dt>
<dd><p>Resource type for an update session.</p>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.UpdateSession.cancel">
<code class="sig-name descname"><span class="pre">cancel</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">update_session_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.cancel" title="Permalink to this definition"></a></dt>
<dd><p>Cancels the update session and sets its state to
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.CANCELED" title="com.vmware.content.library.item_client.UpdateSessionModel.State.CANCELED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.State.CANCELED</span></code></a>. This method will free up any
temporary resources currently associated with the session.</p>
<blockquote>
<div><p>This method is not allowed if the session has been already completed.</p>
</div></blockquote>
<p>Cancelling an update session will cancel any in progress transfers
(either uploaded by the client or pulled by the server). Any content
that has been already received will be scheduled for deletion.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>update_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the update session that should be canceled.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if no update session with the given identifier exists.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the update session is not in the
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.State.ACTIVE</span></code></a> state.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.UpdateSession.complete">
<code class="sig-name descname"><span class="pre">complete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">update_session_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.complete" title="Permalink to this definition"></a></dt>
<dd><p>Completes the update session. This indicates that the client has
finished making all the changes required to the underlying library
item. If the client is pushing the content to the server, the library
item will be updated once this call returns. If the server is pulling
the content, the call may return before the changes become visible. In
that case, the client can track the session to know when the server is
done.</p>
<p>This method requires the session to be in the
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.State.ACTIVE</span></code></a> state.</p>
<p>Depending on the type of the library item associated with this session,
a type adapter may be invoked to verify the validity of the files
uploaded. The user can explicitly validate the session before
completing the session by using the
<a class="reference internal" href="com.vmware.content.library.item.html#com.vmware.content.library.item.updatesession_client.File.validate" title="com.vmware.content.library.item.updatesession_client.File.validate"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.content.library.item.updatesession_client.File.validate()</span></code></a>
method.</p>
<p>Modifications are not visible to other clients unless the session is
completed and all necessary files have been received.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>update_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the update session that should be completed.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if no update session with the given identifier exists.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the update session is not in the
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.State.ACTIVE</span></code></a> state, or if some of the
files that will be uploaded by the client aren’t received
correctly.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.UpdateSession.create">
<code class="sig-name descname"><span class="pre">create</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">create_spec</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_token</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.content.library.item_client.UpdateSession.create" title="Permalink to this definition"></a></dt>
<dd><p>Creates a new update session. An update session is used to make
modifications to a library item. Modifications are not visible to other
clients unless the session is completed and all necessary files have
been received.</p>
<p>Content Library Service allows only one single update session to be
active for a specific library item.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>client_token</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>) – Unique token generated by the client for each creation request. The
token should be a universally unique identifier (UUID), for
example: <code class="docutils literal notranslate"><span class="pre">b8a2a2e3-2314-43cd-a871-6ede0f429751</span></code>. This token can
be used to guarantee idempotent creation.
If not specified creation is not idempotent.</p></li>
<li><p><strong>create_spec</strong> (<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel" title="com.vmware.content.library.item_client.UpdateSessionModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">UpdateSessionModel</span></code></a>) – Specification for the new update session to be created.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Identifier of the new update session being created.
The return value will be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the session specification is not valid.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the <code class="docutils literal notranslate"><span class="pre">client_token</span></code> does not conform to the UUID format.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidElementType" title="com.vmware.vapi.std.errors_client.InvalidElementType"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code></a>
if the update session is being created on a subscribed library
item.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the item targeted for update does not exist.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code></a>
if there is another update session on the same library item.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
the attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.library_item_id</span></code> requires
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.UpdateSession</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.UpdateSession.delete">
<code class="sig-name descname"><span class="pre">delete</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">update_session_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.delete" title="Permalink to this definition"></a></dt>
<dd><p>Deletes an update session. This removes the session and all information
associated with it.</p>
<p>Removing an update session leaves any current transfers for that
session in an indeterminate state (there is no guarantee that the
server will terminate the transfers, or that the transfers can be
completed). However there will no longer be a means of inspecting the
status of those uploads except by seeing the effect on the library
item.</p>
<p>Update sessions for which there is no upload activity or which are
complete will automatically be deleted after a period of time.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>update_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifer of the update session to delete.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the update session does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the update session is in the
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.State.ACTIVE</span></code></a> state.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.UpdateSession.fail">
<code class="sig-name descname"><span class="pre">fail</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">update_session_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_error_message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.fail" title="Permalink to this definition"></a></dt>
<dd><p>Terminates the update session with a client specified error message.</p>
<p>This is useful in transmitting client side failures (for example, not
being able to access a file) to the server side.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>update_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the update session to fail.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</p></li>
<li><p><strong>client_error_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Client side error message. This can be useful in providing some
extra details about the client side failure. Note that the message
won’t be translated to the user’s locale.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the update session does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the update session is not in the
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.State.ACTIVE</span></code></a> state.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.UpdateSession.get">
<code class="sig-name descname"><span class="pre">get</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">update_session_id</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.get" title="Permalink to this definition"></a></dt>
<dd><p>Gets the update session with the specified identifier, including the
most up-to-date status information for the session.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>update_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the update session to retrieve.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel" title="com.vmware.content.library.item_client.UpdateSessionModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">UpdateSessionModel</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel" title="com.vmware.content.library.item_client.UpdateSessionModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">UpdateSessionModel</span></code></a> instance with the given
<code class="docutils literal notranslate"><span class="pre">update_session_id</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if no update session with the given identifier exists.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.UpdateSession.keep_alive">
<code class="sig-name descname"><span class="pre">keep_alive</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">update_session_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_progress</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.content.library.item_client.UpdateSession.keep_alive" title="Permalink to this definition"></a></dt>
<dd><p>Keeps an update session alive.</p>
<p>If there is no activity for an update session after a period of time,
the update session will expire, then be deleted. The update session
expiration timeout is configurable in the Content Library Service
system configuration. The default is five minutes. Invoking this method
enables a client to specifically extend the lifetime of the update
session.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>update_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the update session whose lifetime should be extended.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</p></li>
<li><p><strong>client_progress</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>) – Optional update to the progress property of the session. If
specified, the new progress should be greater then the current
progress. See <code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.client_progress</span></code>.
If not specified the progress is not updated.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if no update session with the given identifier exists.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the update session is not in the
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.State.ACTIVE</span></code></a> state.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.UpdateSession.list">
<code class="sig-name descname"><span class="pre">list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">library_item_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.content.library.item_client.UpdateSession.list" title="Permalink to this definition"></a></dt>
<dd><p>Lists the identifiers of the update session created by the calling
user. Optionally may filter by library item.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>library_item_id</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>) – Optional library item identifier on which to filter results.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.
If not specified the results are not filtered.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSession.list" title="com.vmware.content.library.item_client.UpdateSession.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>The <a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSession.list" title="com.vmware.content.library.item_client.UpdateSession.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of identifiers of all update sessions created by
the calling user.
The return value will contain identifiers for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if a library item identifier is given for an item which does not
exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>
referenced by the parameter <code class="docutils literal notranslate"><span class="pre">library_item_id</span></code> requires
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.UpdateSession</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.content.library.item_client.UpdateSession.update">
<code class="sig-name descname"><span class="pre">update</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">update_session_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update_spec</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.update" title="Permalink to this definition"></a></dt>
<dd><p>Updates the properties of an update session.</p>
<p>This is an incremental update to the update session. Any attribute in
the <a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel" title="com.vmware.content.library.item_client.UpdateSessionModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">UpdateSessionModel</span></code></a> class that is None will not be
modified.</p>
<p>This method will only update the property
<code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.warning_behavior</span></code> of the update session. This
will not, for example, update the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.library_item_id</span></code> or
<code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.state</span></code> of an update session.</p>
<p>This method requires the session to be in the
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.State.ACTIVE</span></code></a> state.. This method was added
in vSphere API 6.8.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>update_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifer of the update session that should be updated.
The parameter must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</p></li>
<li><p><strong>update_spec</strong> (<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel" title="com.vmware.content.library.item_client.UpdateSessionModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">UpdateSessionModel</span></code></a>) – Specification for the new property values to be set on the update
session.</p></li>
</ul>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code></a>
if the update session does not exist.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code></a>
if the update session is not in the
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.State.ACTIVE</span></code></a> state.</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code></a>
if the update session specification is not valid.</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code></a>
if you do not have all of the privileges described as follows:</p>
<ul class="simple">
<li><p>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="com.vmware.content.library.item_client.UpdateSessionModel">
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">com.vmware.content.library.item_client.</span></code><code class="sig-name descname"><span class="pre">UpdateSessionModel</span></code><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">library_item_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">library_item_content_version</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">error_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">client_progress</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">state</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">expiration_time</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">preview_info</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">warning_behavior</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.content.library.item_client.UpdateSessionModel" 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">UpdateSessionModel</span></code> class provides information on an active
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSession" title="com.vmware.content.library.item_client.UpdateSession"><code class="xref py py-class docutils literal notranslate"><span class="pre">UpdateSession</span></code></a> resource.</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>) – The identifier of this update session.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>. When methods
return a value of this class as a return value, the attribute will
be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.
This attribute is not used for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will not
be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code> methods.
It is not used for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
<li><p><strong>library_item_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the library item to which content will be
uploaded or removed.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>. When methods return a value of
this class as a return value, the attribute will be an identifier
for the resource type: <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.
This attribute must be provided for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
always be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>
methods. It is not used for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
<li><p><strong>library_item_content_version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The content version of the library item whose content is being
modified. This value is the
<code class="xref py py-attr docutils literal notranslate"><span class="pre">com.vmware.content.library_client.ItemModel.content_version</span></code>
at the time when the session is created for the library item.
This attribute is not used for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
always be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>
methods. It is not used for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
<li><p><strong>error_message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – If the session is in the <a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ERROR" title="com.vmware.content.library.item_client.UpdateSessionModel.State.ERROR"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.State.ERROR</span></code></a>
status this property will have more details about the error.
This attribute is not used for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It is
optional in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code> methods. It
is not used for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
<li><p><strong>client_progress</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The progress that has been made with the upload. This property is
to be updated by the client during the upload process to indicate
the progress of its work in completing the upload. The initial
progress is 0 until updated by the client. The maximum value is
100, which indicates that the update is complete.
This attribute is not used for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
always be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>
methods. It is not used for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
<li><p><strong>state</strong> (<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State" title="com.vmware.content.library.item_client.UpdateSessionModel.State"><code class="xref py py-class docutils literal notranslate"><span class="pre">UpdateSessionModel.State</span></code></a>) – The current state (ACTIVE, DONE, ERROR, CANCELED) of the update
session. This attribute was added in vSphere API 6.8.
This attribute is not used for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
always be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>
methods. It is not used for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
<li><p><strong>expiration_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – Indicates the time after which the session will expire. The session
is guaranteed not to expire earlier than this time.
This attribute is not used for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It will
always be present in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>
methods. It is not used for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
<li><p><strong>preview_info</strong> (<a class="reference internal" href="com.vmware.content.library.item.html#com.vmware.content.library.item.updatesession_client.PreviewInfo" title="com.vmware.content.library.item.updatesession_client.PreviewInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library.item.updatesession_client.PreviewInfo</span></code></a>) – A preview of the files currently being uploaded in the session.
This property will be set only when the session is in the
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.State.ACTIVE</span></code></a>. This attribute was added
in vSphere API 6.8.
This attribute is optional and it is only relevant when the value
of <code class="docutils literal notranslate"><span class="pre">state</span></code> is <a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.State.ACTIVE</span></code></a>.</p></li>
<li><p><strong>warning_behavior</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="com.vmware.content.library.item.html#com.vmware.content.library.item.updatesession_client.WarningBehavior" title="com.vmware.content.library.item.updatesession_client.WarningBehavior"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library.item.updatesession_client.WarningBehavior</span></code></a>) – Indicates the update session behavior if warnings are raised in the
session preview. Any warning which is raised by session preview but
not ignored by the client will, by default, fail the update
session. This attribute was added in vSphere API 6.8.
This attribute is optional for the <code class="docutils literal notranslate"><span class="pre">create</span></code> method. It is
optional in the return value of the <code class="docutils literal notranslate"><span class="pre">get</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code> methods. It
is optional for the <code class="docutils literal notranslate"><span class="pre">update</span></code> method.</p></li>
</ul>
</dd>
</dl>
<dl class="py class">
<dt id="com.vmware.content.library.item_client.UpdateSessionModel.State">
<em class="property"><span class="pre">class</span> </em><code class="sig-name descname"><span class="pre">State</span></code><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.content.library.item_client.UpdateSessionModel.State" 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 state of an update session.</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">State</span></code> instance.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE">
<code class="sig-name descname"><span class="pre">ACTIVE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='ACTIVE')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="Permalink to this definition"></a></dt>
<dd><p>The session is currently active. This is the initial state when the session
is created. Files may be uploaded by the client or pulled by the Content
Library Service at this stage.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.UpdateSessionModel.State.CANCELED">
<code class="sig-name descname"><span class="pre">CANCELED</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='CANCELED')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.CANCELED" title="Permalink to this definition"></a></dt>
<dd><p>The session has been canceled.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.UpdateSessionModel.State.DONE">
<code class="sig-name descname"><span class="pre">DONE</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='DONE')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.DONE" title="Permalink to this definition"></a></dt>
<dd><p>The session is done and all its effects are now visible.</p>
</dd></dl>
<dl class="py attribute">
<dt id="com.vmware.content.library.item_client.UpdateSessionModel.State.ERROR">
<code class="sig-name descname"><span class="pre">ERROR</span></code><em class="property"> <span class="pre">=</span> <span class="pre">State(string='ERROR')</span></em><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ERROR" title="Permalink to this definition"></a></dt>
<dd><p>There was an error during the session.</p>
</dd></dl>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="com.vmware.content.library.item.html" class="btn btn-neutral float-right" title="com.vmware.content.library.item package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="com.vmware.content.html" class="btn btn-neutral float-left" title="com.vmware.content package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2022, 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 type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
View Git Blame Copy Permalink