mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-29 12:00:00 -05:00
1409 lines
97 KiB
HTML
1409 lines
97 KiB
HTML
|
|
|||
|
|
|
|||
|
|
<!DOCTYPE html>
|
|||
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|||
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8">
|
|||
|
|
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|||
|
|
|
|||
|
|
<title>com.vmware.content.library package — vSphere Automation SDK for Python 6.7.0 documentation</title>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="index" title="Index"
|
|||
|
|
href="genindex.html"/>
|
|||
|
|
<link rel="search" title="Search" href="search.html"/>
|
|||
|
|
<link rel="top" title="vSphere Automation SDK for Python 6.7.0 documentation" href="index.html"/>
|
|||
|
|
<link rel="up" title="com.vmware.content package" href="com.vmware.content.html"/>
|
|||
|
|
<link rel="next" title="com.vmware.content.library.item package" href="com.vmware.content.library.item.html"/>
|
|||
|
|
<link rel="prev" title="com.vmware.content package" href="com.vmware.content.html"/>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script src="_static/js/modernizr.min.js"></script>
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
|
|||
|
|
<body class="wy-body-for-nav" role="document">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-grid-for-nav">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|||
|
|
<div class="wy-side-scroll">
|
|||
|
|
<div class="wy-side-nav-search">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="version">
|
|||
|
|
6.7.0
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="search">
|
|||
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|||
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|||
|
|
<input type="hidden" name="area" value="default" />
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<p class="caption"><span class="caption-text">Contents:</span></p>
|
|||
|
|
<ul class="current">
|
|||
|
|
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
|
|||
|
|
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
|
|||
|
|
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
|
|||
|
|
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.appliance_client">com.vmware.appliance_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.cis_client">com.vmware.cis_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.content_client">com.vmware.content_client module</a></li>
|
|||
|
|
<li class="toctree-l4"><a class="reference internal" href="com.vmware.html#module-com.vmware.vcenter_client">com.vmware.vcenter_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|||
|
|
|
|||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|||
|
|
<a href="index.html">vSphere Automation SDK for Python</a>
|
|||
|
|
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div class="wy-nav-content">
|
|||
|
|
<div class="rst-content">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|||
|
|
|
|||
|
|
<ul class="wy-breadcrumbs">
|
|||
|
|
|
|||
|
|
<li><a href="index.html">Docs</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.html">com package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.html">com.vmware package</a> »</li>
|
|||
|
|
|
|||
|
|
<li><a href="com.vmware.content.html">com.vmware.content package</a> »</li>
|
|||
|
|
|
|||
|
|
<li>com.vmware.content.library package</li>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="_sources/com.vmware.content.library.rst.txt" rel="nofollow"> View page source</a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</li>
|
|||
|
|
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
</div>
|
|||
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|||
|
|
<div itemprop="articleBody">
|
|||
|
|
|
|||
|
|
<div class="section" id="module-com.vmware.content.library">
|
|||
|
|
<span id="com-vmware-content-library-package"></span><h1>com.vmware.content.library package<a class="headerlink" href="#module-com.vmware.content.library" title="Permalink to this headline">¶</a></h1>
|
|||
|
|
<div class="section" id="subpackages">
|
|||
|
|
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<div class="toctree-wrapper compound">
|
|||
|
|
<ul>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="com.vmware.content.library.item.html">com.vmware.content.library.item package</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.library.item.html#submodules">Submodules</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.library.item.html#module-com.vmware.content.library.item.downloadsession_client">com.vmware.content.library.item.downloadsession_client module</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.library.item.html#module-com.vmware.content.library.item.updatesession_client">com.vmware.content.library.item.updatesession_client module</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="submodules">
|
|||
|
|
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
</div>
|
|||
|
|
<div class="section" id="module-com.vmware.content.library.item_client">
|
|||
|
|
<span id="com-vmware-content-library-item-client-module"></span><h2>com.vmware.content.library.item_client module<a class="headerlink" href="#module-com.vmware.content.library.item_client" title="Permalink to this headline">¶</a></h2>
|
|||
|
|
<p>The Content Library Item module provides classes and classes for managing files
|
|||
|
|
in a library item.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSession">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item_client.</code><code class="descname">DownloadSession</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">DownloadSession</span></code> class manipulates download sessions, which are used
|
|||
|
|
to download content from the Content Library Service.</p>
|
|||
|
|
<p>A download session is an object that tracks the download of content (that
|
|||
|
|
is, downloading content from the Content Library Service) and acts as a
|
|||
|
|
lease to keep the download links available.</p>
|
|||
|
|
<p>The <a class="reference internal" href="com.vmware.content.library.item.html#com.vmware.content.library.item.downloadsession_client.File" title="com.vmware.content.library.item.downloadsession_client.File"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library.item.downloadsession_client.File</span></code></a>
|
|||
|
|
class provides access to the download links.</p>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSession.RESOURCE_TYPE">
|
|||
|
|
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.content.library.item.DownloadSession'</em><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Resource type for a download session.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSession.cancel">
|
|||
|
|
<code class="descname">cancel</code><span class="sig-paren">(</span><em>download_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.cancel" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Cancels the download session. This method will abort any ongoing
|
|||
|
|
transfers and invalidate transfer urls that the client may be
|
|||
|
|
downloading from.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>download_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifer of the download session that should be canceled.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if no download session with the given identifier exists.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if the download session is not in the
|
|||
|
|
<a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DownloadSessionModel.State.ACTIVE</span></code></a> state.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSession.create">
|
|||
|
|
<code class="descname">create</code><span class="sig-paren">(</span><em>create_spec</em>, <em>client_token=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.create" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Creates a new download session.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|||
|
|
<li><strong>client_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – A unique token generated by the client for each creation request.
|
|||
|
|
The token should be a universally unique identifier (UUID), for
|
|||
|
|
example: <code class="docutils literal notranslate"><span class="pre">b8a2a2e3-2314-43cd-a871-6ede0f429751</span></code>. This token can
|
|||
|
|
be used to guarantee idempotent creation.
|
|||
|
|
If not specified creation is not idempotent.</li>
|
|||
|
|
<li><strong>create_spec</strong> (<a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSessionModel" title="com.vmware.content.library.item_client.DownloadSessionModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">DownloadSessionModel</span></code></a>) – Specification for the new download session to be created.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Identifier of the new download session being created.
|
|||
|
|
The return value will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if the session specification is not valid.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
format.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the library item targeted by the download does not exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
|
|||
|
|
the attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">DownloadSessionModel.library_item_id</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.DownloadSession</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSession.delete">
|
|||
|
|
<code class="descname">delete</code><span class="sig-paren">(</span><em>download_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.delete" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Deletes a download session. This removes the session and all
|
|||
|
|
information associated with it.</p>
|
|||
|
|
<p>Removing a download session leaves any current transfers for that
|
|||
|
|
session in an indeterminate state (there is no guarantee that the
|
|||
|
|
transfers will be able to complete). However there will no longer be a
|
|||
|
|
means of inspecting the status of those downloads except by seeing the
|
|||
|
|
effect on the library item.</p>
|
|||
|
|
<p>Download sessions for which there is no download activity or which are
|
|||
|
|
complete will automatically be expired and then deleted after a period
|
|||
|
|
of time.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>download_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the download session to be deleted.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the download session does not exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSession.fail">
|
|||
|
|
<code class="descname">fail</code><span class="sig-paren">(</span><em>download_session_id</em>, <em>client_error_message</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.fail" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Terminates the download session with a client specified error message.</p>
|
|||
|
|
<p>This is useful in transmitting client side failures (for example, not
|
|||
|
|
being able to download a file) to the server side.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|||
|
|
<li><strong>download_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the download session to fail.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>.</li>
|
|||
|
|
<li><strong>client_error_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Client side error message. This can be useful in providing some
|
|||
|
|
extra details about the client side failure. Note that the message
|
|||
|
|
won’t be translated to the user’s locale.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the download session does not exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if the download session is not in the
|
|||
|
|
<a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DownloadSessionModel.State.ACTIVE</span></code></a> state.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSession.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>download_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Gets the download session with the specified identifier, including the
|
|||
|
|
most up-to-date status information for the session.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>download_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the download session to retrieve.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSessionModel" title="com.vmware.content.library.item_client.DownloadSessionModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">DownloadSessionModel</span></code></a></p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSessionModel" title="com.vmware.content.library.item_client.DownloadSessionModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">DownloadSessionModel</span></code></a> instance with the given
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">download_session_id</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if no download session with the given <code class="docutils literal notranslate"><span class="pre">download_session_id</span></code>
|
|||
|
|
exists.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSession.keep_alive">
|
|||
|
|
<code class="descname">keep_alive</code><span class="sig-paren">(</span><em>download_session_id</em>, <em>progress=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.keep_alive" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Keeps a download session alive. This operation is allowed only if the
|
|||
|
|
session is in the <a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DownloadSessionModel.State.ACTIVE</span></code></a> state.</p>
|
|||
|
|
<p>If there is no activity for a download session for a certain period of
|
|||
|
|
time, the download session will expire. The download session expiration
|
|||
|
|
timeout is configurable in the Content Library Service system
|
|||
|
|
configuration. The default is five minutes. Invoking this method
|
|||
|
|
enables a client to specifically extend the lifetime of an active
|
|||
|
|
download session.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|||
|
|
<li><strong>download_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the download session whose lifetime should be
|
|||
|
|
extended.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>.</li>
|
|||
|
|
<li><strong>progress</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Optional update to the progress property of the session. If
|
|||
|
|
specified, the new progress should be greater then the current
|
|||
|
|
progress. See <code class="xref py py-attr docutils literal notranslate"><span class="pre">DownloadSessionModel.client_progress</span></code>.
|
|||
|
|
If not specified the progress is not updated.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if no download session with the given identifier exists.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if the download session is not in the
|
|||
|
|
<a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">DownloadSessionModel.State.ACTIVE</span></code></a> state.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSession.list">
|
|||
|
|
<code class="descname">list</code><span class="sig-paren">(</span><em>library_item_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Lists the identifiers of the download sessions created by the calling
|
|||
|
|
user. Optionally may filter by library item.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_item_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Library item identifier on which to filter results.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>.
|
|||
|
|
If not specified all download session identifiers are listed.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSession.list" title="com.vmware.content.library.item_client.DownloadSession.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSession.list" title="com.vmware.content.library.item_client.DownloadSession.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of identifiers of all download sessions created
|
|||
|
|
by the calling user.
|
|||
|
|
The return value will contain identifiers for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if a library item identifier is given for an item which does not
|
|||
|
|
exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.DownloadSession</span></code>
|
|||
|
|
referenced by the parameter <code class="docutils literal notranslate"><span class="pre">library_item_id</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.DownloadSession</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSessionModel">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item_client.</code><code class="descname">DownloadSessionModel</code><span class="sig-paren">(</span><em>id=None</em>, <em>library_item_id=None</em>, <em>library_item_content_version=None</em>, <em>error_message=None</em>, <em>client_progress=None</em>, <em>state=None</em>, <em>expiration_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSessionModel" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">DownloadSessionModel</span></code> class provides information on an active
|
|||
|
|
<a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSession" title="com.vmware.content.library.item_client.DownloadSession"><code class="xref py py-class docutils literal notranslate"><span class="pre">DownloadSession</span></code></a> resource.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSessionModel.State">
|
|||
|
|
<em class="property">class </em><code class="descname">State</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSessionModel.State" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The state of the download session.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="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 <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE">
|
|||
|
|
<code class="descname">ACTIVE</code><em class="property"> = State(string='ACTIVE')</em><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The session is active. Individual files may be in the process of being
|
|||
|
|
transferred and may become ready for download at different times.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSessionModel.State.CANCELED">
|
|||
|
|
<code class="descname">CANCELED</code><em class="property"> = State(string='CANCELED')</em><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.CANCELED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The session has been canceled. On-going downloads may fail. The session
|
|||
|
|
will stay in this state until it is either deleted by the user or
|
|||
|
|
automatically cleaned up by the Content Library Service.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSessionModel.State.ERROR">
|
|||
|
|
<code class="descname">ERROR</code><em class="property"> = State(string='ERROR')</em><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ERROR" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates there was an error during the session lifecycle.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.File">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item_client.</code><code class="descname">File</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">File</span></code> class can be used to query for information on the files within
|
|||
|
|
a library item. Files are objects which are added to a library item through
|
|||
|
|
the <a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSession" title="com.vmware.content.library.item_client.UpdateSession"><code class="xref py py-class docutils literal notranslate"><span class="pre">UpdateSession</span></code></a> and
|
|||
|
|
<a class="reference internal" href="com.vmware.content.library.item.html#com.vmware.content.library.item.updatesession_client.File" title="com.vmware.content.library.item.updatesession_client.File"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library.item.updatesession_client.File</span></code></a> classes.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.File.ChecksumAlgorithm">
|
|||
|
|
<em class="property">class </em><code class="descname">ChecksumAlgorithm</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">File.ChecksumAlgorithm</span></code> class defines the valid checksum algorithms.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="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 <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.File.ChecksumAlgorithm.MD5">
|
|||
|
|
<code class="descname">MD5</code><em class="property"> = ChecksumAlgorithm(string='MD5')</em><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm.MD5" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Checksum algorithm: MD5</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA1">
|
|||
|
|
<code class="descname">SHA1</code><em class="property"> = ChecksumAlgorithm(string='SHA1')</em><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA1" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Checksum algorithm: SHA-1</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.File.ChecksumInfo">
|
|||
|
|
<em class="property">class </em><code class="descname">ChecksumInfo</code><span class="sig-paren">(</span><em>algorithm=None</em>, <em>checksum=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumInfo" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>Provides checksums for a <a class="reference internal" href="#com.vmware.content.library.item_client.File.Info" title="com.vmware.content.library.item_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a> object.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.File.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>checksum_info=None</em>, <em>name=None</em>, <em>size=None</em>, <em>cached=None</em>, <em>version=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">File.Info</span></code> class provides information about a file in Content
|
|||
|
|
Library Service storage.</p>
|
|||
|
|
<p>A file is an actual stored object for a library item. An item will have
|
|||
|
|
zero files initially, but one or more can be uploaded to the item.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.File.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>library_item_id</em>, <em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Retrieves the information for a single file in a library item by its
|
|||
|
|
name.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|||
|
|
<li><strong>library_item_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the library item whose file information should be
|
|||
|
|
returned.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</li>
|
|||
|
|
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the file in the library item whose information should be
|
|||
|
|
returned.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content.library.item_client.File.Info" title="com.vmware.content.library.item_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a></p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content.library.item_client.File.Info" title="com.vmware.content.library.item_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a> object with information on the specified
|
|||
|
|
file.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">library_item_id</span></code> refers to a library item that does not
|
|||
|
|
exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">name</span></code> refers to a file that does not exist in the library
|
|||
|
|
item.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
|
|||
|
|
the parameter <code class="docutils literal notranslate"><span class="pre">library_item_id</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.File.list">
|
|||
|
|
<code class="descname">list</code><span class="sig-paren">(</span><em>library_item_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.File.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Lists all of the files that are stored within a given library item.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_item_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the library item whose files should be listed.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content.library.item_client.File.list" title="com.vmware.content.library.item_client.File.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.content.library.item_client.File.Info" title="com.vmware.content.library.item_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a></p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content.library.item_client.File.list" title="com.vmware.content.library.item_client.File.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of all of the files that are stored within the
|
|||
|
|
given library item.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if <code class="docutils literal notranslate"><span class="pre">library_item_id</span></code> refers to a library item that does not
|
|||
|
|
exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
|
|||
|
|
the parameter <code class="docutils literal notranslate"><span class="pre">library_item_id</span></code> requires <code class="docutils literal notranslate"><span class="pre">System.Read</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.Storage">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item_client.</code><code class="descname">Storage</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Storage" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p><code class="docutils literal notranslate"><span class="pre">Storage</span></code> is a resource that represents a specific instance of a file
|
|||
|
|
stored on a storage backing. Unlike <a class="reference internal" href="#com.vmware.content.library.item_client.File" title="com.vmware.content.library.item_client.File"><code class="xref py py-class docutils literal notranslate"><span class="pre">File</span></code></a>, which is abstract,
|
|||
|
|
storage represents concrete files on the various storage backings. A file
|
|||
|
|
is only represented once in <a class="reference internal" href="#com.vmware.content.library.item_client.File" title="com.vmware.content.library.item_client.File"><code class="xref py py-class docutils literal notranslate"><span class="pre">File</span></code></a>, but will be represented multiple
|
|||
|
|
times (once for each storage backing) in <code class="docutils literal notranslate"><span class="pre">Storage</span></code>. The <code class="docutils literal notranslate"><span class="pre">Storage</span></code> class
|
|||
|
|
provides information on the storage backing and the specific location of
|
|||
|
|
the file in that backing to privileged users who want direct access to the
|
|||
|
|
file on the storage medium.</p>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.Storage.Info">
|
|||
|
|
<em class="property">class </em><code class="descname">Info</code><span class="sig-paren">(</span><em>storage_backing=None</em>, <em>storage_uris=None</em>, <em>checksum_info=None</em>, <em>name=None</em>, <em>size=None</em>, <em>cached=None</em>, <em>version=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Storage.Info" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">Storage.Info</span></code> class is the expanded form of <a class="reference internal" href="#com.vmware.content.library.item_client.File.Info" title="com.vmware.content.library.item_client.File.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">File.Info</span></code></a> that
|
|||
|
|
includes details about the storage backing for a file in a library item.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.Storage.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>library_item_id</em>, <em>file_name</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Storage.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Retrieves the storage information for a specific file in a library
|
|||
|
|
item.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|||
|
|
<li><strong>library_item_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the library item whose storage information should be
|
|||
|
|
retrieved.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</li>
|
|||
|
|
<li><strong>file_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Name of the file for which the storage information should be
|
|||
|
|
listed.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content.library.item_client.Storage.list" title="com.vmware.content.library.item_client.Storage.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.content.library.item_client.Storage.Info" title="com.vmware.content.library.item_client.Storage.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Storage.Info</span></code></a></p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content.library.item_client.Storage.list" title="com.vmware.content.library.item_client.Storage.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of all the storage items for the given file
|
|||
|
|
within the given library item.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the specified library item does not exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the specified file does not exist in the given library item.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
|
|||
|
|
the parameter <code class="docutils literal notranslate"><span class="pre">library_item_id</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.ReadStorage</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.Storage.list">
|
|||
|
|
<code class="descname">list</code><span class="sig-paren">(</span><em>library_item_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.Storage.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Lists all storage items for a given library item.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_item_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the library item whose storage information should be
|
|||
|
|
listed.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content.library.item_client.Storage.list" title="com.vmware.content.library.item_client.Storage.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="#com.vmware.content.library.item_client.Storage.Info" title="com.vmware.content.library.item_client.Storage.Info"><code class="xref py py-class docutils literal notranslate"><span class="pre">Storage.Info</span></code></a></p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content.library.item_client.Storage.list" title="com.vmware.content.library.item_client.Storage.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of all storage items for a given library item.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the specified library item does not exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
|
|||
|
|
the parameter <code class="docutils literal notranslate"><span class="pre">library_item_id</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.ReadStorage</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.StubFactory">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.StubFactory" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.TransferEndpoint">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item_client.</code><code class="descname">TransferEndpoint</code><span class="sig-paren">(</span><em>uri=None</em>, <em>ssl_certificate_thumbprint=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.TransferEndpoint" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">TransferEndpoint</span></code> class encapsulates a URI along with extra
|
|||
|
|
information about it.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.TransferStatus">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item_client.</code><code class="descname">TransferStatus</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">TransferStatus</span></code> class defines the transfer state of a file.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="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 <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.TransferStatus.ERROR">
|
|||
|
|
<code class="descname">ERROR</code><em class="property"> = TransferStatus(string='ERROR')</em><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus.ERROR" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates that there was an error transferring or validating the file.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.TransferStatus.READY">
|
|||
|
|
<code class="descname">READY</code><em class="property"> = TransferStatus(string='READY')</em><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus.READY" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates that the file has been fully transferred and is ready to be used.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.TransferStatus.TRANSFERRING">
|
|||
|
|
<code class="descname">TRANSFERRING</code><em class="property"> = TransferStatus(string='TRANSFERRING')</em><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus.TRANSFERRING" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates that data is being transferred to the file.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.TransferStatus.VALIDATING">
|
|||
|
|
<code class="descname">VALIDATING</code><em class="property"> = TransferStatus(string='VALIDATING')</em><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus.VALIDATING" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates that the file is being validated (checksum, type adapters).</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.TransferStatus.WAITING_FOR_TRANSFER">
|
|||
|
|
<code class="descname">WAITING_FOR_TRANSFER</code><em class="property"> = TransferStatus(string='WAITING_FOR_TRANSFER')</em><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus.WAITING_FOR_TRANSFER" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Indicates that a file has been defined for a library item and its content
|
|||
|
|
needs to be uploaded.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSession">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item_client.</code><code class="descname">UpdateSession</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">UpdateSession</span></code> class manipulates sessions that are used to upload
|
|||
|
|
content into the Content Library Service, and/or to remove files from a
|
|||
|
|
library item.</p>
|
|||
|
|
<p>An update session is a resource which tracks changes to content. An update
|
|||
|
|
session is created with a set of files that are intended to be uploaded to
|
|||
|
|
a specific <a class="reference internal" href="com.vmware.content.html#com.vmware.content.library_client.ItemModel" title="com.vmware.content.library_client.ItemModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library_client.ItemModel</span></code></a>, or removed
|
|||
|
|
from an item. The session object can be used to track the uploads and
|
|||
|
|
inspect the changes that are being made to the item by that upload. It can
|
|||
|
|
also serve as a channel to check on the result of the upload, and status
|
|||
|
|
messages such as errors and warnings for the upload.</p>
|
|||
|
|
<p>Modifications are not visible to other clients unless the session is
|
|||
|
|
completed and all necessary files have been received.</p>
|
|||
|
|
<p>The management of the files within the session is done through the
|
|||
|
|
<a class="reference internal" href="com.vmware.content.library.item.html#com.vmware.content.library.item.updatesession_client.File" title="com.vmware.content.library.item.updatesession_client.File"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.content.library.item.updatesession_client.File</span></code></a> class.</p>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSession.RESOURCE_TYPE">
|
|||
|
|
<code class="descname">RESOURCE_TYPE</code><em class="property"> = 'com.vmware.content.library.item.UpdateSession'</em><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.RESOURCE_TYPE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Resource type for an update session.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSession.cancel">
|
|||
|
|
<code class="descname">cancel</code><span class="sig-paren">(</span><em>update_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.cancel" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Cancels the update session and sets its state to
|
|||
|
|
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.CANCELED" title="com.vmware.content.library.item_client.UpdateSessionModel.State.CANCELED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.State.CANCELED</span></code></a>. This method will free up any
|
|||
|
|
temporary resources currently associated with the session.</p>
|
|||
|
|
<blockquote>
|
|||
|
|
<div>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>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>update_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the update session that should be canceled.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if no update session with the given identifier exists.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if the update session is not in the
|
|||
|
|
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.State.ACTIVE</span></code></a> state.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSession.complete">
|
|||
|
|
<code class="descname">complete</code><span class="sig-paren">(</span><em>update_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.complete" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Completes the update session. This indicates that the client has
|
|||
|
|
finished making all the changes required to the underlying library
|
|||
|
|
item. If the client is pushing the content to the server, the library
|
|||
|
|
item will be updated once this call returns. If the server is pulling
|
|||
|
|
the content, the call may return before the changes become visible. In
|
|||
|
|
that case, the client can track the session to know when the server is
|
|||
|
|
done.</p>
|
|||
|
|
<p>This method requires the session to be in the
|
|||
|
|
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.State.ACTIVE</span></code></a> state.</p>
|
|||
|
|
<p>Depending on the type of the library item associated with this session,
|
|||
|
|
a type adapter may be invoked to verify the validity of the files
|
|||
|
|
uploaded. The user can explicitly validate the session before
|
|||
|
|
completing the session by using the
|
|||
|
|
<a class="reference internal" href="com.vmware.content.library.item.html#com.vmware.content.library.item.updatesession_client.File.validate" title="com.vmware.content.library.item.updatesession_client.File.validate"><code class="xref py py-func docutils literal notranslate"><span class="pre">com.vmware.content.library.item.updatesession_client.File.validate()</span></code></a>
|
|||
|
|
method.</p>
|
|||
|
|
<p>Modifications are not visible to other clients unless the session is
|
|||
|
|
completed and all necessary files have been received.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>update_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the update session that should be completed.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if no update session with the given identifier exists.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if the update session is not in the
|
|||
|
|
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.State.ACTIVE</span></code></a> state, or if some of the
|
|||
|
|
files that will be uploaded by the client aren’t received
|
|||
|
|
correctly.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSession.create">
|
|||
|
|
<code class="descname">create</code><span class="sig-paren">(</span><em>create_spec</em>, <em>client_token=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.create" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Creates a new update session. An update session is used to make
|
|||
|
|
modifications to a library item. Modifications are not visible to other
|
|||
|
|
clients unless the session is completed and all necessary files have
|
|||
|
|
been received.</p>
|
|||
|
|
<p>Content Library Service allows only one single update session to be
|
|||
|
|
active for a specific library item.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|||
|
|
<li><strong>client_token</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Unique token generated by the client for each creation request. The
|
|||
|
|
token should be a universally unique identifier (UUID), for
|
|||
|
|
example: <code class="docutils literal notranslate"><span class="pre">b8a2a2e3-2314-43cd-a871-6ede0f429751</span></code>. This token can
|
|||
|
|
be used to guarantee idempotent creation.
|
|||
|
|
If not specified creation is not idempotent.</li>
|
|||
|
|
<li><strong>create_spec</strong> (<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel" title="com.vmware.content.library.item_client.UpdateSessionModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">UpdateSessionModel</span></code></a>) – Specification for the new update session to be created.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Identifier of the new update session being created.
|
|||
|
|
The return value will be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if the session specification is not valid.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></code>
|
|||
|
|
if the <code class="docutils literal notranslate"><span class="pre">client_token</span></code> does not conform to the UUID format.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></code>
|
|||
|
|
if the update session is being created on a subscribed library
|
|||
|
|
item.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the item targeted for update does not exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></code>
|
|||
|
|
if there is another update session on the same library item.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.Item</span></code> referenced by
|
|||
|
|
the attribute <code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.library_item_id</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.UpdateSession</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSession.delete">
|
|||
|
|
<code class="descname">delete</code><span class="sig-paren">(</span><em>update_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.delete" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Deletes an update session. This removes the session and all information
|
|||
|
|
associated with it.</p>
|
|||
|
|
<p>Removing an update session leaves any current transfers for that
|
|||
|
|
session in an indeterminate state (there is no guarantee that the
|
|||
|
|
server will terminate the transfers, or that the transfers can be
|
|||
|
|
completed). However there will no longer be a means of inspecting the
|
|||
|
|
status of those uploads except by seeing the effect on the library
|
|||
|
|
item.</p>
|
|||
|
|
<p>Update sessions for which there is no upload activity or which are
|
|||
|
|
complete will automatically be deleted after a period of time.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>update_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifer of the update session to delete.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the update session does not exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if the update session is in the
|
|||
|
|
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.State.ACTIVE</span></code></a> state.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSession.fail">
|
|||
|
|
<code class="descname">fail</code><span class="sig-paren">(</span><em>update_session_id</em>, <em>client_error_message</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.fail" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Terminates the update session with a client specified error message.</p>
|
|||
|
|
<p>This is useful in transmitting client side failures (for example, not
|
|||
|
|
being able to access a file) to the server side.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|||
|
|
<li><strong>update_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the update session to fail.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</li>
|
|||
|
|
<li><strong>client_error_message</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Client side error message. This can be useful in providing some
|
|||
|
|
extra details about the client side failure. Note that the message
|
|||
|
|
won’t be translated to the user’s locale.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if the update session does not exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if the update session is not in the
|
|||
|
|
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.State.ACTIVE</span></code></a> state.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSession.get">
|
|||
|
|
<code class="descname">get</code><span class="sig-paren">(</span><em>update_session_id</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.get" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Gets the update session with the specified identifier, including the
|
|||
|
|
most up-to-date status information for the session.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>update_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the update session to retrieve.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel" title="com.vmware.content.library.item_client.UpdateSessionModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">UpdateSessionModel</span></code></a></p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel" title="com.vmware.content.library.item_client.UpdateSessionModel"><code class="xref py py-class docutils literal notranslate"><span class="pre">UpdateSessionModel</span></code></a> instance with the given
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">update_session_id</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if no update session with the given identifier exists.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSession.keep_alive">
|
|||
|
|
<code class="descname">keep_alive</code><span class="sig-paren">(</span><em>update_session_id</em>, <em>client_progress=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.keep_alive" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Keeps an update session alive.</p>
|
|||
|
|
<p>If there is no activity for an update session after a period of time,
|
|||
|
|
the update session will expire, then be deleted. The update session
|
|||
|
|
expiration timeout is configurable in the Content Library Service
|
|||
|
|
system configuration. The default is five minutes. Invoking this method
|
|||
|
|
enables a client to specifically extend the lifetime of the update
|
|||
|
|
session.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
|||
|
|
<li><strong>update_session_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Identifier of the update session whose lifetime should be extended.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</li>
|
|||
|
|
<li><strong>client_progress</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Optional update to the progress property of the session. If
|
|||
|
|
specified, the new progress should be greater then the current
|
|||
|
|
progress. See <code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.client_progress</span></code>.
|
|||
|
|
If not specified the progress is not updated.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if no update session with the given identifier exists.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></code>
|
|||
|
|
if the update session is not in the
|
|||
|
|
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">UpdateSessionModel.State.ACTIVE</span></code></a> state.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>Method execution requires <code class="docutils literal notranslate"><span class="pre">System.Anonymous</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="method">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSession.list">
|
|||
|
|
<code class="descname">list</code><span class="sig-paren">(</span><em>library_item_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession.list" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Lists the identifiers of the update session created by the calling
|
|||
|
|
user. Optionally may filter by library item.</p>
|
|||
|
|
<table class="docutils field-list" frame="void" rules="none">
|
|||
|
|
<col class="field-name" />
|
|||
|
|
<col class="field-body" />
|
|||
|
|
<tbody valign="top">
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>library_item_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Optional library item identifier on which to filter results.
|
|||
|
|
The parameter must be an identifier for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.
|
|||
|
|
If not specified the results are not filtered.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSession.list" title="com.vmware.content.library.item_client.UpdateSession.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The <a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSession.list" title="com.vmware.content.library.item_client.UpdateSession.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of identifiers of all update sessions created by
|
|||
|
|
the calling user.
|
|||
|
|
The return value will contain identifiers for the resource type:
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-even field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
|
|||
|
|
if a library item identifier is given for an item which does not
|
|||
|
|
exist.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="field-odd field"><th class="field-name">Raise:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
|
|||
|
|
if you do not have all of the privileges described as follows:</p>
|
|||
|
|
<ul class="last simple">
|
|||
|
|
<li>The resource <code class="docutils literal notranslate"><span class="pre">com.vmware.content.library.item.UpdateSession</span></code>
|
|||
|
|
referenced by the parameter <code class="docutils literal notranslate"><span class="pre">library_item_id</span></code> requires
|
|||
|
|
<code class="docutils literal notranslate"><span class="pre">ContentLibrary.UpdateSession</span></code>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSessionModel">
|
|||
|
|
<em class="property">class </em><code class="descclassname">com.vmware.content.library.item_client.</code><code class="descname">UpdateSessionModel</code><span class="sig-paren">(</span><em>id=None</em>, <em>library_item_id=None</em>, <em>library_item_content_version=None</em>, <em>error_message=None</em>, <em>client_progress=None</em>, <em>state=None</em>, <em>expiration_time=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
|
|||
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">UpdateSessionModel</span></code> class provides information on an active
|
|||
|
|
<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSession" title="com.vmware.content.library.item_client.UpdateSession"><code class="xref py py-class docutils literal notranslate"><span class="pre">UpdateSession</span></code></a> resource.</p>
|
|||
|
|
<div class="admonition tip">
|
|||
|
|
<p class="first admonition-title">Tip</p>
|
|||
|
|
<p class="last">The arguments are used to initialize data attributes with the same
|
|||
|
|
names.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="class">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSessionModel.State">
|
|||
|
|
<em class="property">class </em><code class="descname">State</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel.State" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.enum.Enum</span></code></p>
|
|||
|
|
<p>The state of an update session.</p>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="first admonition-title">Note</p>
|
|||
|
|
<p class="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 <a class="reference internal" href="enumeration.html#enumeration-description"><span class="std std-ref">enumerated
|
|||
|
|
type description page</span></a>.</p>
|
|||
|
|
</div>
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE">
|
|||
|
|
<code class="descname">ACTIVE</code><em class="property"> = State(string='ACTIVE')</em><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The session is currently active. This is the initial state when the session
|
|||
|
|
is created. Files may be uploaded by the client or pulled by the Content
|
|||
|
|
Library Service at this stage.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSessionModel.State.CANCELED">
|
|||
|
|
<code class="descname">CANCELED</code><em class="property"> = State(string='CANCELED')</em><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.CANCELED" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The session has been canceled.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSessionModel.State.DONE">
|
|||
|
|
<code class="descname">DONE</code><em class="property"> = State(string='DONE')</em><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.DONE" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>The session is done and all its effects are now visible.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
<dl class="attribute">
|
|||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSessionModel.State.ERROR">
|
|||
|
|
<code class="descname">ERROR</code><em class="property"> = State(string='ERROR')</em><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ERROR" title="Permalink to this definition">¶</a></dt>
|
|||
|
|
<dd><p>There was an error during the session.</p>
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</dd></dl>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div class="articleComments">
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<footer>
|
|||
|
|
|
|||
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|||
|
|
|
|||
|
|
<a href="com.vmware.content.library.item.html" class="btn btn-neutral float-right" title="com.vmware.content.library.item package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="com.vmware.content.html" class="btn btn-neutral" title="com.vmware.content package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>
|
|||
|
|
© Copyright 2018, VMware, Inc..
|
|||
|
|
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|||
|
|
|
|||
|
|
</footer>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
var DOCUMENTATION_OPTIONS = {
|
|||
|
|
URL_ROOT:'./',
|
|||
|
|
VERSION:'6.7.0',
|
|||
|
|
COLLAPSE_INDEX:false,
|
|||
|
|
FILE_SUFFIX:'.html',
|
|||
|
|
HAS_SOURCE: true,
|
|||
|
|
SOURCELINK_SUFFIX: '.txt'
|
|||
|
|
};
|
|||
|
|
</script>
|
|||
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|||
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
|||
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
jQuery(function () {
|
|||
|
|
SphinxRtdTheme.StickyNav.enable();
|
|||
|
|
});
|
|||
|
|
</script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|