Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 01:39:58 -05:00
Code

Updating latest python vmc-draas doc (49d831e)

Browse Source
This commit is contained in:
sumitAgrawal007 2020-11-18 05:31:03 +00:00
parent baf57d9fbd
commit 3766c8abdd
20 changed files with 137 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
vmc-draas/_sources/index.rst.txt
View File

@ -1,5 +1,5 @@
.. draas documentation master file, created by
sphinx-quickstart on Thu Oct 22 05:29:14 2020.
sphinx-quickstart on Wed Nov 18 05:30:53 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

1
vmc-draas/_static/basic.css
View File

@ -764,6 +764,7 @@ div.code-block-caption code {
}
table.highlighttable td.linenos,
span.linenos,
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
user-select: none;
}

5
vmc-draas/_static/doctools.js
View File

@ -285,9 +285,10 @@ var Documentation = {
initOnKeyListeners: function() {
$(document).keydown(function(event) {
var activeElementType = document.activeElement.tagName;
// don't navigate when in search box or textarea
// don't navigate when in search box, textarea, dropdown or button
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
&& !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) {
&& activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey
&& !event.shiftKey) {
switch (event.keyCode) {
case 37: // left
var prevHref = $('link[rel="prev"]').prop('href');

2
vmc-draas/_static/documentation_options.js
View File

@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '1.14.0',
VERSION: '1.15.0',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',

8
vmc-draas/_static/pygments.css
View File

@ -1,8 +1,8 @@
pre { line-height: 125%; margin: 0; }
td.linenos pre { color: #000000; background-color: #f0f0f0; padding: 0 5px 0 5px; }
span.linenos { color: #000000; background-color: #f0f0f0; padding: 0 5px 0 5px; }
td.linenos pre.special { color: #000000; background-color: #ffffc0; padding: 0 5px 0 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding: 0 5px 0 5px; }
td.linenos pre { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; }
span.linenos { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; }
td.linenos pre.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight { background: #f8f8f8; }
.highlight .c { color: #408080; font-style: italic } /* Comment */

8
vmc-draas/_static/searchtools.js
View File

@ -59,10 +59,10 @@ var Search = {
_pulse_status : -1,
htmlToText : function(htmlString) {
var htmlElement = document.createElement('span');
htmlElement.innerHTML = htmlString;
$(htmlElement).find('.headerlink').remove();
docContent = $(htmlElement).find('[role=main]')[0];
var virtualDocument = document.implementation.createHTMLDocument('virtual');
var htmlElement = $(htmlString, virtualDocument);
htmlElement.find('.headerlink').remove();
docContent = htmlElement.find('[role=main]')[0];
if(docContent === undefined) {
console.warn("Content block not found. Sphinx search tries to obtain it " +
"via '[role=main]'. Could you check your theme or template.");

4
vmc-draas/com.html
View File

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com package &mdash; draas 1.14.0 documentation</title>
<title>com package &mdash; draas 1.15.0 documentation</title>
@ -61,7 +61,7 @@
<div class="version">
1.14.0
1.15.0
</div>

4
vmc-draas/com.vmware.html
View File

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware package &mdash; draas 1.14.0 documentation</title>
<title>com.vmware package &mdash; draas 1.15.0 documentation</title>
@ -61,7 +61,7 @@
<div class="version">
1.14.0
1.15.0
</div>

6
vmc-draas/com.vmware.vmc.draas.html
View File

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.draas package &mdash; draas 1.14.0 documentation</title>
<title>com.vmware.vmc.draas package &mdash; draas 1.15.0 documentation</title>
@ -61,7 +61,7 @@
<div class="version">
1.14.0
1.15.0
</div>
@ -764,7 +764,7 @@ names.</p>
</ul>
</p></li>
<li><p><strong>resource_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – UUID of resources task is acting upon</p></li>
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
<li><p><strong>start_time</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
<li><p><strong>retries</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
<li><p><strong>task_type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </p></li>
<li><p><strong>task_progress_phases</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#com.vmware.vmc.draas.model_client.TaskProgressPhase" title="com.vmware.vmc.draas.model_client.TaskProgressPhase"><code class="xref py py-class docutils literal notranslate"><span class="pre">TaskProgressPhase</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Task progress phases involved in current task execution</p></li>

83
vmc-draas/com.vmware.vmc.html
View File

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc package &mdash; draas 1.14.0 documentation</title>
<title>com.vmware.vmc package &mdash; draas 1.15.0 documentation</title>
@ -61,7 +61,7 @@
<div class="version">
1.14.0
1.15.0
</div>
@ -551,6 +551,85 @@ Cannot find the task with given identifier</p>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vmc.draas_client.Task.list">
<code class="sig-name descname">list</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">filter</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.Task.list" title="Permalink to this definition"></a></dt>
<dd><p>List all tasks with optional filtering.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier (required)</p></li>
<li><p><strong>filter</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Filter expression Binary Operators: ‘eq’, ‘ne’, ‘lt’, ‘gt’, ‘le’,
‘ge’, ‘mul’, ‘div’, ‘mod’, ‘sub’, ‘add’ Unary Operators: ‘not’, ‘-‘
(minus) String Operators: ‘startswith’, ‘endswith’, ‘length’,
‘contains’, ‘tolower’, ‘toupper’, Nested attributes are composed
using ‘.’ Dates must be formatted as yyyy-MM-dd or
yyyy-MM-ddTHH:mm:ss[.SSS]Z Strings should enclosed in single
quotes, escape single quote with two single quotes The special
literal ‘created’ will be mapped to the time the resource was first
created. Examples: - $filter=(updated gt 2016-08-09T13:00:00Z) and
(org_id eq 278710ff4e-6b6d-4d4e-aefb-ca637f38609e) -
$filter=(created eq 2016-08-09) - $filter=(created gt 2016-08-09)
and (sddc.status eq ‘READY’) (optional)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="#com.vmware.vmc.draas_client.Task.list" title="com.vmware.vmc.draas_client.Task.list"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></a> of <a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.Task" title="com.vmware.vmc.draas.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.Task</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p></p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
Unauthorized</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="com.vmware.vmc.draas_client.Task.update">
<code class="sig-name descname">update</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">org</span></em>, <em class="sig-param"><span class="n">task</span></em>, <em class="sig-param"><span class="n">action</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas_client.Task.update" title="Permalink to this definition"></a></dt>
<dd><p>Request that a running task be canceled. This is advisory only, some
tasks may not be cancelable, and some tasks might take an arbitrary
amount of time to respond to a cancelation request. The task must be
monitored to determine subsequent status.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>org</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Organization identifier (required)</p></li>
<li><p><strong>task</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – task identifier (required)</p></li>
<li><p><strong>action</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – If = ‘cancel’, task will be canceled (optional)</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="com.vmware.vmc.draas.html#com.vmware.vmc.draas.model_client.Task" title="com.vmware.vmc.draas.model_client.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vmc.draas.model_client.Task</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>com.vmware.vmc.draas.model.Task</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthenticated</span></code>
Unauthorized</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.InvalidRequest</span></code>
Invalid action or bad argument</p>
</dd>
<dt class="field-even">Raise</dt>
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.Unauthorized</span></code>
Forbidden</p>
</dd>
<dt class="field-odd">Raise</dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">com.vmware.vapi.std.errors_client.NotFound</span></code>
Cannot find the task with given identifier</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">

4
vmc-draas/enumeration.html
View File

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Interface definition language to python mapping for enumerated types &mdash; draas 1.14.0 documentation</title>
<title>Interface definition language to python mapping for enumerated types &mdash; draas 1.15.0 documentation</title>
@ -59,7 +59,7 @@
<div class="version">
1.14.0
1.15.0
</div>

22
vmc-draas/genindex.html
View File

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Index &mdash; draas 1.14.0 documentation</title>
<title>Index &mdash; draas 1.15.0 documentation</title>
@ -59,7 +59,7 @@
<div class="version">
1.14.0
1.15.0
</div>
@ -162,12 +162,14 @@
| <a href="#F"><strong>F</strong></a>
| <a href="#G"><strong>G</strong></a>
| <a href="#H"><strong>H</strong></a>
| <a href="#L"><strong>L</strong></a>
| <a href="#M"><strong>M</strong></a>
| <a href="#N"><strong>N</strong></a>
| <a href="#P"><strong>P</strong></a>
| <a href="#R"><strong>R</strong></a>
| <a href="#S"><strong>S</strong></a>
| <a href="#T"><strong>T</strong></a>
| <a href="#U"><strong>U</strong></a>
| <a href="#V"><strong>V</strong></a>
</div>
@ -307,6 +309,14 @@
</ul></td>
</tr></table>
<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="com.vmware.vmc.html#com.vmware.vmc.draas_client.Task.list">list() (com.vmware.vmc.draas_client.Task method)</a>
</li>
</ul></td>
</tr></table>
<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
@ -512,6 +522,14 @@
</ul></td>
</tr></table>
<h2 id="U">U</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="com.vmware.vmc.html#com.vmware.vmc.draas_client.Task.update">update() (com.vmware.vmc.draas_client.Task method)</a>
</li>
</ul></td>
</tr></table>
<h2 id="V">V</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>

4
vmc-draas/index.html
View File

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Welcome to draas’s documentation! &mdash; draas 1.14.0 documentation</title>
<title>Welcome to draas’s documentation! &mdash; draas 1.15.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version">
1.14.0
1.15.0
</div>

BIN
vmc-draas/objects.inv
View File

Binary file not shown.

4
vmc-draas/py-modindex.html
View File

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Python Module Index &mdash; draas 1.14.0 documentation</title>
<title>Python Module Index &mdash; draas 1.15.0 documentation</title>
@ -62,7 +62,7 @@
<div class="version">
1.14.0
1.15.0
</div>

4
vmc-draas/search.html
View File

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Search &mdash; draas 1.14.0 documentation</title>
<title>Search &mdash; draas 1.15.0 documentation</title>
@ -61,7 +61,7 @@
<div class="version">
1.14.0
1.15.0
</div>

2
vmc-draas/searchindex.js
View File

File diff suppressed because one or more lines are too long

4
vmc-draas/vmware.html
View File

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>vmware package &mdash; draas 1.14.0 documentation</title>
<title>vmware package &mdash; draas 1.15.0 documentation</title>
@ -61,7 +61,7 @@
<div class="version">
1.14.0
1.15.0
</div>

4
vmc-draas/vmware.vapi.html
View File

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>vmware.vapi package &mdash; draas 1.14.0 documentation</title>
<title>vmware.vapi package &mdash; draas 1.15.0 documentation</title>
@ -61,7 +61,7 @@
<div class="version">
1.14.0
1.15.0
</div>

4
vmc-draas/vmware.vapi.vmc.html
View File

@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>vmware.vapi.vmc package &mdash; draas 1.14.0 documentation</title>
<title>vmware.vapi.vmc package &mdash; draas 1.15.0 documentation</title>
@ -60,7 +60,7 @@
<div class="version">
1.14.0
1.15.0
</div>