<spanid="com-vmware-content-library-package"></span><h1>com.vmware.content.library package<aclass="headerlink"href="#module-com.vmware.content.library"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="subpackages">
<h2>Subpackages<aclass="headerlink"href="#subpackages"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-content-library-item-client-module"></span><h2>com.vmware.content.library.item_client module<aclass="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
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.content.library.item_client.</code><codeclass="sig-name descname">Changes</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.Changes"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="sig-name descname">Info</code><spanclass="sig-paren">(</span><emclass="sig-param">time=None</em>, <emclass="sig-param">user=None</em>, <emclass="sig-param">message=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.Changes.Info"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Changes.Info</span></code> class contains information about a library item
change. This class was added in vSphere API 6.9.1.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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
<codeclass="sig-name descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.content.library.item.Version'</em><aclass="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
<emclass="property">class </em><codeclass="sig-name descname">Summary</code><spanclass="sig-paren">(</span><emclass="sig-param">version=None</em>, <emclass="sig-param">time=None</em>, <emclass="sig-param">user=None</em>, <emclass="sig-param">short_message=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.Changes.Summary"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="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
<li><p><strong>time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="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
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">library_item</em>, <emclass="sig-param">version</em><spanclass="sig-paren">)</span><aclass="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
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param">library_item</em><spanclass="sig-paren">)</span><aclass="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>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.content.library.item_client.</code><codeclass="sig-name descname">DownloadSession</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.DownloadSession"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.content.library.item.DownloadSession'</em><aclass="headerlink"href="#com.vmware.content.library.item_client.DownloadSession.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">cancel</code><spanclass="sig-paren">(</span><emclass="sig-param">download_session_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.DownloadSession.cancel"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>download_session_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifer of the download session that should be canceled.
<codeclass="sig-name descname">create</code><spanclass="sig-paren">(</span><emclass="sig-param">create_spec</em>, <emclass="sig-param">client_token=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.DownloadSession.create"title="Permalink to this definition">¶</a></dt>
<li><p><strong>client_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A unique token generated by the client for each creation request.
If not specified creation is not idempotent.</p></li>
<li><p><strong>create_spec</strong> (<aclass="reference internal"href="#com.vmware.content.library.item_client.DownloadSessionModel"title="com.vmware.content.library.item_client.DownloadSessionModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DownloadSessionModel</span></code></a>) – Specification for the new download session to be created.</p></li>
<codeclass="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param">download_session_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.DownloadSession.delete"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>download_session_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the download session to be deleted.
<codeclass="sig-name descname">fail</code><spanclass="sig-paren">(</span><emclass="sig-param">download_session_id</em>, <emclass="sig-param">client_error_message</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.DownloadSession.fail"title="Permalink to this definition">¶</a></dt>
<li><p><strong>download_session_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the download session to fail.
<li><p><strong>client_error_message</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Client side error message. This can be useful in providing some
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">download_session_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.DownloadSession.get"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>download_session_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the download session to retrieve.
<ddclass="field-odd"><p>The <aclass="reference internal"href="#com.vmware.content.library.item_client.DownloadSessionModel"title="com.vmware.content.library.item_client.DownloadSessionModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DownloadSessionModel</span></code></a> instance with the given
<codeclass="sig-name descname">keep_alive</code><spanclass="sig-paren">(</span><emclass="sig-param">download_session_id</em>, <emclass="sig-param">progress=None</em><spanclass="sig-paren">)</span><aclass="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 <aclass="reference internal"href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE"title="com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="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
<li><p><strong>download_session_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the download session whose lifetime should be
<li><p><strong>progress</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Optional update to the progress property of the session. If
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param">library_item_id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.DownloadSession.list"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>library_item_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Library item identifier on which to filter results.
<ddclass="field-odd"><p>The <aclass="reference internal"href="#com.vmware.content.library.item_client.DownloadSession.list"title="com.vmware.content.library.item_client.DownloadSession.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> of identifiers of all download sessions created
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of this download session.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will not
be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code> methods.
It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p></li>
<li><p><strong>library_item_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the library item whose content is being
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.Item</span></code>.
This attribute must be provided for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p></li>
<li><p><strong>library_item_content_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The content version of the library item whose content is being
at the time when the session is created for the library item.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p></li>
<li><p><strong>error_message</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – If the session is in the <aclass="reference internal"href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ERROR"title="com.vmware.content.library.item_client.DownloadSessionModel.State.ERROR"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">DownloadSessionModel.State.ERROR</span></code></a>
status this property will have more details about the error.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It is
optional in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code> methods. It
is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p></li>
<li><p><strong>client_progress</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p></li>
<li><p><strong>state</strong> (<aclass="reference internal"href="#com.vmware.content.library.item_client.DownloadSessionModel.State"title="com.vmware.content.library.item_client.DownloadSessionModel.State"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DownloadSessionModel.State</span></code></a>) – The current state (ACTIVE, CANCELED, ERROR) of the download
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p></li>
<li><p><strong>expiration_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Indicates the time after which the session will expire. The session
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
<emclass="property">class </em><codeclass="sig-name descname">State</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.DownloadSessionModel.State"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="sig-name descname">ACTIVE</code><emclass="property"> = State(string='ACTIVE')</em><aclass="headerlink"href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">CANCELED</code><emclass="property"> = State(string='CANCELED')</em><aclass="headerlink"href="#com.vmware.content.library.item_client.DownloadSessionModel.State.CANCELED"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">ERROR</code><emclass="property"> = State(string='ERROR')</em><aclass="headerlink"href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ERROR"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.content.library.item_client.</code><codeclass="sig-name descname">File</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.File"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="#com.vmware.content.library.item_client.UpdateSession"title="com.vmware.content.library.item_client.UpdateSession"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">UpdateSession</span></code></a> and
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="sig-name descname">ChecksumAlgorithm</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">File.ChecksumAlgorithm</span></code> class defines the valid checksum algorithms.</p>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="sig-name descname">MD5</code><emclass="property"> = ChecksumAlgorithm(string='MD5')</em><aclass="headerlink"href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm.MD5"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">SHA1</code><emclass="property"> = ChecksumAlgorithm(string='SHA1')</em><aclass="headerlink"href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA1"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">SHA256</code><emclass="property"> = ChecksumAlgorithm(string='SHA256')</em><aclass="headerlink"href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA256"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">SHA512</code><emclass="property"> = ChecksumAlgorithm(string='SHA512')</em><aclass="headerlink"href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA512"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-name descname">ChecksumInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">algorithm=None</em>, <emclass="sig-param">checksum=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.File.ChecksumInfo"title="Permalink to this definition">¶</a></dt>
<li><p><strong>checksum</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The checksum value calculated with
<emclass="property">class </em><codeclass="sig-name descname">Info</code><spanclass="sig-paren">(</span><emclass="sig-param">checksum_info=None</em>, <emclass="sig-param">name=None</em>, <emclass="sig-param">size=None</em>, <emclass="sig-param">cached=None</em>, <emclass="sig-param">version=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.File.Info"title="Permalink to this definition">¶</a></dt>
<li><p><strong>checksum_info</strong> (<aclass="reference internal"href="#com.vmware.content.library.item_client.File.ChecksumInfo"title="com.vmware.content.library.item_client.File.ChecksumInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">File.ChecksumInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>A checksum for validating the content of the file.</p>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>The name of the file.</p>
<li><p><strong>size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The file size, in bytes. The file size is the storage used and not
<li><p><strong>cached</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Indicates whether the file is on disk or not.</p></li>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The version of this file; incremented when a new copy of the file
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">library_item_id</em>, <emclass="sig-param">name</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.File.get"title="Permalink to this definition">¶</a></dt>
<li><p><strong>library_item_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the library item whose file information should be
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the file in the library item whose information should be
<ddclass="field-odd"><p>The <aclass="reference internal"href="#com.vmware.content.library.item_client.File.Info"title="com.vmware.content.library.item_client.File.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">File.Info</span></code></a> object with information on the specified
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param">library_item_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.File.list"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>library_item_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the library item whose files should be listed.
<ddclass="field-odd"><p>The <aclass="reference internal"href="#com.vmware.content.library.item_client.File.list"title="com.vmware.content.library.item_client.File.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> of all of the files that are stored within the
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.content.library.item_client.</code><codeclass="sig-name descname">Storage</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.Storage"title="Permalink to this definition">¶</a></dt>
<p><codeclass="docutils literal notranslate"><spanclass="pre">Storage</span></code> is a resource that represents a specific instance of a file
stored on a storage backing. Unlike <aclass="reference internal"href="#com.vmware.content.library.item_client.File"title="com.vmware.content.library.item_client.File"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">File</span></code></a>, which is abstract,
storage represents concrete files on the various storage backings. A file
is only represented once in <aclass="reference internal"href="#com.vmware.content.library.item_client.File"title="com.vmware.content.library.item_client.File"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">File</span></code></a>, but will be represented multiple
times (once for each storage backing) in <codeclass="docutils literal notranslate"><spanclass="pre">Storage</span></code>. The <codeclass="docutils literal notranslate"><spanclass="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
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Storage.Info</span></code> class is the expanded form of <aclass="reference internal"href="#com.vmware.content.library.item_client.File.Info"title="com.vmware.content.library.item_client.File.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">File.Info</span></code></a> that
includes details about the storage backing for a file in a library item.</p>
<li><p><strong>storage_backing</strong> (<aclass="reference internal"href="com.vmware.content.html#com.vmware.content.library_client.StorageBacking"title="com.vmware.content.library_client.StorageBacking"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.content.library_client.StorageBacking</span></code></a>) – The storage backing on which this object resides. This might not be
<li><p><strong>storage_uris</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>URIs that identify the file on the storage backing.</p>
<li><p><strong>checksum_info</strong> (<aclass="reference internal"href="#com.vmware.content.library.item_client.File.ChecksumInfo"title="com.vmware.content.library.item_client.File.ChecksumInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">File.ChecksumInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –<p>A checksum for validating the content of the file.</p>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) –<p>The name of the file.</p>
<li><p><strong>size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The file size, in bytes. The file size is the storage used and not
<li><p><strong>cached</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Indicates whether the file is on disk or not.</p></li>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The version of this file; incremented when a new copy of the file
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">library_item_id</em>, <emclass="sig-param">file_name</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.Storage.get"title="Permalink to this definition">¶</a></dt>
<li><p><strong>library_item_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the library item whose storage information should be
<li><p><strong>file_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the file for which the storage information should be
<ddclass="field-odd"><p>The <aclass="reference internal"href="#com.vmware.content.library.item_client.Storage.list"title="com.vmware.content.library.item_client.Storage.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> of all the storage items for the given file
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param">library_item_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.Storage.list"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>library_item_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the library item whose storage information should be
<ddclass="field-odd"><p>The <aclass="reference internal"href="#com.vmware.content.library.item_client.Storage.list"title="com.vmware.content.library.item_client.Storage.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> of all storage items for a given library item.</p>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.content.library.item_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.content.library.item_client.</code><codeclass="sig-name descname">TransferEndpoint</code><spanclass="sig-paren">(</span><emclass="sig-param">uri=None</em>, <emclass="sig-param">ssl_certificate_thumbprint=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.TransferEndpoint"title="Permalink to this definition">¶</a></dt>
<li><p><strong>ssl_certificate_thumbprint</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Thumbprint of the expected SSL certificate for this endpoint. Only
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.content.library.item_client.</code><codeclass="sig-name descname">TransferStatus</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.TransferStatus"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="sig-name descname">ERROR</code><emclass="property"> = TransferStatus(string='ERROR')</em><aclass="headerlink"href="#com.vmware.content.library.item_client.TransferStatus.ERROR"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">READY</code><emclass="property"> = TransferStatus(string='READY')</em><aclass="headerlink"href="#com.vmware.content.library.item_client.TransferStatus.READY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">TRANSFERRING</code><emclass="property"> = TransferStatus(string='TRANSFERRING')</em><aclass="headerlink"href="#com.vmware.content.library.item_client.TransferStatus.TRANSFERRING"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">VALIDATING</code><emclass="property"> = TransferStatus(string='VALIDATING')</em><aclass="headerlink"href="#com.vmware.content.library.item_client.TransferStatus.VALIDATING"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">WAITING_FOR_TRANSFER</code><emclass="property"> = TransferStatus(string='WAITING_FOR_TRANSFER')</em><aclass="headerlink"href="#com.vmware.content.library.item_client.TransferStatus.WAITING_FOR_TRANSFER"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.content.library.item_client.</code><codeclass="sig-name descname">UpdateSession</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.UpdateSession"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="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 <aclass="reference internal"href="com.vmware.content.html#com.vmware.content.library_client.ItemModel"title="com.vmware.content.library_client.ItemModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<codeclass="sig-name descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.content.library.item.UpdateSession'</em><aclass="headerlink"href="#com.vmware.content.library.item_client.UpdateSession.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">cancel</code><spanclass="sig-paren">(</span><emclass="sig-param">update_session_id</em><spanclass="sig-paren">)</span><aclass="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
<aclass="reference internal"href="#com.vmware.content.library.item_client.UpdateSessionModel.State.CANCELED"title="com.vmware.content.library.item_client.UpdateSessionModel.State.CANCELED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">UpdateSessionModel.State.CANCELED</span></code></a>. This method will free up any
temporary resources currently associated with the session.</p>
<ddclass="field-odd"><p><strong>update_session_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the update session that should be canceled.
<codeclass="sig-name descname">complete</code><spanclass="sig-paren">(</span><emclass="sig-param">update_session_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.UpdateSession.complete"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>update_session_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the update session that should be completed.
<aclass="reference internal"href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"title="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">UpdateSessionModel.State.ACTIVE</span></code></a> state, or if some of the
files that will be uploaded by the client aren’t received
<codeclass="sig-name descname">create</code><spanclass="sig-paren">(</span><emclass="sig-param">create_spec</em>, <emclass="sig-param">client_token=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.UpdateSession.create"title="Permalink to this definition">¶</a></dt>
<li><p><strong>client_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Unique token generated by the client for each creation request. The
If not specified creation is not idempotent.</p></li>
<li><p><strong>create_spec</strong> (<aclass="reference internal"href="#com.vmware.content.library.item_client.UpdateSessionModel"title="com.vmware.content.library.item_client.UpdateSessionModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">UpdateSessionModel</span></code></a>) – Specification for the new update session to be created.</p></li>
<codeclass="sig-name descname">delete</code><spanclass="sig-paren">(</span><emclass="sig-param">update_session_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.UpdateSession.delete"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>update_session_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifer of the update session to delete.
<codeclass="sig-name descname">fail</code><spanclass="sig-paren">(</span><emclass="sig-param">update_session_id</em>, <emclass="sig-param">client_error_message</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.UpdateSession.fail"title="Permalink to this definition">¶</a></dt>
<li><p><strong>update_session_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the update session to fail.
<li><p><strong>client_error_message</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Client side error message. This can be useful in providing some
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">update_session_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.UpdateSession.get"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>update_session_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the update session to retrieve.
<ddclass="field-odd"><p>The <aclass="reference internal"href="#com.vmware.content.library.item_client.UpdateSessionModel"title="com.vmware.content.library.item_client.UpdateSessionModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">UpdateSessionModel</span></code></a> instance with the given
<codeclass="sig-name descname">keep_alive</code><spanclass="sig-paren">(</span><emclass="sig-param">update_session_id</em>, <emclass="sig-param">client_progress=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.UpdateSession.keep_alive"title="Permalink to this definition">¶</a></dt>
<li><p><strong>update_session_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the update session whose lifetime should be extended.
<li><p><strong>client_progress</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Optional update to the progress property of the session. If
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param">library_item_id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.UpdateSession.list"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p>The <aclass="reference internal"href="#com.vmware.content.library.item_client.UpdateSession.list"title="com.vmware.content.library.item_client.UpdateSession.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> of identifiers of all update sessions created by
<codeclass="sig-name descname">update</code><spanclass="sig-paren">(</span><emclass="sig-param">update_session_id</em>, <emclass="sig-param">update_spec</em><spanclass="sig-paren">)</span><aclass="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 <aclass="reference internal"href="#com.vmware.content.library.item_client.UpdateSessionModel"title="com.vmware.content.library.item_client.UpdateSessionModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">UpdateSessionModel</span></code></a> class that is None will not be
modified.</p>
<p>This method will only update the property
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">UpdateSessionModel.warning_behavior</span></code> of the update session. This
will not, for example, update the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">UpdateSessionModel.library_item_id</span></code> or
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">UpdateSessionModel.state</span></code> of an update session.</p>
<p>This method requires the session to be in the
<aclass="reference internal"href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"title="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">UpdateSessionModel.State.ACTIVE</span></code></a> state.. This method was added
<li><p><strong>update_session_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifer of the update session that should be updated.
<li><p><strong>update_spec</strong> (<aclass="reference internal"href="#com.vmware.content.library.item_client.UpdateSessionModel"title="com.vmware.content.library.item_client.UpdateSessionModel"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">UpdateSessionModel</span></code></a>) – Specification for the new property values to be set on the update
<li><p><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of this update session.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will not
be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code> methods.
It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p></li>
<li><p><strong>library_item_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the library item to which content will be
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="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: <codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.Item</span></code>.
This attribute must be provided for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p></li>
<li><p><strong>library_item_content_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The content version of the library item whose content is being
at the time when the session is created for the library item.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p></li>
<li><p><strong>error_message</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – If the session is in the <aclass="reference internal"href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ERROR"title="com.vmware.content.library.item_client.UpdateSessionModel.State.ERROR"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">UpdateSessionModel.State.ERROR</span></code></a>
status this property will have more details about the error.
This attribute is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It is
optional in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code> methods. It
is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p></li>
<li><p><strong>client_progress</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p></li>
<li><p><strong>state</strong> (<aclass="reference internal"href="#com.vmware.content.library.item_client.UpdateSessionModel.State"title="com.vmware.content.library.item_client.UpdateSessionModel.State"><codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p></li>
<li><p><strong>expiration_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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 <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It will
always be present in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</p></li>
<li><p><strong>preview_info</strong> (<aclass="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"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.content.library.item.updatesession_client.PreviewInfo</span></code></a>) – A preview of the files currently being uploaded in the session.
of <codeclass="docutils literal notranslate"><spanclass="pre">state</span></code> is <aclass="reference internal"href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"title="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">UpdateSessionModel.State.ACTIVE</span></code></a>.</p></li>
<li><p><strong>warning_behavior</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="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"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.content.library.item.updatesession_client.WarningBehavior</span></code></a>) – Indicates the update session behavior if warnings are raised in the
This attribute is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">create</span></code> method. It is
optional in the return value of the <codeclass="docutils literal notranslate"><spanclass="pre">get</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">list</span></code> methods. It
<emclass="property">class </em><codeclass="sig-name descname">State</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.UpdateSessionModel.State"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="sig-name descname">ACTIVE</code><emclass="property"> = State(string='ACTIVE')</em><aclass="headerlink"href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">CANCELED</code><emclass="property"> = State(string='CANCELED')</em><aclass="headerlink"href="#com.vmware.content.library.item_client.UpdateSessionModel.State.CANCELED"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">DONE</code><emclass="property"> = State(string='DONE')</em><aclass="headerlink"href="#com.vmware.content.library.item_client.UpdateSessionModel.State.DONE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">ERROR</code><emclass="property"> = State(string='ERROR')</em><aclass="headerlink"href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ERROR"title="Permalink to this definition">¶</a></dt>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.
