mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-22 17:39:59 -05:00
1575 lines
131 KiB
HTML
1575 lines
131 KiB
HTML
|
|
||
|
|
|
||
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
|
||
|
|
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
|
||
|
|
<title>library Package — vCloud Suite SDK for Python 6.0.0 documentation</title>
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="_static/vapitheme.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
var DOCUMENTATION_OPTIONS = {
|
||
|
|
URL_ROOT: '',
|
||
|
|
VERSION: '6.0.0',
|
||
|
|
COLLAPSE_INDEX: false,
|
||
|
|
FILE_SUFFIX: '.html',
|
||
|
|
HAS_SOURCE: true
|
||
|
|
};
|
||
|
|
</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>
|
||
|
|
<link rel="top" title="vCloud Suite SDK for Python 6.0.0 documentation" href="index.html" />
|
||
|
|
<link rel="up" title="content Package" href="com.vmware.content.html" />
|
||
|
|
<link rel="next" title="item Package" href="com.vmware.content.library.item.html" />
|
||
|
|
<link rel="prev" title="content Package" href="com.vmware.content.html" />
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div class="related">
|
||
|
|
<h3>Navigation</h3>
|
||
|
|
<ul>
|
||
|
|
<li class="right" style="margin-right: 10px">
|
||
|
|
<a href="genindex.html" title="General Index"
|
||
|
|
accesskey="I">index</a></li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="py-modindex.html" title="Python Module Index"
|
||
|
|
>modules</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.content.library.item.html" title="item Package"
|
||
|
|
accesskey="N">next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.content.html" title="content Package"
|
||
|
|
accesskey="P">previous</a> |</li>
|
||
|
|
<li><a href="index.html">vCloud Suite SDK for Python 6.0.0 documentation</a> »</li>
|
||
|
|
<li><a href="com.html" >com Package</a> »</li>
|
||
|
|
<li><a href="com.vmware.html" >vmware Package</a> »</li>
|
||
|
|
<li><a href="com.vmware.content.html" accesskey="U">content Package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="document">
|
||
|
|
<div class="documentwrapper">
|
||
|
|
<div class="bodywrapper">
|
||
|
|
<div class="body">
|
||
|
|
|
||
|
|
<div class="section" id="library-package">
|
||
|
|
<h1>library Package<a class="headerlink" href="#library-package" title="Permalink to this headline">¶</a></h1>
|
||
|
|
<div class="section" id="id1">
|
||
|
|
<h2><tt class="xref py py-mod docutils literal"><span class="pre">library</span></tt> Package<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
|
||
|
|
<span class="target" id="module-com.vmware.content.library"></span></div>
|
||
|
|
<div class="section" id="module-com.vmware.content.library.item_client">
|
||
|
|
<span id="item-client-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">item_client</span></tt> 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><tt class="descclassname">com.vmware.content.library.item_client.</tt><tt class="descname">DownloadSession</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#DownloadSession"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSession" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.VapiInterface" title="vmware.vapi.bindings.stub.VapiInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">DownloadSession</span></tt> 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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content.library.item.downloadsession_client.File</span></tt></a>
|
||
|
|
class provides access to the download links.</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"><strong>config</strong> (<a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.StubConfiguration" title="vmware.vapi.bindings.stub.StubConfiguration"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt></a>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSession.RESOURCE_TYPE">
|
||
|
|
<tt class="descname">RESOURCE_TYPE</tt><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">
|
||
|
|
<tt class="descname">cancel</tt><big>(</big><em>download_session_id</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#DownloadSession.cancel"><span class="viewcode-link">[source]</span></a><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifer of the download session that should be canceled.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.DownloadSession</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt></a>
|
||
|
|
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"><tt class="xref py py-attr docutils literal"><span class="pre">DownloadSessionModel.State.ACTIVE</span></tt></a> state.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Anonymous</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSession.create">
|
||
|
|
<tt class="descname">create</tt><big>(</big><em>create_spec</em>, <em>client_token=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#DownloadSession.create"><span class="viewcode-link">[source]</span></a><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – A unique token generated by the client for each creation request.
|
||
|
|
The token should be a universally unique identifier (UUID), for
|
||
|
|
example: <tt class="docutils literal"><span class="pre">b8a2a2e3-2314-43cd-a871-6ede0f429751</span></tt>. 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"><tt class="xref py py-class docutils literal"><span class="pre">DownloadSessionModel</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></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:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.DownloadSession</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt></a>
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt></a>
|
||
|
|
format.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt> referenced by
|
||
|
|
the attribute <tt class="xref py py-attr docutils literal"><span class="pre">DownloadSessionModel.library_item_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">ContentLibrary.DownloadSession</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSession.delete">
|
||
|
|
<tt class="descname">delete</tt><big>(</big><em>download_session_id</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#DownloadSession.delete"><span class="viewcode-link">[source]</span></a><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the download session to be deleted.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.DownloadSession</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Anonymous</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSession.fail">
|
||
|
|
<tt class="descname">fail</tt><big>(</big><em>download_session_id</em>, <em>client_error_message</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#DownloadSession.fail"><span class="viewcode-link">[source]</span></a><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the download session to fail.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.DownloadSession</span></tt>.</li>
|
||
|
|
<li><strong>client_error_message</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – 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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt></a>
|
||
|
|
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"><tt class="xref py py-attr docutils literal"><span class="pre">DownloadSessionModel.State.ACTIVE</span></tt></a> state.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Anonymous</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSession.get">
|
||
|
|
<tt class="descname">get</tt><big>(</big><em>download_session_id</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#DownloadSession.get"><span class="viewcode-link">[source]</span></a><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the download session to retrieve.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.DownloadSession</span></tt>.</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"><tt class="xref py py-class docutils literal"><span class="pre">DownloadSessionModel</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">DownloadSessionModel</span></tt></a> instance with the given
|
||
|
|
<tt class="docutils literal"><span class="pre">download_session_id</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
if no download session with the given <tt class="docutils literal"><span class="pre">download_session_id</span></tt>
|
||
|
|
exists.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Anonymous</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSession.keep_alive">
|
||
|
|
<tt class="descname">keep_alive</tt><big>(</big><em>download_session_id</em>, <em>progress=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#DownloadSession.keep_alive"><span class="viewcode-link">[source]</span></a><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"><tt class="xref py py-attr docutils literal"><span class="pre">DownloadSessionModel.State.ACTIVE</span></tt></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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the download session whose lifetime should be
|
||
|
|
extended.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.DownloadSession</span></tt>.</li>
|
||
|
|
<li><strong>progress</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Optional update to the progress property of the session. If
|
||
|
|
specified, the new progress should be greater then the current
|
||
|
|
progress. See <tt class="xref py py-attr docutils literal"><span class="pre">DownloadSessionModel.client_progress</span></tt>.
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt></a>
|
||
|
|
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"><tt class="xref py py-attr docutils literal"><span class="pre">DownloadSessionModel.State.ACTIVE</span></tt></a> state.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Anonymous</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSession.list">
|
||
|
|
<tt class="descname">list</tt><big>(</big><em>library_item_id=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#DownloadSession.list"><span class="viewcode-link">[source]</span></a><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Library item identifier on which to filter results.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.DownloadSession</span></tt>.
|
||
|
|
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"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of identifiers of all download sessions created
|
||
|
|
by the calling user.
|
||
|
|
The return value will contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.DownloadSession</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.library.item.DownloadSession</span></tt>
|
||
|
|
referenced by the parameter <tt class="docutils literal"><span class="pre">library_item_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">ContentLibrary.DownloadSession</span></tt>.</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><tt class="descclassname">com.vmware.content.library.item_client.</tt><tt class="descname">DownloadSessionModel</tt><big>(</big><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><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#DownloadSessionModel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSessionModel" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">DownloadSessionModel</span></tt> 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"><tt class="xref py py-class docutils literal"><span class="pre">DownloadSession</span></tt></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>
|
||
|
|
<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 last simple">
|
||
|
|
<li><strong>id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of this download session.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.DownloadSession</span></tt>. When methods
|
||
|
|
return a value of this class as a return value, the attribute will
|
||
|
|
be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.DownloadSession</span></tt>.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will not
|
||
|
|
be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt> methods.
|
||
|
|
It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>library_item_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the library item whose content is being
|
||
|
|
downloaded.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>. When methods return a value of
|
||
|
|
this class as a return value, the attribute will be an identifier
|
||
|
|
for the resource type: <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.
|
||
|
|
This attribute must be provided for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>library_item_content_version</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The content version of the library item whose content is being
|
||
|
|
downloaded. This value is the
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">com.vmware.content.library_client.ItemModel.content_version</span></tt>
|
||
|
|
at the time when the session is created for the library item.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>error_message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></tt></a>) – If the session is in the <a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSessionModel.State.ERROR" title="com.vmware.content.library.item_client.DownloadSessionModel.State.ERROR"><tt class="xref py py-attr docutils literal"><span class="pre">DownloadSessionModel.State.ERROR</span></tt></a>
|
||
|
|
status this property will have more details about the error.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It is
|
||
|
|
optional in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt> methods. It
|
||
|
|
is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>client_progress</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – The progress that has been made with the download. This property is
|
||
|
|
to be updated by the client during the download process to indicate
|
||
|
|
the progress of its work in completing the download. The initial
|
||
|
|
progress is 0 until updated by the client. The maximum value is
|
||
|
|
100, which indicates that the download is complete.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is optional for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>state</strong> (<a class="reference internal" href="#com.vmware.content.library.item_client.DownloadSessionModel.State" title="com.vmware.content.library.item_client.DownloadSessionModel.State"><tt class="xref py py-class docutils literal"><span class="pre">DownloadSessionModel.State</span></tt></a>) – The current state (ACTIVE, CANCELED, ERROR) of the download
|
||
|
|
session.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>expiration_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt>) – Indicates the time after which the session will expire. The session
|
||
|
|
is guaranteed not to expire before this time.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSessionModel.State">
|
||
|
|
<em class="property">class </em><tt class="descname">State</tt><big>(</big><em>string</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#DownloadSessionModel.State"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.content.library.item_client.DownloadSessionModel.State" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.enum.Enum" title="vmware.vapi.bindings.enum.Enum"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></a></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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<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"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">State</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content.library.item_client.DownloadSessionModel.State.ACTIVE">
|
||
|
|
<tt class="descname">ACTIVE</tt><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">
|
||
|
|
<tt class="descname">CANCELED</tt><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">
|
||
|
|
<tt class="descname">ERROR</tt><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><tt class="descclassname">com.vmware.content.library.item_client.</tt><tt class="descname">File</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#File"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.content.library.item_client.File" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.VapiInterface" title="vmware.vapi.bindings.stub.VapiInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">File</span></tt> 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"><tt class="xref py py-class docutils literal"><span class="pre">UpdateSession</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content.library.item.updatesession_client.File</span></tt></a> classes.</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"><strong>config</strong> (<a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.StubConfiguration" title="vmware.vapi.bindings.stub.StubConfiguration"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt></a>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content.library.item_client.File.ChecksumAlgorithm">
|
||
|
|
<em class="property">class </em><tt class="descname">ChecksumAlgorithm</tt><big>(</big><em>string</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#File.ChecksumAlgorithm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.enum.Enum" title="vmware.vapi.bindings.enum.Enum"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">File.ChecksumAlgorithm</span></tt> 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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<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"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">ChecksumAlgorithm</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content.library.item_client.File.ChecksumAlgorithm.MD5">
|
||
|
|
<tt class="descname">MD5</tt><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">
|
||
|
|
<tt class="descname">SHA1</tt><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><tt class="descclassname">File.</tt><tt class="descname">ChecksumInfo</tt><big>(</big><em>algorithm=None</em>, <em>checksum=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#File.ChecksumInfo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.content.library.item_client.File.ChecksumInfo" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></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"><tt class="xref py py-class docutils literal"><span class="pre">File.Info</span></tt></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>
|
||
|
|
<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 last simple">
|
||
|
|
<li><strong>algorithm</strong> (<a class="reference internal" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm" title="com.vmware.content.library.item_client.File.ChecksumAlgorithm"><tt class="xref py py-class docutils literal"><span class="pre">File.ChecksumAlgorithm</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – The checksum algorithm (SHA1, MD5) used to calculate the checksum.
|
||
|
|
If not specified the default checksum algorithm is
|
||
|
|
<a class="reference internal" href="#com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA1" title="com.vmware.content.library.item_client.File.ChecksumAlgorithm.SHA1"><tt class="xref py py-attr docutils literal"><span class="pre">File.ChecksumAlgorithm.SHA1</span></tt></a>.</li>
|
||
|
|
<li><strong>checksum</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The checksum value calculated with
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">File.ChecksumInfo.algorithm</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content.library.item_client.File.Info">
|
||
|
|
<em class="property">class </em><tt class="descclassname">File.</tt><tt class="descname">Info</tt><big>(</big><em>checksum_info=None</em>, <em>name=None</em>, <em>size=None</em>, <em>cached=None</em>, <em>version=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#File.Info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.content.library.item_client.File.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">File.Info</span></tt> 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>
|
||
|
|
<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 last simple">
|
||
|
|
<li><strong>checksum_info</strong> (<a class="reference internal" href="#com.vmware.content.library.item_client.File.ChecksumInfo" title="com.vmware.content.library.item_client.File.ChecksumInfo"><tt class="xref py py-class docutils literal"><span class="pre">File.ChecksumInfo</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>A checksum for validating the content of the file.</p>
|
||
|
|
<p>This value can be used to verify that a transfer was completed
|
||
|
|
without errors.
|
||
|
|
A checksum cannot always be calculated, and the value will be None
|
||
|
|
if the file does not have content.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <p>The name of the file.</p>
|
||
|
|
<p>This value will be unique within the library item for each file. It
|
||
|
|
cannot be an empty string.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>size</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – The file size, in bytes. The file size is the storage used and not
|
||
|
|
the uploaded or provisioned size. For example, when uploading a
|
||
|
|
disk to a datastore, the amount of storage that the disk consumes
|
||
|
|
may be different from the disk file size. When the file is not
|
||
|
|
cached, the size is 0.</li>
|
||
|
|
<li><strong>cached</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Indicates whether the file is on disk or not.</li>
|
||
|
|
<li><strong>version</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The version of this file; incremented when a new copy of the file
|
||
|
|
is uploaded.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library.item_client.File.get">
|
||
|
|
<tt class="descclassname">File.</tt><tt class="descname">get</tt><big>(</big><em>library_item_id</em>, <em>name</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#File.get"><span class="viewcode-link">[source]</span></a><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the library item whose file information should be
|
||
|
|
returned.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.</li>
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – 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"><tt class="xref py py-class docutils literal"><span class="pre">File.Info</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">File.Info</span></tt></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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
if <tt class="docutils literal"><span class="pre">library_item_id</span></tt> 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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
if <tt class="docutils literal"><span class="pre">name</span></tt> 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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt> referenced by
|
||
|
|
the parameter <tt class="docutils literal"><span class="pre">library_item_id</span></tt> requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library.item_client.File.list">
|
||
|
|
<tt class="descclassname">File.</tt><tt class="descname">list</tt><big>(</big><em>library_item_id</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#File.list"><span class="viewcode-link">[source]</span></a><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the library item whose files should be listed.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.</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"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.content.library.item_client.File.Info" title="com.vmware.content.library.item_client.File.Info"><tt class="xref py py-class docutils literal"><span class="pre">File.Info</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
if <tt class="docutils literal"><span class="pre">library_item_id</span></tt> 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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt> referenced by
|
||
|
|
the parameter <tt class="docutils literal"><span class="pre">library_item_id</span></tt> requires <tt class="docutils literal"><span class="pre">System.Read</span></tt>.</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><tt class="descclassname">com.vmware.content.library.item_client.</tt><tt class="descname">Storage</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#Storage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.content.library.item_client.Storage" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.VapiInterface" title="vmware.vapi.bindings.stub.VapiInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></a></p>
|
||
|
|
<p><tt class="docutils literal"><span class="pre">Storage</span></tt> 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"><tt class="xref py py-class docutils literal"><span class="pre">File</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">File</span></tt></a>, but will be represented multiple
|
||
|
|
times (once for each storage backing) in <tt class="docutils literal"><span class="pre">Storage</span></tt>. The <tt class="docutils literal"><span class="pre">Storage</span></tt> 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>
|
||
|
|
<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"><strong>config</strong> (<a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.StubConfiguration" title="vmware.vapi.bindings.stub.StubConfiguration"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt></a>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content.library.item_client.Storage.Info">
|
||
|
|
<em class="property">class </em><tt class="descname">Info</tt><big>(</big><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><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#Storage.Info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.content.library.item_client.Storage.Info" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">Storage.Info</span></tt> 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"><tt class="xref py py-class docutils literal"><span class="pre">File.Info</span></tt></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>
|
||
|
|
<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 last simple">
|
||
|
|
<li><strong>storage_backing</strong> (<a class="reference internal" href="com.vmware.content.html#com.vmware.content.library_client.StorageBacking" title="com.vmware.content.library_client.StorageBacking"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content.library_client.StorageBacking</span></tt></a>) – The storage backing on which this object resides.</li>
|
||
|
|
<li><strong>storage_uris</strong> (<tt class="xref py py-class docutils literal"><span class="pre">list</span></tt> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <p>URIs that identify the file on the storage backing.</p>
|
||
|
|
<p>These URIs may be specific to the backing and may need
|
||
|
|
interpretation by the client. A client that understands a URI
|
||
|
|
scheme in this list may use that URI to directly access the file on
|
||
|
|
the storage backing. This can provide high-performance support for
|
||
|
|
file manipulation.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>checksum_info</strong> (<a class="reference internal" href="#com.vmware.content.library.item_client.File.ChecksumInfo" title="com.vmware.content.library.item_client.File.ChecksumInfo"><tt class="xref py py-class docutils literal"><span class="pre">File.ChecksumInfo</span></tt></a> or <tt class="docutils literal"><span class="pre">None</span></tt>) – <p>A checksum for validating the content of the file.</p>
|
||
|
|
<p>This value can be used to verify that a transfer was completed
|
||
|
|
without errors.
|
||
|
|
A checksum cannot always be calculated, and the value will be None
|
||
|
|
if the file does not have content.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <p>The name of the file.</p>
|
||
|
|
<p>This value will be unique within the library item for each file. It
|
||
|
|
cannot be an empty string.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>size</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – The file size, in bytes. The file size is the storage used and not
|
||
|
|
the uploaded or provisioned size. For example, when uploading a
|
||
|
|
disk to a datastore, the amount of storage that the disk consumes
|
||
|
|
may be different from the disk file size. When the file is not
|
||
|
|
cached, the size is 0.</li>
|
||
|
|
<li><strong>cached</strong> (<tt class="xref py py-class docutils literal"><span class="pre">bool</span></tt>) – Indicates whether the file is on disk or not.</li>
|
||
|
|
<li><strong>version</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The version of this file; incremented when a new copy of the file
|
||
|
|
is uploaded.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library.item_client.Storage.get">
|
||
|
|
<tt class="descclassname">Storage.</tt><tt class="descname">get</tt><big>(</big><em>library_item_id</em>, <em>file_name</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#Storage.get"><span class="viewcode-link">[source]</span></a><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the library item whose storage information should be
|
||
|
|
retrieved.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.</li>
|
||
|
|
<li><strong>file_name</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – 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"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.content.library.item_client.Storage.Info" title="com.vmware.content.library.item_client.Storage.Info"><tt class="xref py py-class docutils literal"><span class="pre">Storage.Info</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt> referenced by
|
||
|
|
the parameter <tt class="docutils literal"><span class="pre">library_item_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">ContentLibrary.ReadStorage</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library.item_client.Storage.list">
|
||
|
|
<tt class="descclassname">Storage.</tt><tt class="descname">list</tt><big>(</big><em>library_item_id</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#Storage.list"><span class="viewcode-link">[source]</span></a><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the library item whose storage information should be
|
||
|
|
listed.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.</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"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <a class="reference internal" href="#com.vmware.content.library.item_client.Storage.Info" title="com.vmware.content.library.item_client.Storage.Info"><tt class="xref py py-class docutils literal"><span class="pre">Storage.Info</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt> referenced by
|
||
|
|
the parameter <tt class="docutils literal"><span class="pre">library_item_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">ContentLibrary.ReadStorage</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content.library.item_client.TransferEndpoint">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.content.library.item_client.</tt><tt class="descname">TransferEndpoint</tt><big>(</big><em>uri=None</em>, <em>ssl_certificate_thumbprint=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#TransferEndpoint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.content.library.item_client.TransferEndpoint" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">TransferEndpoint</span></tt> 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>
|
||
|
|
<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 last simple">
|
||
|
|
<li><strong>uri</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – <p>Transfer endpoint URI. The supported URI schemes are: <tt class="docutils literal"><span class="pre">http</span></tt>,
|
||
|
|
<tt class="docutils literal"><span class="pre">https</span></tt>, <tt class="docutils literal"><span class="pre">file</span></tt>, and <tt class="docutils literal"><span class="pre">ds</span></tt>.</p>
|
||
|
|
<p>An endpoint URI with the <tt class="docutils literal"><span class="pre">ds</span></tt> scheme specifies the location of
|
||
|
|
the file on the datastore. The format of the datastore URI is:</p>
|
||
|
|
<ul>
|
||
|
|
<li>ds:///vmfs/volumes/uuid/path</li>
|
||
|
|
</ul>
|
||
|
|
<blockquote>
|
||
|
|
<div>Some examples of valid file URI formats are:</div></blockquote>
|
||
|
|
<ul>
|
||
|
|
<li><a class="reference external" href="file:///path">file:///path</a></li>
|
||
|
|
<li><a class="reference external" href="file:///C:/path">file:///C:/path</a></li>
|
||
|
|
<li><a class="reference external" href="file://unc-server/path">file://unc-server/path</a></li>
|
||
|
|
</ul>
|
||
|
|
<p>When the transfer endpoint is a file or datastore location, the
|
||
|
|
server can import the file directly from the storage backing
|
||
|
|
without the overhead of streaming over HTTP.</p>
|
||
|
|
</li>
|
||
|
|
<li><strong>ssl_certificate_thumbprint</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Thumbprint of the expected SSL certificate for this endpoint. Only
|
||
|
|
used for HTTPS connections. The thumbprint is the SHA-1 hash of the
|
||
|
|
DER encoding of the remote endpoint’s SSL certificate. If set, the
|
||
|
|
remote endpoint’s SSL certificate is only accepted if it matches
|
||
|
|
this thumbprint, and no other certificate validation is performed.
|
||
|
|
If not specified, standard certificate validation is performed.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content.library.item_client.TransferStatus">
|
||
|
|
<em class="property">class </em><tt class="descclassname">com.vmware.content.library.item_client.</tt><tt class="descname">TransferStatus</tt><big>(</big><em>string</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#TransferStatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.content.library.item_client.TransferStatus" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.enum.Enum" title="vmware.vapi.bindings.enum.Enum"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">TransferStatus</span></tt> 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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<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"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <a class="reference internal" href="#com.vmware.content.library.item_client.TransferStatus" title="com.vmware.content.library.item_client.TransferStatus"><tt class="xref py py-class docutils literal"><span class="pre">TransferStatus</span></tt></a> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content.library.item_client.TransferStatus.ERROR">
|
||
|
|
<tt class="descname">ERROR</tt><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">
|
||
|
|
<tt class="descname">READY</tt><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">
|
||
|
|
<tt class="descname">TRANSFERRING</tt><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">
|
||
|
|
<tt class="descname">VALIDATING</tt><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">
|
||
|
|
<tt class="descname">WAITING_FOR_TRANSFER</tt><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><tt class="descclassname">com.vmware.content.library.item_client.</tt><tt class="descname">UpdateSession</tt><big>(</big><em>config</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#UpdateSession"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSession" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.VapiInterface" title="vmware.vapi.bindings.stub.VapiInterface"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.VapiInterface</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">UpdateSession</span></tt> 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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content.library_client.ItemModel</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.content.library.item.updatesession_client.File</span></tt></a> class.</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"><strong>config</strong> (<a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.stub.StubConfiguration" title="vmware.vapi.bindings.stub.StubConfiguration"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></tt></a>) – Configuration to be used for creating the stub.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSession.RESOURCE_TYPE">
|
||
|
|
<tt class="descname">RESOURCE_TYPE</tt><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">
|
||
|
|
<tt class="descname">cancel</tt><big>(</big><em>update_session_id</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#UpdateSession.cancel"><span class="viewcode-link">[source]</span></a><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 deletes it. 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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the update session that should be canceled.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.UpdateSession</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt></a>
|
||
|
|
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"><tt class="xref py py-attr docutils literal"><span class="pre">UpdateSessionModel.State.ACTIVE</span></tt></a> state.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Anonymous</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSession.complete">
|
||
|
|
<tt class="descname">complete</tt><big>(</big><em>update_session_id</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#UpdateSession.complete"><span class="viewcode-link">[source]</span></a><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"><tt class="xref py py-attr docutils literal"><span class="pre">UpdateSessionModel.State.ACTIVE</span></tt></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"><tt class="xref py py-func docutils literal"><span class="pre">com.vmware.content.library.item.updatesession_client.File.validate()</span></tt></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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the update session that should be completed.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.UpdateSession</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt></a>
|
||
|
|
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"><tt class="xref py py-attr docutils literal"><span class="pre">UpdateSessionModel.State.ACTIVE</span></tt></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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Anonymous</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSession.create">
|
||
|
|
<tt class="descname">create</tt><big>(</big><em>create_spec</em>, <em>client_token=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#UpdateSession.create"><span class="viewcode-link">[source]</span></a><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Unique token generated by the client for each creation request. The
|
||
|
|
token should be a universally unique identifier (UUID), for
|
||
|
|
example: <tt class="docutils literal"><span class="pre">b8a2a2e3-2314-43cd-a871-6ede0f429751</span></tt>. 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"><tt class="xref py py-class docutils literal"><span class="pre">UpdateSessionModel</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></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:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.UpdateSession</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt></a>
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidArgument" title="com.vmware.vapi.std.errors_client.InvalidArgument"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidArgument</span></tt></a>
|
||
|
|
if the <tt class="docutils literal"><span class="pre">client_token</span></tt> 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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.InvalidElementType" title="com.vmware.vapi.std.errors_client.InvalidElementType"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.InvalidElementType</span></tt></a>
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.ResourceBusy" title="com.vmware.vapi.std.errors_client.ResourceBusy"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.ResourceBusy</span></tt></a>
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt> referenced by
|
||
|
|
the attribute <tt class="xref py py-attr docutils literal"><span class="pre">UpdateSessionModel.library_item_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">ContentLibrary.UpdateSession</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSession.delete">
|
||
|
|
<tt class="descname">delete</tt><big>(</big><em>update_session_id</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#UpdateSession.delete"><span class="viewcode-link">[source]</span></a><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifer of the update session to delete.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.UpdateSession</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt></a>
|
||
|
|
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"><tt class="xref py py-attr docutils literal"><span class="pre">UpdateSessionModel.State.ACTIVE</span></tt></a> state.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-odd field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Anonymous</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSession.fail">
|
||
|
|
<tt class="descname">fail</tt><big>(</big><em>update_session_id</em>, <em>client_error_message</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#UpdateSession.fail"><span class="viewcode-link">[source]</span></a><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the update session to fail.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.UpdateSession</span></tt>.</li>
|
||
|
|
<li><strong>client_error_message</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – 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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt></a>
|
||
|
|
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"><tt class="xref py py-attr docutils literal"><span class="pre">UpdateSessionModel.State.ACTIVE</span></tt></a> state.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Anonymous</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSession.get">
|
||
|
|
<tt class="descname">get</tt><big>(</big><em>update_session_id</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#UpdateSession.get"><span class="viewcode-link">[source]</span></a><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the update session to retrieve.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.UpdateSession</span></tt>.</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"><tt class="xref py py-class docutils literal"><span class="pre">UpdateSessionModel</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">UpdateSessionModel</span></tt></a> instance with the given
|
||
|
|
<tt class="docutils literal"><span class="pre">update_session_id</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Anonymous</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSession.keep_alive">
|
||
|
|
<tt class="descname">keep_alive</tt><big>(</big><em>update_session_id</em>, <em>client_progress=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#UpdateSession.keep_alive"><span class="viewcode-link">[source]</span></a><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – Identifier of the update session whose lifetime should be extended.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.UpdateSession</span></tt>.</li>
|
||
|
|
<li><strong>client_progress</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Optional update to the progress property of the session. If
|
||
|
|
specified, the new progress should be greater then the current
|
||
|
|
progress. See <tt class="xref py py-attr docutils literal"><span class="pre">UpdateSessionModel.client_progress</span></tt>.
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotAllowedInCurrentState" title="com.vmware.vapi.std.errors_client.NotAllowedInCurrentState"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotAllowedInCurrentState</span></tt></a>
|
||
|
|
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"><tt class="xref py py-attr docutils literal"><span class="pre">UpdateSessionModel.State.ACTIVE</span></tt></a> state.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>Method execution requires <tt class="docutils literal"><span class="pre">System.Anonymous</span></tt>.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</dd></dl>
|
||
|
|
|
||
|
|
<dl class="method">
|
||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSession.list">
|
||
|
|
<tt class="descname">list</tt><big>(</big><em>library_item_id=None</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#UpdateSession.list"><span class="viewcode-link">[source]</span></a><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> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt> or <tt class="docutils literal"><span class="pre">None</span></tt>) – Optional library item identifier on which to filter results.
|
||
|
|
The parameter must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.UpdateSession</span></tt>.
|
||
|
|
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"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of <tt class="xref py py-class docutils literal"><span class="pre">str</span></tt></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"><tt class="xref py py-class docutils literal"><span class="pre">list</span></tt></a> of identifiers of all update sessions created by
|
||
|
|
the calling user.
|
||
|
|
The return value will contain identifiers for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.UpdateSession</span></tt>.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body"><p class="first"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.NotFound" title="com.vmware.vapi.std.errors_client.NotFound"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></tt></a>
|
||
|
|
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"><a class="reference internal" href="com.vmware.vapi.std.html#com.vmware.vapi.std.errors_client.Unauthorized" title="com.vmware.vapi.std.errors_client.Unauthorized"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></tt></a>
|
||
|
|
if you do not have all of the privileges described as follows:</p>
|
||
|
|
<ul class="last simple">
|
||
|
|
<li>The resource <tt class="docutils literal"><span class="pre">com.vmware.content.library.item.UpdateSession</span></tt>
|
||
|
|
referenced by the parameter <tt class="docutils literal"><span class="pre">library_item_id</span></tt> requires
|
||
|
|
<tt class="docutils literal"><span class="pre">ContentLibrary.UpdateSession</span></tt>.</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><tt class="descclassname">com.vmware.content.library.item_client.</tt><tt class="descname">UpdateSessionModel</tt><big>(</big><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><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#UpdateSessionModel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.struct.VapiStruct" title="vmware.vapi.bindings.struct.VapiStruct"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></tt></a></p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">UpdateSessionModel</span></tt> 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"><tt class="xref py py-class docutils literal"><span class="pre">UpdateSession</span></tt></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>
|
||
|
|
<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 last simple">
|
||
|
|
<li><strong>id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of this update session.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.UpdateSession</span></tt>. When methods
|
||
|
|
return a value of this class as a return value, the attribute will
|
||
|
|
be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.item.UpdateSession</span></tt>.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will not
|
||
|
|
be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt> methods.
|
||
|
|
It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>library_item_id</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The identifier of the library item to which content will be
|
||
|
|
uploaded or removed.
|
||
|
|
When clients pass a value of this class as a parameter, the
|
||
|
|
attribute must be an identifier for the resource type:
|
||
|
|
<tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>. When methods return a value of
|
||
|
|
this class as a return value, the attribute will be an identifier
|
||
|
|
for the resource type: <tt class="docutils literal"><span class="pre">com.vmware.content.library.Item</span></tt>.
|
||
|
|
This attribute must be provided for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>library_item_content_version</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – The content version of the library item whose content is being
|
||
|
|
modified. This value is the
|
||
|
|
<tt class="xref py py-attr docutils literal"><span class="pre">com.vmware.content.library_client.ItemModel.content_version</span></tt>
|
||
|
|
at the time when the session is created for the library item.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>error_message</strong> (<a class="reference internal" href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage" title="com.vmware.vapi.std_client.LocalizableMessage"><tt class="xref py py-class docutils literal"><span class="pre">com.vmware.vapi.std_client.LocalizableMessage</span></tt></a>) – If the session is in the <a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State.ERROR" title="com.vmware.content.library.item_client.UpdateSessionModel.State.ERROR"><tt class="xref py py-attr docutils literal"><span class="pre">UpdateSessionModel.State.ERROR</span></tt></a>
|
||
|
|
status this property will have more details about the error.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It is
|
||
|
|
optional in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt> methods. It
|
||
|
|
is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>client_progress</strong> (<tt class="xref py py-class docutils literal"><span class="pre">long</span></tt>) – The progress that has been made with the upload. This property is
|
||
|
|
to be updated by the client during the upload process to indicate
|
||
|
|
the progress of its work in completing the upload. The initial
|
||
|
|
progress is 0 until updated by the client. The maximum value is
|
||
|
|
100, which indicates that the update is complete.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>state</strong> (<a class="reference internal" href="#com.vmware.content.library.item_client.UpdateSessionModel.State" title="com.vmware.content.library.item_client.UpdateSessionModel.State"><tt class="xref py py-class docutils literal"><span class="pre">UpdateSessionModel.State</span></tt></a>) – The current state (ACTIVE, DONE, ERROR, CANCELED) of the update
|
||
|
|
session.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
<li><strong>expiration_time</strong> (<tt class="xref py py-class docutils literal"><span class="pre">datetime.datetime</span></tt>) – Indicates the time after which the session will expire. The session
|
||
|
|
is guaranteed not to expire earlier than this time.
|
||
|
|
This attribute is not used for the <tt class="docutils literal"><span class="pre">create</span></tt> method. It will
|
||
|
|
always be present in the return value of the <tt class="docutils literal"><span class="pre">get</span></tt> or <tt class="docutils literal"><span class="pre">list</span></tt>
|
||
|
|
methods. It is not used for the <tt class="docutils literal"><span class="pre">update</span></tt> method.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="class">
|
||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSessionModel.State">
|
||
|
|
<em class="property">class </em><tt class="descname">State</tt><big>(</big><em>string</em><big>)</big><a class="reference internal" href="_modules/com/vmware/content/library/item_client.html#UpdateSessionModel.State"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#com.vmware.content.library.item_client.UpdateSessionModel.State" title="Permalink to this definition">¶</a></dt>
|
||
|
|
<dd><p>Bases: <a class="reference internal" href="vmware.vapi.bindings.html#vmware.vapi.bindings.enum.Enum" title="vmware.vapi.bindings.enum.Enum"><tt class="xref py py-class docutils literal"><span class="pre">vmware.vapi.bindings.enum.Enum</span></tt></a></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="custom/rst/enumeration.html#enumeration-description"><em>enumerated
|
||
|
|
type description page</em></a>.</p>
|
||
|
|
</div>
|
||
|
|
<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"><strong>string</strong> (<tt class="xref py py-class docutils literal"><span class="pre">str</span></tt>) – String value for the <tt class="xref py py-class docutils literal"><span class="pre">State</span></tt> instance.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<dl class="attribute">
|
||
|
|
<dt id="com.vmware.content.library.item_client.UpdateSessionModel.State.ACTIVE">
|
||
|
|
<tt class="descname">ACTIVE</tt><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">
|
||
|
|
<tt class="descname">CANCELED</tt><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">
|
||
|
|
<tt class="descname">DONE</tt><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">
|
||
|
|
<tt class="descname">ERROR</tt><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 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">item Package</a><ul>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="com.vmware.content.library.item.html#id1"><tt class="docutils literal"><span class="pre">item</span></tt> Package</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"><tt class="docutils literal"><span class="pre">downloadsession_client</span></tt> 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"><tt class="docutils literal"><span class="pre">updatesession_client</span></tt> Module</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="sphinxsidebar">
|
||
|
|
<div class="sphinxsidebarwrapper">
|
||
|
|
<h3><a href="index.html">Table Of Contents</a></h3>
|
||
|
|
<ul>
|
||
|
|
<li><a class="reference internal" href="#">library Package</a><ul>
|
||
|
|
<li><a class="reference internal" href="#id1"><tt class="docutils literal"><span class="pre">library</span></tt> Package</a></li>
|
||
|
|
<li><a class="reference internal" href="#module-com.vmware.content.library.item_client"><tt class="docutils literal"><span class="pre">item_client</span></tt> Module</a></li>
|
||
|
|
<li><a class="reference internal" href="#subpackages">Subpackages</a><ul>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h4>Previous topic</h4>
|
||
|
|
<p class="topless"><a href="com.vmware.content.html"
|
||
|
|
title="previous chapter">content Package</a></p>
|
||
|
|
<h4>Next topic</h4>
|
||
|
|
<p class="topless"><a href="com.vmware.content.library.item.html"
|
||
|
|
title="next chapter">item Package</a></p>
|
||
|
|
<h3>This Page</h3>
|
||
|
|
<ul class="this-page-menu">
|
||
|
|
<li><a href="_sources/com.vmware.content.library.txt"
|
||
|
|
rel="nofollow">Show Source</a></li>
|
||
|
|
</ul>
|
||
|
|
<div id="searchbox" style="display: none">
|
||
|
|
<h3>Quick search</h3>
|
||
|
|
<form class="search" action="search.html" method="get">
|
||
|
|
<input type="text" name="q" />
|
||
|
|
<input type="submit" value="Go" />
|
||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
||
|
|
<input type="hidden" name="area" value="default" />
|
||
|
|
</form>
|
||
|
|
<p class="searchtip" style="font-size: 90%">
|
||
|
|
Enter search terms or a module, class or function name.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="clearer"></div>
|
||
|
|
</div>
|
||
|
|
<div class="related">
|
||
|
|
<h3>Navigation</h3>
|
||
|
|
<ul>
|
||
|
|
<li class="right" style="margin-right: 10px">
|
||
|
|
<a href="genindex.html" title="General Index"
|
||
|
|
>index</a></li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="py-modindex.html" title="Python Module Index"
|
||
|
|
>modules</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.content.library.item.html" title="item Package"
|
||
|
|
>next</a> |</li>
|
||
|
|
<li class="right" >
|
||
|
|
<a href="com.vmware.content.html" title="content Package"
|
||
|
|
>previous</a> |</li>
|
||
|
|
<li><a href="index.html">vCloud Suite SDK for Python 6.0.0 documentation</a> »</li>
|
||
|
|
<li><a href="com.html" >com Package</a> »</li>
|
||
|
|
<li><a href="com.vmware.html" >vmware Package</a> »</li>
|
||
|
|
<li><a href="com.vmware.content.html" >content Package</a> »</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="footer">
|
||
|
|
© Copyright 2014, VMware, Inc..
|
||
|
|
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|