<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="sig-prename descclassname">com.vmware.content.library.item.downloadsession_client.</code><codeclass="sig-name descname">File</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.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>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="sig-name descname">EndpointType</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="sig-name descname">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>
<codeclass="sig-name 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>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the file.</p></li>
<li><p><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.
to be set when the client finishes downloading the file.</p></li>
<li><p><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
zero till the client starts downloading the file.</p></li>
<li><p><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.</p></li>
<li><p><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
<li><p><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.</p></li>
<li><p><strong>error_message</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> 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="sig-name descname">PrepareStatus</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="sig-name descname">ERROR</code><emclass="property"> = 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="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">download_session_id</em>, <emclass="sig-param">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>
<li><p><strong>file_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the file requested.</p></li>
<ddclass="field-odd"><p>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="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
<codeclass="sig-name descname">prepare</code><spanclass="sig-paren">(</span><emclass="sig-param">download_session_id</em>, <emclass="sig-param">file_name</em>, <emclass="sig-param">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>
<li><p><strong>file_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the file requested for download.</p></li>
<li><p><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
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>.</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.content.library.item.downloadsession_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.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="sig-prename descclassname">com.vmware.content.library.item.updatesession_client.</code><codeclass="sig-name descname">CertificateInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">issuer=None</em>, <emclass="sig-param">subject=None</em>, <emclass="sig-param">self_signed=None</em>, <emclass="sig-param">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>
<li><p><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.8.</p></li>
<li><p><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="sig-prename descclassname">com.vmware.content.library.item.updatesession_client.</code><codeclass="sig-name descname">File</code><spanclass="sig-paren">(</span><emclass="sig-param">config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.File"title="Permalink to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</p>
<emclass="property">class </em><codeclass="sig-name descname">AddSpec</code><spanclass="sig-paren">(</span><emclass="sig-param">name=None</em>, <emclass="sig-param">source_type=None</em>, <emclass="sig-param">source_endpoint=None</em>, <emclass="sig-param">size=None</em>, <emclass="sig-param">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>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the file being uploaded.</p></li>
<li><p><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.</p></li>
<li><p><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
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>.</p></li>
<li><p><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.</p></li>
<li><p><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
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the file.</p></li>
<li><p><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
<li><p><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
<li><p><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.</p></li>
<li><p><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.
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>.</p></li>
<li><p><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.
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>.</p></li>
<li><p><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.</p></li>
<li><p><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.</p></li>
<li><p><strong>error_message</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Details about the transfer error.
<li><p><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
<emclass="property">class </em><codeclass="sig-name descname">SourceType</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="sig-name descname">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="sig-name 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>
<codeclass="sig-name 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>
<emclass="property">class </em><codeclass="sig-name descname">ValidationError</code><spanclass="sig-paren">(</span><emclass="sig-param">name=None</em>, <emclass="sig-param">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>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The name of the file.</p></li>
<li><p><strong>error_message</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – A message indicating why the file was considered invalid.</p></li>
<emclass="property">class </em><codeclass="sig-name descname">ValidationResult</code><spanclass="sig-paren">(</span><emclass="sig-param">has_errors=None</em>, <emclass="sig-param">missing_files=None</em>, <emclass="sig-param">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>
<li><p><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
<li><p><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.</p></li>
<li><p><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="sig-name descname">add</code><spanclass="sig-paren">(</span><emclass="sig-param">update_session_id</em>, <emclass="sig-param">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>
<li><p><strong>update_session_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the update session to be modified.
<li><p><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
<ddclass="field-odd"><p>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
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="sig-name descname">get</code><spanclass="sig-paren">(</span><emclass="sig-param">update_session_id</em>, <emclass="sig-param">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>
<li><p><strong>file_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the file.</p></li>
<codeclass="sig-name descname">list</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
<ddclass="field-odd"><p>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="sig-name descname">remove</code><spanclass="sig-paren">(</span><emclass="sig-param">update_session_id</em>, <emclass="sig-param">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>
<li><p><strong>file_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the file to be removed.</p></li>
<codeclass="sig-name descname">validate</code><spanclass="sig-paren">(</span><emclass="sig-param">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>
<ddclass="field-odd"><p><strong>update_session_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the update session to validate.
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.content.library.item.updatesession_client.</code><codeclass="sig-name descname">PreviewInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">state=None</em>, <emclass="sig-param">certificate_info=None</em>, <emclass="sig-param">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>
<li><p><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.8.</p></li>
<li><p><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.8.
This attribute is None if the update session content is not signed.</p></li>
<li><p><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
<emclass="property">class </em><codeclass="sig-name descname">State</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.PreviewInfo.State"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="sig-name descname">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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.content.library.item.updatesession_client.</code><codeclass="sig-name descname">PreviewWarningInfo</code><spanclass="sig-paren">(</span><emclass="sig-param">type=None</em>, <emclass="sig-param">message=None</em>, <emclass="sig-param">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>
<li><p><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.8.</p></li>
<li><p><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.8.</p></li>
<li><p><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.8.</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.content.library.item.updatesession_client.</code><codeclass="sig-name descname">StubFactory</code><spanclass="sig-paren">(</span><emclass="sig-param">stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.content.library.item.updatesession_client.</code><codeclass="sig-name descname">WarningBehavior</code><spanclass="sig-paren">(</span><emclass="sig-param">type=None</em>, <emclass="sig-param">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>
<li><p><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.8.</p></li>
<li><p><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.8.</p></li>
<emclass="property">class </em><codeclass="sig-prename descclassname">com.vmware.content.library.item.updatesession_client.</code><codeclass="sig-name descname">WarningType</code><spanclass="sig-paren">(</span><emclass="sig-param">string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.content.library.item.updatesession_client.WarningType"title="Permalink to this definition">¶</a></dt>
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="sig-name descname">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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
<codeclass="sig-name 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>
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>.
