<spanid="com-vmware-content-library-item-package"></span><h1>com.vmware.content.library.item package<aclass="headerlink"href="#module-com.vmware.content.library.item"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="submodules">
<h2>Submodules<aclass="headerlink"href="#submodules"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-content-library-item-downloadsession-client-module"></span><h2>com.vmware.content.library.item.downloadsession_client module<aclass="headerlink"href="#module-com.vmware.content.library.item.downloadsession_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.content.library.item.downloadsession_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.downloadsession_client.File"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">File</span></code> class provides methods for accessing files within a download
session.</p>
<p>After a download session is created against a library item, the <codeclass="docutils literal notranslate"><spanclass="pre">File</span></code>
class can be used to retrieve all downloadable content within the library
item. Since the content may not be available immediately in a downloadable
form on the server side, the client will have to prepare the file and wait
for the file status to become <aclass="reference internal"href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARED"title="com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">File.PrepareStatus.PREPARED</span></code></a>.</p>
<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">EndpointType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.downloadsession_client.File.EndpointType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">File.EndpointType</span></code> class defines the types of endpoints used to
download the 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">DIRECT</code><emclass="property"> = EndpointType(string='DIRECT')</em><aclass="headerlink"href="#com.vmware.content.library.item.downloadsession_client.File.EndpointType.DIRECT"title="Permalink to this definition">¶</a></dt>
<dd><p>A direct download endpoint indicating the location of the file on storage.
The caller is responsible for retrieving the file from the storage location
<codeclass="descname">HTTPS</code><emclass="property"> = EndpointType(string='HTTPS')</em><aclass="headerlink"href="#com.vmware.content.library.item.downloadsession_client.File.EndpointType.HTTPS"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>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the file.</li>
<li><strong>size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The file size, in bytes.
This attribute may not be available immediately. It is guaranteed
to be set when the client finishes downloading the file.</li>
<li><strong>bytes_transferred</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The number of bytes that have been transferred by the server so far
for making this file prepared for download. This value may stay at
zero till the client starts downloading the file.</li>
<li><strong>status</strong> (<aclass="reference internal"href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus"title="com.vmware.content.library.item.downloadsession_client.File.PrepareStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">File.PrepareStatus</span></code></a>) – The preparation status (UNPREPARED, PREPARE_REQUESTED, PREPARING,
PREPARED, ERROR) of the file.</li>
<li><strong>download_endpoint</strong> (<aclass="reference internal"href="com.vmware.content.library.html#com.vmware.content.library.item_client.TransferEndpoint"title="com.vmware.content.library.item_client.TransferEndpoint"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.content.library.item_client.TransferEndpoint</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Endpoint at which the file is available for download. The value is
valid only when the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">File.Info.status</span></code> is
<li><strong>checksum_info</strong> (<aclass="reference internal"href="com.vmware.content.library.html#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">com.vmware.content.library.item_client.File.ChecksumInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The checksum information of the file. When the download is
complete, you can retrieve the checksum from the <aclass="reference internal"href="#com.vmware.content.library.item.downloadsession_client.File.get"title="com.vmware.content.library.item.downloadsession_client.File.get"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">File.get()</span></code></a>
method to verify the checksum for the downloaded file.
The checksum is always calculated for the downloaded file, but this
attribute won’t be set until the download is complete.</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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Error message for a failed preparation when the prepare status is
<emclass="property">class </em><codeclass="descname">PrepareStatus</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">File.PrepareStatus</span></code> class defines the state of the file in
preparation for download.</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"> = PrepareStatus(string='ERROR')</em><aclass="headerlink"href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.ERROR"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">PREPARED</code><emclass="property"> = PrepareStatus(string='PREPARED')</em><aclass="headerlink"href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARED"title="Permalink to this definition">¶</a></dt>
<dd><p>Prepare succeeded. The file is ready for download.</p>
<codeclass="descname">PREPARE_REQUESTED</code><emclass="property"> = PrepareStatus(string='PREPARE_REQUESTED')</em><aclass="headerlink"href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARE_REQUESTED"title="Permalink to this definition">¶</a></dt>
<dd><p>A prepare has been requested, however the server hasn’t started the
<codeclass="descname">PREPARING</code><emclass="property"> = PrepareStatus(string='PREPARING')</em><aclass="headerlink"href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.PREPARING"title="Permalink to this definition">¶</a></dt>
<dd><p>A prepare has been requested and the file is in the process of being
<codeclass="descname">UNPREPARED</code><emclass="property"> = PrepareStatus(string='UNPREPARED')</em><aclass="headerlink"href="#com.vmware.content.library.item.downloadsession_client.File.PrepareStatus.UNPREPARED"title="Permalink to this definition">¶</a></dt>
<dd><p>The file hasn’t been requested for preparation.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>download_session_id</em>, <em>file_name</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.downloadsession_client.File.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves file download information for a specific file.</p>
<li><strong>file_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the file requested.</li>
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">The <aclass="reference internal"href="#com.vmware.content.library.item.downloadsession_client.File.Info"title="com.vmware.content.library.item.downloadsession_client.File.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">File.Info</span></code></a> instance containing the status of the file
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>download_session_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.downloadsession_client.File.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Lists the information of all the files in the library item associated
<codeclass="descname">prepare</code><spanclass="sig-paren">(</span><em>download_session_id</em>, <em>file_name</em>, <em>endpoint_type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.downloadsession_client.File.prepare"title="Permalink to this definition">¶</a></dt>
<dd><p>Requests a file to be prepared for download.</p>
<li><strong>file_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the file requested for download.</li>
<li><strong>endpoint_type</strong> (<aclass="reference internal"href="#com.vmware.content.library.item.downloadsession_client.File.EndpointType"title="com.vmware.content.library.item.downloadsession_client.File.EndpointType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">File.EndpointType</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Endpoint type request, one of HTTPS, DIRECT. This will determine
the type of the <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">File.Info.download_endpoint</span></code> that is
generated when the file is prepared. The
<aclass="reference internal"href="#com.vmware.content.library.item.downloadsession_client.File.EndpointType.DIRECT"title="com.vmware.content.library.item.downloadsession_client.File.EndpointType.DIRECT"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">File.EndpointType.DIRECT</span></code></a> is only available to users who
have the ContentLibrary.ReadStorage privilege.
If not specified the default is <aclass="reference internal"href="#com.vmware.content.library.item.downloadsession_client.File.EndpointType.HTTPS"title="com.vmware.content.library.item.downloadsession_client.File.EndpointType.HTTPS"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">File.EndpointType.HTTPS</span></code></a>.</li>
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">File information containing the status of the request and the
<emclass="property">class </em><codeclass="descclassname">com.vmware.content.library.item.downloadsession_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.downloadsession_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<spanid="com-vmware-content-library-item-updatesession-client-module"></span><h2>com.vmware.content.library.item.updatesession_client module<aclass="headerlink"href="#module-com.vmware.content.library.item.updatesession_client"title="Permalink to this headline">¶</a></h2>
<p>The Content Library Item Update Session module provides classes and classes for
<emclass="property">class </em><codeclass="descclassname">com.vmware.content.library.item.updatesession_client.</code><codeclass="descname">CertificateInfo</code><spanclass="sig-paren">(</span><em>issuer=None</em>, <em>subject=None</em>, <em>self_signed=None</em>, <em>x509=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.CertificateInfo"title="Permalink to this definition">¶</a></dt>
Avamar/CN=EMC Corporation. This attribute was added in vSphere API
6.7 U1.</li>
<li><strong>self_signed</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether the certificate is self-signed. This attribute was added in
vSphere API 6.7 U1.</li>
<li><strong>x509</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The X509 representation of the certificate. This attribute was
<emclass="property">class </em><codeclass="descclassname">com.vmware.content.library.item.updatesession_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.updatesession_client.File"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>
<emclass="property">class </em><codeclass="descname">AddSpec</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>source_type=None</em>, <em>source_endpoint=None</em>, <em>size=None</em>, <em>checksum_info=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.File.AddSpec"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>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the file being uploaded.</li>
<li><strong>source_type</strong> (<aclass="reference internal"href="#com.vmware.content.library.item.updatesession_client.File.SourceType"title="com.vmware.content.library.item.updatesession_client.File.SourceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">File.SourceType</span></code></a>) – The source type (NONE, PUSH, PULL) from which the file content will
be retrieved.</li>
<li><strong>source_endpoint</strong> (<aclass="reference internal"href="com.vmware.content.library.html#com.vmware.content.library.item_client.TransferEndpoint"title="com.vmware.content.library.item_client.TransferEndpoint"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.content.library.item_client.TransferEndpoint</span></code></a>) – Location from which the Content Library Service will fetch the
file, rather than requiring a client to upload the file.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">sourceType</span></code> is <aclass="reference internal"href="#com.vmware.content.library.item.updatesession_client.File.SourceType.PULL"title="com.vmware.content.library.item.updatesession_client.File.SourceType.PULL"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">File.SourceType.PULL</span></code></a>.</li>
<li><strong>size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The file size, in bytes.
If None, the server will not verify it received the correct size.</li>
<li><strong>checksum_info</strong> (<aclass="reference internal"href="com.vmware.content.library.html#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">com.vmware.content.library.item_client.File.ChecksumInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The checksum of the file. If specified, the server will verify the
checksum once the file is received. If there is a mismatch, the
upload will fail. For ova files, this value should not be set.
If None, the server will not verify the checksum.</li>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the file.</li>
<li><strong>source_type</strong> (<aclass="reference internal"href="#com.vmware.content.library.item.updatesession_client.File.SourceType"title="com.vmware.content.library.item.updatesession_client.File.SourceType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">File.SourceType</span></code></a>) – The source type (NONE, PUSH, PULL) from which the file is being
retrieved. This may be <aclass="reference internal"href="#com.vmware.content.library.item.updatesession_client.File.SourceType.NONE"title="com.vmware.content.library.item.updatesession_client.File.SourceType.NONE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">File.SourceType.NONE</span></code></a> if the file is
not being changed.</li>
<li><strong>size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The file size, in bytes as received by the server. This attribute
is guaranteed to be set when the server has completely received the
file.
This attribute won’t be set until the file status is
<li><strong>checksum_info</strong> (<aclass="reference internal"href="com.vmware.content.library.html#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">com.vmware.content.library.item_client.File.ChecksumInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The checksum information of the file received by the server.
If None, the server does not verify the checksum.</li>
<li><strong>source_endpoint</strong> (<aclass="reference internal"href="com.vmware.content.library.html#com.vmware.content.library.item_client.TransferEndpoint"title="com.vmware.content.library.item_client.TransferEndpoint"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.content.library.item_client.TransferEndpoint</span></code></a>) – A source endpoint from which to retrieve the file.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">sourceType</span></code> is <aclass="reference internal"href="#com.vmware.content.library.item.updatesession_client.File.SourceType.PULL"title="com.vmware.content.library.item.updatesession_client.File.SourceType.PULL"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">File.SourceType.PULL</span></code></a>.</li>
<li><strong>upload_endpoint</strong> (<aclass="reference internal"href="com.vmware.content.library.html#com.vmware.content.library.item_client.TransferEndpoint"title="com.vmware.content.library.item_client.TransferEndpoint"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.content.library.item_client.TransferEndpoint</span></code></a>) – An upload endpoint to which the client can push the content.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">sourceType</span></code> is <aclass="reference internal"href="#com.vmware.content.library.item.updatesession_client.File.SourceType.PUSH"title="com.vmware.content.library.item.updatesession_client.File.SourceType.PUSH"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">File.SourceType.PUSH</span></code></a>.</li>
<li><strong>bytes_transferred</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The number of bytes of this file that have been received by the
server.</li>
<li><strong>status</strong> (<aclass="reference internal"href="com.vmware.content.library.html#com.vmware.content.library.item_client.TransferStatus"title="com.vmware.content.library.item_client.TransferStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.content.library.item_client.TransferStatus</span></code></a>) – The transfer status (WAITING_FOR_TRANSFER, TRANSFERRING, READY,
VALIDATING, ERROR) of this file.</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> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Details about the transfer error.
<li><strong>keep_in_storage</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Whether or not the file will be kept in storage upon update session
completion. The flag is true for most files, and false for metadata
files such as manifest and certificate file of update session with
library item type OVF. Any file with
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">File.Info.keep_in_storage</span></code> set to false will not show up in
the list of files returned from
<aclass="reference internal"href="com.vmware.content.library.html#com.vmware.content.library.item_client.File.list"title="com.vmware.content.library.item_client.File.list"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">com.vmware.content.library.item_client.File.list()</span></code></a> upon
update session completion. This attribute was added in vSphere API
6.7 U1.
If None, the file will be kept in storage upon update session
<emclass="property">class </em><codeclass="descname">SourceType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.File.SourceType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">File.SourceType</span></code> class defines how the file content is retrieved.</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">NONE</code><emclass="property"> = SourceType(string='NONE')</em><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.File.SourceType.NONE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">PULL</code><emclass="property"> = SourceType(string='PULL')</em><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.File.SourceType.PULL"title="Permalink to this definition">¶</a></dt>
<dd><p>The server is pulling content from a URL. The URL scheme can be <codeclass="docutils literal notranslate"><spanclass="pre">http</span></code>,
<codeclass="docutils literal notranslate"><spanclass="pre">https</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">file</span></code>, or <codeclass="docutils literal notranslate"><spanclass="pre">ds</span></code>.</p>
<codeclass="descname">PUSH</code><emclass="property"> = SourceType(string='PUSH')</em><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.File.SourceType.PUSH"title="Permalink to this definition">¶</a></dt>
<dd><p>The client is uploading content using HTTP(S) PUT requests.</p>
<emclass="property">class </em><codeclass="descname">ValidationError</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>error_message=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.File.ValidationError"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>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the file.</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>) – A message indicating why the file was considered invalid.</li>
<emclass="property">class </em><codeclass="descname">ValidationResult</code><spanclass="sig-paren">(</span><em>has_errors=None</em>, <em>missing_files=None</em>, <em>invalid_files=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.File.ValidationResult"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>has_errors</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Whether the validation was succesful or not. In case of errors, the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">File.ValidationResult.missing_files</span></code> and
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">File.ValidationResult.invalid_files</span></code> will contain at least
one entry.</li>
<li><strong>missing_files</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – A <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">set</span></code> containing the names of the files that are required
but the client hasn’t added.</li>
<li><strong>invalid_files</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.content.library.item.updatesession_client.File.ValidationError"title="com.vmware.content.library.item.updatesession_client.File.ValidationError"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">File.ValidationError</span></code></a>) – A <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> containing the files that have been identified as
<codeclass="descname">add</code><spanclass="sig-paren">(</span><em>update_session_id</em>, <em>file_spec</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.File.add"title="Permalink to this definition">¶</a></dt>
<dd><p>Requests file content to be changed (either created, or updated).
Depending on the source type of the file, this method will either
return an upload endpoint where the client can push the content, or the
server will pull from the provided source endpoint. If a file with the
same name already exists in this session, this method will be used to
update the content of the existing file.</p>
<p>When importing a file directly from storage, where the source endpoint
is a file or datastore URI, you will need to have the
ContentLibrary.ReadStorage privilege on the library item. If the file
is located in the same directory as the library storage backing folder,
the server will move the file instead of copying it, thereby allowing
instantaneous import of files for efficient backup and restore
scenarios. In all other cases, a copy is performed rather than a move.</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 be modified.
The parameter must be an identifier for the resource type:
<li><strong>file_spec</strong> (<aclass="reference internal"href="#com.vmware.content.library.item.updatesession_client.File.AddSpec"title="com.vmware.content.library.item.updatesession_client.File.AddSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">File.AddSpec</span></code></a>) – Specification for the file that needs to be added or updated. This
includes whether the client wants to push the content or have the
<trclass="field-odd field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first">An <aclass="reference internal"href="#com.vmware.content.library.item.updatesession_client.File.Info"title="com.vmware.content.library.item.updatesession_client.File.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">File.Info</span></code></a> class containing upload links as well as
server side state tracking the transfer of the file.</p>
if the caller doesn’t have ContentLibrary.ReadStorage privilege on
the library item of the update session and source type
<aclass="reference internal"href="#com.vmware.content.library.item.updatesession_client.File.SourceType.PULL"title="com.vmware.content.library.item.updatesession_client.File.SourceType.PULL"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">File.SourceType.PULL</span></code></a> is requested for a file or datastore
source endpoint (that is, not HTTP or HTTPs based endpoint).</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>update_session_id</em>, <em>file_name</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.File.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Retrieves information about a specific file in the snapshot of the
library item at the time when the update session was created.</p>
<li><strong>file_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the file.</li>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>update_session_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.File.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Lists all files in the library item associated with the update 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.updatesession_client.File.list"title="com.vmware.content.library.item.updatesession_client.File.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> of the files in the library item associated with
the update session. This <aclass="reference internal"href="#com.vmware.content.library.item.updatesession_client.File.list"title="com.vmware.content.library.item.updatesession_client.File.list"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code></a> may be empty if the caller
has removed all the files as part of this session (in which case
completing the update session will result in an empty library
<codeclass="descname">remove</code><spanclass="sig-paren">(</span><em>update_session_id</em>, <em>file_name</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.File.remove"title="Permalink to this definition">¶</a></dt>
<dd><p>Requests a file to be removed. The file will only be effectively
<li><strong>file_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the file to be removed.</li>
<codeclass="descname">validate</code><spanclass="sig-paren">(</span><em>update_session_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.File.validate"title="Permalink to this definition">¶</a></dt>
<dd><p>Validates the files in the update session with the referenced
identifier and ensures all necessary files are received. In the case
where a file is missing, this method will return its name in the
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">File.ValidationResult.missing_files</span></code> set. The user can add the
missing files and try re-validating. For other type of errors,
<codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">File.ValidationResult.invalid_files</span></code> will contain the list of
<emclass="property">class </em><codeclass="descclassname">com.vmware.content.library.item.updatesession_client.</code><codeclass="descname">PreviewInfo</code><spanclass="sig-paren">(</span><em>state=None</em>, <em>certificate_info=None</em>, <em>warnings=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.PreviewInfo"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>state</strong> (<aclass="reference internal"href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State"title="com.vmware.content.library.item.updatesession_client.PreviewInfo.State"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PreviewInfo.State</span></code></a>) – Indicates the state of the preview of the update session. This
attribute was added in vSphere API 6.7 U1.</li>
<li><strong>certificate_info</strong> (<aclass="reference internal"href="#com.vmware.content.library.item.updatesession_client.CertificateInfo"title="com.vmware.content.library.item.updatesession_client.CertificateInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CertificateInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The certificate information of the signed update session content.
This attribute was added in vSphere API 6.7 U1.
This attribute is None if the update session content is not signed.</li>
<li><strong>warnings</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.content.library.item.updatesession_client.PreviewWarningInfo"title="com.vmware.content.library.item.updatesession_client.PreviewWarningInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PreviewWarningInfo</span></code></a>) – The list of warnings raised for this update session. Any warning
which is not ignored by the client will, by default, fail the
update session during session complete operation. 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.updatesession_client.PreviewInfo.State.AVAILABLE"title="com.vmware.content.library.item.updatesession_client.PreviewInfo.State.AVAILABLE"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">PreviewInfo.State.AVAILABLE</span></code></a>.</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.updatesession_client.PreviewInfo.State"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">PreviewInfo.State</span></code> class defines the state of the update session’s
preview. This enumeration was added in vSphere API 6.7 U1.</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">AVAILABLE</code><emclass="property"> = State(string='AVAILABLE')</em><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State.AVAILABLE"title="Permalink to this definition">¶</a></dt>
<dd><p>Preview is available for this update session. It is possible to review
certificate details and warnings, if any. This state is reached when the
applicable metadata files in the session have been fully uploaded. This
class attribute was added in vSphere API 6.7 U1.</p>
<codeclass="descname">NOT_APPLICABLE</code><emclass="property"> = State(string='NOT_APPLICABLE')</em><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State.NOT_APPLICABLE"title="Permalink to this definition">¶</a></dt>
<dd><p>Preview is not possible for this update session. This state is reached when
there are no metadata files in the update session and user invokes a
session complete operation. This class attribute was added in vSphere API
<codeclass="descname">PREPARING</code><emclass="property"> = State(string='PREPARING')</em><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State.PREPARING"title="Permalink to this definition">¶</a></dt>
<dd><p>A preview is being prepared for the files currently in the update session.
This state is reached when the applicable metadata files are added to the
update session but their content is not fully uploaded yet. For OVF item
type, this state indicates that the OVF descriptor file is currently being
uploaded. This class attribute was added in vSphere API 6.7 U1.</p>
<codeclass="descname">UNAVAILABLE</code><emclass="property"> = State(string='UNAVAILABLE')</em><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State.UNAVAILABLE"title="Permalink to this definition">¶</a></dt>
<dd><p>There are no files in the update session OR a preview is not possible for
the files currently in the update session. However, preview may be possible
after metadata files such as OVF descriptor are added to the session. In
this case the state will transition to <codeclass="docutils literal notranslate"><spanclass="pre">PREPARING</span></code>. This class attribute
<emclass="property">class </em><codeclass="descclassname">com.vmware.content.library.item.updatesession_client.</code><codeclass="descname">PreviewWarningInfo</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>message=None</em>, <em>ignored=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.PreviewWarningInfo"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>type</strong> (<aclass="reference internal"href="#com.vmware.content.library.item.updatesession_client.WarningType"title="com.vmware.content.library.item.updatesession_client.WarningType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">WarningType</span></code></a>) – The warning type raised during preview of the update session. This
attribute was added in vSphere API 6.7 U1.</li>
<li><strong>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>) – The message specifying more details about the warning. This
attribute was added in vSphere API 6.7 U1.</li>
<li><strong>ignored</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Indicates if this warning will be ignored during session complete
operation. This attribute was added in vSphere API 6.7 U1.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.content.library.item.updatesession_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.updatesession_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.content.library.item.updatesession_client.</code><codeclass="descname">WarningBehavior</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>ignored=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.WarningBehavior"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>type</strong> (<aclass="reference internal"href="#com.vmware.content.library.item.updatesession_client.WarningType"title="com.vmware.content.library.item.updatesession_client.WarningType"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">WarningType</span></code></a>) – The warning type which may be raised during the update session.
This attribute was added in vSphere API 6.7 U1.</li>
<li><strong>ignored</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code>) – Indicates if this warning will be ignored during session complete
operation. This attribute was added in vSphere API 6.7 U1.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.content.library.item.updatesession_client.</code><codeclass="descname">WarningType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.WarningType"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">WarningType</span></code> class defines the warnings which can be raised during
the update session. This enumeration was added in vSphere API 6.7 U1.</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">EXPIRED_CERTIFICATE</code><emclass="property"> = WarningType(string='EXPIRED_CERTIFICATE')</em><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.WarningType.EXPIRED_CERTIFICATE"title="Permalink to this definition">¶</a></dt>
<dd><p>The certificate used for signing the content is expired. This class
<codeclass="descname">NOT_YET_VALID_CERTIFICATE</code><emclass="property"> = WarningType(string='NOT_YET_VALID_CERTIFICATE')</em><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.WarningType.NOT_YET_VALID_CERTIFICATE"title="Permalink to this definition">¶</a></dt>
<dd><p>The certificate used for signing the content is not yet valid. This class
<codeclass="descname">SELF_SIGNED_CERTIFICATE</code><emclass="property"> = WarningType(string='SELF_SIGNED_CERTIFICATE')</em><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.WarningType.SELF_SIGNED_CERTIFICATE"title="Permalink to this definition">¶</a></dt>
<dd><p>The certificate used for signing the content is self-signed. This class
<codeclass="descname">UNTRUSTED_CERTIFICATE</code><emclass="property"> = WarningType(string='UNTRUSTED_CERTIFICATE')</em><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.WarningType.UNTRUSTED_CERTIFICATE"title="Permalink to this definition">¶</a></dt>
<dd><p>The certificate used for signing the content is not trusted. This class
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>.
