<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="descclassname">com.vmware.content.library.item_client.</code><codeclass="descname">DownloadSession</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.DownloadSession"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<codeclass="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="descname">cancel</code><spanclass="sig-paren">(</span><em>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>
<dd><p>Cancels the download session. This method will abort any ongoing
transfers and invalidate transfer urls that the client may be
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><pclass="first"><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.
The parameter must be an identifier for the resource type:
<codeclass="descname">create</code><spanclass="sig-paren">(</span><em>create_spec</em>, <em>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><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.
The token should be a universally unique identifier (UUID), for
example: <codeclass="docutils literal notranslate"><spanclass="pre">b8a2a2e3-2314-43cd-a871-6ede0f429751</span></code>. This token can
be used to guarantee idempotent creation.
If not specified creation is not idempotent.</li>
<li><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.</li>
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">Identifier of the new download session being created.
The return value will be an identifier for the resource type:
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>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>
<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
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><pclass="first"><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.
The parameter must be an identifier for the resource type:
<codeclass="descname">fail</code><spanclass="sig-paren">(</span><em>download_session_id</em>, <em>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>
<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>
<li><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.
The parameter must be an identifier for the resource type:
<li><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
extra details about the client side failure. Note that the message
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>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>
<dd><p>Gets the download session with the specified identifier, including the
most up-to-date status information for the session.</p>
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">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="descname">keep_alive</code><spanclass="sig-paren">(</span><em>download_session_id</em>, <em>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><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
extended.
The parameter must be an identifier for the resource type:
<li><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
specified, the new progress should be greater then the current
progress. See <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">DownloadSessionModel.client_progress</span></code>.
If not specified the progress is not updated.</li>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>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>
<dd><p>Lists the identifiers of the download sessions created by the calling
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">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
by the calling user.
The return value will contain identifiers for the resource type:
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.item.DownloadSession</span></code>. When methods
return a value of this class as a return value, the attribute will
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.</li>
<li><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
downloaded.
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.</li>
<li><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.</li>
<li><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.</li>
<li><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.</li>
<li><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
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>
methods. It is not used for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</li>
<li><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 before 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.</li>
<emclass="property">class </em><codeclass="descname">State</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.DownloadSessionModel.State"title="Permalink to this definition">¶</a></dt>
<pclass="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="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>
<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>
<codeclass="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>
<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>
<codeclass="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>
<dd><p>Indicates there was an error during the session lifecycle.</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.content.library.item_client.</code><codeclass="descname">File</code><spanclass="sig-paren">(</span><em>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
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<emclass="property">class </em><codeclass="descname">ChecksumAlgorithm</code><spanclass="sig-paren">(</span><em>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>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="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="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="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>
<dd><p>Checksum algorithm: SHA-256. This class attribute was added in vSphere API
<codeclass="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>
<dd><p>Checksum algorithm: SHA-512. This class attribute was added in vSphere API
<emclass="property">class </em><codeclass="descname">ChecksumInfo</code><spanclass="sig-paren">(</span><em>algorithm=None</em>, <em>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><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="descname">Info</code><spanclass="sig-paren">(</span><em>checksum_info=None</em>, <em>name=None</em>, <em>size=None</em>, <em>cached=None</em>, <em>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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><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>
<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>
</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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>
</li>
<li><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
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.</li>
<li><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.</li>
<li><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="descname">get</code><spanclass="sig-paren">(</span><em>library_item_id</em>, <em>name</em><spanclass="sig-paren">)</span><aclass="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
<li><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
returned.
The parameter must be an identifier for the resource type:
<li><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
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">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="descname">list</code><spanclass="sig-paren">(</span><em>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>
<dd><p>Lists all of the files that are stored within a given library item.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><pclass="first"><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.
The parameter must be an identifier for the resource type:
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">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="descclassname">com.vmware.content.library.item_client.</code><codeclass="descname">Storage</code><spanclass="sig-paren">(</span><em>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
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<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>
<divclass="admonition tip">
<pclass="first admonition-title">Tip</p>
<pclass="last">The arguments are used to initialize data attributes with the same
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><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
the same as the default storage backing associated with the
library.</li>
<li><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>
<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>
</li>
<li><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>
<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>
</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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>
</li>
<li><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
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.</li>
<li><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.</li>
<li><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="descname">get</code><spanclass="sig-paren">(</span><em>library_item_id</em>, <em>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>
<dd><p>Retrieves the storage information for a specific file in a library
<li><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
retrieved.
The parameter must be an identifier for the resource type:
<li><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
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">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="descname">list</code><spanclass="sig-paren">(</span><em>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>
<dd><p>Lists all storage items for a given library item.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><pclass="first"><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
listed.
The parameter must be an identifier for the resource type:
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">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="descclassname">com.vmware.content.library.item_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>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="descclassname">com.vmware.content.library.item_client.</code><codeclass="descname">TransferEndpoint</code><spanclass="sig-paren">(</span><em>uri=None</em>, <em>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>
<p>When the transfer endpoint is a file or datastore location, the
server can import the file directly from the storage backing
without the overhead of streaming over HTTP.</p>
</li>
<li><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
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.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.content.library.item_client.</code><codeclass="descname">TransferStatus</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.TransferStatus"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">TransferStatus</span></code> class defines the transfer state of a file.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="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>
<dd><p>Indicates that there was an error transferring or validating the file.</p>
<codeclass="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>
<dd><p>Indicates that the file has been fully transferred and is ready to be used.</p>
<codeclass="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>
<dd><p>Indicates that data is being transferred to the file.</p>
<codeclass="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>
<dd><p>Indicates that the file is being validated (checksum, type adapters).</p>
<codeclass="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>
<dd><p>Indicates that a file has been defined for a library item and its content
<emclass="property">class </em><codeclass="descclassname">com.vmware.content.library.item_client.</code><codeclass="descname">UpdateSession</code><spanclass="sig-paren">(</span><em>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
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><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.</td>
<codeclass="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="descname">cancel</code><spanclass="sig-paren">(</span><em>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>
<blockquote>
<div>This method is not allowed if the session has been already completed.</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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><pclass="first"><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.
The parameter must be an identifier for the resource type:
<codeclass="descname">complete</code><spanclass="sig-paren">(</span><em>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>
<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
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><pclass="first"><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.
The parameter must be an identifier for the resource type:
<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="descname">create</code><spanclass="sig-paren">(</span><em>create_spec</em>, <em>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>
<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
<li><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
token should be a universally unique identifier (UUID), for
example: <codeclass="docutils literal notranslate"><spanclass="pre">b8a2a2e3-2314-43cd-a871-6ede0f429751</span></code>. This token can
be used to guarantee idempotent creation.
If not specified creation is not idempotent.</li>
<li><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.</li>
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">Identifier of the new update session being created.
The return value will be an identifier for the resource type:
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>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>
<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>
<codeclass="descname">fail</code><spanclass="sig-paren">(</span><em>update_session_id</em>, <em>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>
<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>
<li><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.
The parameter must be an identifier for the resource type:
<li><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
extra details about the client side failure. Note that the message
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>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>
<dd><p>Gets the update session with the specified identifier, including the
most up-to-date status information for the session.</p>
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">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="descname">keep_alive</code><spanclass="sig-paren">(</span><em>update_session_id</em>, <em>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>
<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
<li><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.
The parameter must be an identifier for the resource type:
<li><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
specified, the new progress should be greater then the current
progress. See <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">UpdateSessionModel.client_progress</span></code>.
If not specified the progress is not updated.</li>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>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>
<dd><p>Lists the identifiers of the update session created by the calling
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">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
the calling user.
The return value will contain identifiers for the resource type:
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>update_session_id</em>, <em>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><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.
The parameter must be an identifier for the resource type:
<li><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
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="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:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.content.library.item.UpdateSession</span></code>. When methods
return a value of this class as a return value, the attribute will
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.</li>
<li><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
uploaded or removed.
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.</li>
<li><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.</li>
<li><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.</li>
<li><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.</li>
<li><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.7 U1.
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.</li>
<li><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.</li>
<li><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.
This property will be set only when the session is 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>. This attribute was added
in vSphere API 6.7 U1.
This attribute is optional and it is only relevant when the value
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>.</li>
<li><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
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.7 U1.
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
is optional for the <codeclass="docutils literal notranslate"><spanclass="pre">update</span></code> method.</li>
<emclass="property">class </em><codeclass="descname">State</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item_client.UpdateSessionModel.State"title="Permalink to this definition">¶</a></dt>
<pclass="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="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>
<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
<codeclass="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="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>
<dd><p>The session is done and all its effects are now visible.</p>
<codeclass="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>.
