Mirrors/vsphere-automation-sdk-python
1
0
Fork 0
mirror of https://github.com/vmware/vsphere-automation-sdk-python.git synced 2024-11-22 17:39:59 -05:00
Code
5a27fba324
vsphere-automation-sdk-python/vmc-draas/com.vmware.vmc.draas.html

760 lines
58 KiB
HTML
Raw Normal View History

adding docs for vmc-draas
2019-09-03 06:02:39 -04:00
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>com.vmware.vmc.draas package &mdash; vSphere Automation SDK for Python 1.9.0 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="vmware package" href="vmware.html" />
<link rel="prev" title="com.vmware.vmc package" href="com.vmware.vmc.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> vSphere Automation SDK for Python
</a>
<div class="version">
1.9.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="com.html">com package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="com.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="com.vmware.html">com.vmware package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="com.vmware.html#subpackages">Subpackages</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="vmware.html">vmware package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">vSphere Automation SDK for Python</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="com.html">com package</a> &raquo;</li>
<li><a href="com.vmware.html">com.vmware package</a> &raquo;</li>
<li><a href="com.vmware.vmc.html">com.vmware.vmc package</a> &raquo;</li>
<li>com.vmware.vmc.draas package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/com.vmware.vmc.draas.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-com.vmware.vmc.draas">
<span id="com-vmware-vmc-draas-package"></span><h1>com.vmware.vmc.draas package<a class="headerlink" href="#module-com.vmware.vmc.draas" title="Permalink to this headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-com.vmware.vmc.draas.model_client">
<span id="com-vmware-vmc-draas-model-client-module"></span><h2>com.vmware.vmc.draas.model_client module<a class="headerlink" href="#module-com.vmware.vmc.draas.model_client" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="com.vmware.vmc.draas.model_client.AbstractEntity">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">AbstractEntity</code><span class="sig-paren">(</span><em>updated=None</em>, <em>user_id=None</em>, <em>created=None</em>, <em>updated_by_user_id=None</em>, <em>version=None</em>, <em>updated_by_user_name=None</em>, <em>user_name=None</em>, <em>id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.AbstractEntity" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<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>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
<li><strong>user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
<li><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
<li><strong>updated_by_user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
<li><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Version of this entity format: int32</li>
<li><strong>updated_by_user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</li>
<li><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</li>
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.draas.model_client.ActivateSiteRecoveryConfig">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">ActivateSiteRecoveryConfig</code><span class="sig-paren">(</span><em>srm_extension_key_suffix=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.ActivateSiteRecoveryConfig" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<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"><strong>srm_extension_key_suffix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Optional custom extension key suffix for SRM. If not specified,
updating draas docs with latest Task and Replication APIs
2019-09-06 04:25:12 -04:00
default extension key will be used. The custom extension suffix
must contain 13 characters or less, be composed of letters,
numbers, ., -, and _ characters. The extension suffix must begin
and end with a letter or number. The suffix is appended to
com.vmware.vcDr- to form the full extension key.</td>
adding docs for vmc-draas
2019-09-03 06:02:39 -04:00
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.draas.model_client.ErrorResponse">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">ErrorResponse</code><span class="sig-paren">(</span><em>status=None</em>, <em>path=None</em>, <em>retryable=None</em>, <em>error_code=None</em>, <em>error_messages=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.ErrorResponse" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<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>status</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – HTTP status code</li>
<li><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – Originating request URI</li>
<li><strong>retryable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – If true, client should retry operation</li>
<li><strong>error_code</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – unique error code</li>
<li><strong>error_messages</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – localized error messages</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.draas.model_client.ProvisionSrmConfig">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">ProvisionSrmConfig</code><span class="sig-paren">(</span><em>internal=None</em>, <em>srm_extension_key_suffix=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.ProvisionSrmConfig" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<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>internal</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Internal flag to allow to invoke additional SRM provisioning API on
NSX-V SDDCs.</li>
<li><strong>srm_extension_key_suffix</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – Optional custom extension key suffix for SRM. If not specified,
default extension key will be used.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
updating draas docs with latest Task and Replication APIs
2019-09-06 04:25:12 -04:00
<dl class="class">
<dt id="com.vmware.vmc.draas.model_client.ReplicaDisk">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">ReplicaDisk</code><span class="sig-paren">(</span><em>space_requirement=None</em>, <em>name=None</em>, <em>collection_id=None</em>, <em>datastores_for_single_host_move=None</em>, <em>movable=None</em>, <em>disk_id=None</em>, <em>datastore_mo_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.ReplicaDisk" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<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>space_requirement</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
<li><strong>name</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>) – </li>
<li><strong>collection_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>) – </li>
<li><strong>datastores_for_single_host_move</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
<li><strong>movable</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
<li><strong>disk_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>) – </li>
<li><strong>datastore_mo_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>) – </li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.draas.model_client.ReplicaDiskCollection">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">ReplicaDiskCollection</code><span class="sig-paren">(</span><em>collection_id=None</em>, <em>generated=None</em>, <em>disks=None</em>, <em>placeholder_vm_mo_id=None</em>, <em>name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.ReplicaDiskCollection" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<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>collection_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>) – </li>
<li><strong>generated</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>) – </li>
<li><strong>disks</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.ReplicaDisk" title="com.vmware.vmc.draas.model_client.ReplicaDisk"><code class="xref py py-class docutils literal notranslate"><span class="pre">ReplicaDisk</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
<li><strong>placeholder_vm_mo_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>) – </li>
<li><strong>name</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>) – </li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
adding docs for vmc-draas
2019-09-03 06:02:39 -04:00
<dl class="class">
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">SiteRecovery</code><span class="sig-paren">(</span><em>updated=None</em>, <em>user_id=None</em>, <em>created=None</em>, <em>updated_by_user_id=None</em>, <em>version=None</em>, <em>updated_by_user_name=None</em>, <em>user_name=None</em>, <em>id=None</em>, <em>site_recovery_state=None</em>, <em>vr_node=None</em>, <em>srm_nodes=None</em>, <em>sddc_id=None</em>, <em>draas_h5_url=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<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>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
<li><strong>user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
<li><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
<li><strong>updated_by_user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
<li><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Version of this entity format: int32</li>
<li><strong>updated_by_user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</li>
<li><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</li>
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
<li><strong>site_recovery_state</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>Possible values are:</p>
<ul>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATING" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_ACTIVATING</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATED" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_ACTIVATED</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATING" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATING</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATED" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATED</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_FAILED" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_FAILED</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_CANCELED" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_CANCELED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_CANCELED</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DELETED" title="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DELETED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecovery.SITE_RECOVERY_STATE_DELETED</span></code></a></li>
</ul>
</li>
<li><strong>vr_node</strong> (<a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode"><code class="xref py py-class docutils literal notranslate"><span class="pre">SiteRecoveryNode</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
<li><strong>srm_nodes</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.SiteRecoveryNode" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode"><code class="xref py py-class docutils literal notranslate"><span class="pre">SiteRecoveryNode</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
<li><strong>sddc_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>) – </li>
<li><strong>draas_h5_url</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>) – </li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATED">
<code class="descname">SITE_RECOVERY_STATE_ACTIVATED</code><em class="property"> = 'ACTIVATED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATING">
<code class="descname">SITE_RECOVERY_STATE_ACTIVATING</code><em class="property"> = 'ACTIVATING'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_ACTIVATING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_CANCELED">
<code class="descname">SITE_RECOVERY_STATE_CANCELED</code><em class="property"> = 'CANCELED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_CANCELED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATED">
<code class="descname">SITE_RECOVERY_STATE_DEACTIVATED</code><em class="property"> = 'DEACTIVATED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATING">
<code class="descname">SITE_RECOVERY_STATE_DEACTIVATING</code><em class="property"> = 'DEACTIVATING'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DEACTIVATING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DELETED">
<code class="descname">SITE_RECOVERY_STATE_DELETED</code><em class="property"> = 'DELETED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_DELETED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_FAILED">
<code class="descname">SITE_RECOVERY_STATE_FAILED</code><em class="property"> = 'FAILED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecovery.SITE_RECOVERY_STATE_FAILED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">SiteRecoveryNode</code><span class="sig-paren">(</span><em>vm_moref_id=None</em>, <em>ip_address=None</em>, <em>hostname=None</em>, <em>id=None</em>, <em>state=None</em>, <em>type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<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>vm_moref_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>) – </li>
<li><strong>ip_address</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>) – </li>
<li><strong>hostname</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>) – </li>
<li><strong>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>) – </li>
<li><strong>state</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>Possible values are:</p>
<ul>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DEPLOYING" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DEPLOYING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.STATE_DEPLOYING</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_PROVISIONED" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_PROVISIONED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.STATE_PROVISIONED</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_READY" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_READY"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.STATE_READY</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DELETING" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DELETING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.STATE_DELETING</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_FAILED" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.STATE_FAILED</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_CANCELED" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_CANCELED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.STATE_CANCELED</span></code></a></li>
</ul>
</li>
<li><strong>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>Possible values are:</p>
<ul>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRMS" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRMS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.TYPE_VRMS</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_SRM" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_SRM"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.TYPE_SRM</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRS" title="com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNode.TYPE_VRS</span></code></a></li>
</ul>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_CANCELED">
<code class="descname">STATE_CANCELED</code><em class="property"> = 'CANCELED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_CANCELED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DELETING">
<code class="descname">STATE_DELETING</code><em class="property"> = 'DELETING'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DELETING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DEPLOYING">
<code class="descname">STATE_DEPLOYING</code><em class="property"> = 'DEPLOYING'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_DEPLOYING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_FAILED">
<code class="descname">STATE_FAILED</code><em class="property"> = 'FAILED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_FAILED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_PROVISIONED">
<code class="descname">STATE_PROVISIONED</code><em class="property"> = 'PROVISIONED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_PROVISIONED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_READY">
<code class="descname">STATE_READY</code><em class="property"> = 'READY'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.STATE_READY" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_SRM">
<code class="descname">TYPE_SRM</code><em class="property"> = 'SRM'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_SRM" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRMS">
<code class="descname">TYPE_VRMS</code><em class="property"> = 'VRMS'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRMS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRS">
<code class="descname">TYPE_VRS</code><em class="property"> = 'VRS'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNode.TYPE_VRS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">SiteRecoveryNodeVersion</code><span class="sig-paren">(</span><em>version_source=None</em>, <em>node_id=None</em>, <em>build_number=None</em>, <em>appliance_version=None</em>, <em>node_ip=None</em>, <em>full_version=None</em>, <em>node_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<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>version_source</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>Possible values are:</p>
<ul>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_VAMICLI" title="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_VAMICLI"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNodeVersion.VERSION_SOURCE_VAMICLI</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_LS" title="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_LS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNodeVersion.VERSION_SOURCE_LS</span></code></a></li>
</ul>
</li>
<li><strong>node_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>) – </li>
<li><strong>build_number</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>) – </li>
<li><strong>appliance_version</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>) – </li>
<li><strong>node_ip</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>) – </li>
<li><strong>full_version</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>) – </li>
<li><strong>node_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>Possible values are:</p>
<ul>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRMS" title="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRMS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNodeVersion.NODE_TYPE_VRMS</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_SRM" title="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_SRM"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNodeVersion.NODE_TYPE_SRM</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRS" title="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRS"><code class="xref py py-attr docutils literal notranslate"><span class="pre">SiteRecoveryNodeVersion.NODE_TYPE_VRS</span></code></a></li>
</ul>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_SRM">
<code class="descname">NODE_TYPE_SRM</code><em class="property"> = 'SRM'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_SRM" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRMS">
<code class="descname">NODE_TYPE_VRMS</code><em class="property"> = 'VRMS'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRMS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRS">
<code class="descname">NODE_TYPE_VRS</code><em class="property"> = 'VRS'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.NODE_TYPE_VRS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_LS">
<code class="descname">VERSION_SOURCE_LS</code><em class="property"> = 'ls'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_LS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_VAMICLI">
<code class="descname">VERSION_SOURCE_VAMICLI</code><em class="property"> = 'vamicli'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion.VERSION_SOURCE_VAMICLI" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.draas.model_client.SiteRecoveryVersions">
updating draas docs with latest Task and Replication APIs
2019-09-06 04:25:12 -04:00
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">SiteRecoveryVersions</code><span class="sig-paren">(</span><em>generated=None</em>, <em>sddc_id=None</em>, <em>node_versions=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.SiteRecoveryVersions" title="Permalink to this definition"></a></dt>
adding docs for vmc-draas
2019-09-03 06:02:39 -04:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></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">
updating draas docs with latest Task and Replication APIs
2019-09-06 04:25:12 -04:00
<li><strong>generated</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>) – </li>
adding docs for vmc-draas
2019-09-03 06:02:39 -04:00
<li><strong>sddc_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>) – </li>
<li><strong>node_versions</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.SiteRecoveryNodeVersion" title="com.vmware.vmc.draas.model_client.SiteRecoveryNodeVersion"><code class="xref py py-class docutils literal notranslate"><span class="pre">SiteRecoveryNodeVersion</span></code></a> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – list of site recovery node version</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.draas.model_client.StubFactory">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">StubFactory</code><span class="sig-paren">(</span><em>stub_config</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.StubFactory" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubFactoryBase</span></code></p>
<p>Initialize StubFactoryBase</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>stub_config</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Stub config instance</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.draas.model_client.Task">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">Task</code><span class="sig-paren">(</span><em>updated=None</em>, <em>user_id=None</em>, <em>created=None</em>, <em>updated_by_user_id=None</em>, <em>version=None</em>, <em>updated_by_user_name=None</em>, <em>user_name=None</em>, <em>id=None</em>, <em>status=None</em>, <em>resource_id=None</em>, <em>start_time=None</em>, <em>retries=None</em>, <em>task_type=None</em>, <em>task_progress_phases=None</em>, <em>tenant_id=None</em>, <em>error_message=None</em>, <em>parent_task_id=None</em>, <em>progress_percent=None</em>, <em>estimated_remaining_minutes=None</em>, <em>params=None</em>, <em>end_time=None</em>, <em>task_version=None</em>, <em>resource_type=None</em>, <em>sub_status=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.Task" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<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>updated</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
<li><strong>user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
<li><strong>created</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code>) – </li>
<li><strong>updated_by_user_id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User id that last updated this record</li>
<li><strong>version</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – Version of this entity format: int32</li>
<li><strong>updated_by_user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</li>
<li><strong>user_name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – User name that last updated this record</li>
<li><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – </li>
<li><strong>status</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>Possible values are:</p>
<ul>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.Task.STATUS_STARTED" title="com.vmware.vmc.draas.model_client.Task.STATUS_STARTED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Task.STATUS_STARTED</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.Task.STATUS_CANCELING" title="com.vmware.vmc.draas.model_client.Task.STATUS_CANCELING"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Task.STATUS_CANCELING</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.Task.STATUS_FINISHED" title="com.vmware.vmc.draas.model_client.Task.STATUS_FINISHED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Task.STATUS_FINISHED</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.Task.STATUS_FAILED" title="com.vmware.vmc.draas.model_client.Task.STATUS_FAILED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Task.STATUS_FAILED</span></code></a></li>
<li><a class="reference internal" href="#com.vmware.vmc.draas.model_client.Task.STATUS_CANCELED" title="com.vmware.vmc.draas.model_client.Task.STATUS_CANCELED"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Task.STATUS_CANCELED</span></code></a></li>
</ul>
</li>
<li><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</li>
<li><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>) – </li>
<li><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>) – </li>
<li><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>) – </li>
<li><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</li>
<li><strong>tenant_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>) – </li>
<li><strong>error_message</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>) – </li>
<li><strong>parent_task_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>) – </li>
<li><strong>progress_percent</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>) – Estimated progress percentage the task executed format: int32</li>
<li><strong>estimated_remaining_minutes</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>) – Estimated remaining time in minute of the task execution, &lt; 0 means
no estimation for the task. format: int32</li>
<li><strong>params</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.struct.VapiStruct</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – </li>
<li><strong>end_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>) – </li>
<li><strong>task_version</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>) – </li>
<li><strong>resource_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>) – Type of resource being acted upon</li>
<li><strong>sub_status</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>) – </li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.Task.STATUS_CANCELED">
<code class="descname">STATUS_CANCELED</code><em class="property"> = 'CANCELED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.Task.STATUS_CANCELED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.Task.STATUS_CANCELING">
<code class="descname">STATUS_CANCELING</code><em class="property"> = 'CANCELING'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.Task.STATUS_CANCELING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.Task.STATUS_FAILED">
<code class="descname">STATUS_FAILED</code><em class="property"> = 'FAILED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.Task.STATUS_FAILED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.Task.STATUS_FINISHED">
<code class="descname">STATUS_FINISHED</code><em class="property"> = 'FINISHED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.Task.STATUS_FINISHED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="com.vmware.vmc.draas.model_client.Task.STATUS_STARTED">
<code class="descname">STATUS_STARTED</code><em class="property"> = 'STARTED'</em><a class="headerlink" href="#com.vmware.vmc.draas.model_client.Task.STATUS_STARTED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="com.vmware.vmc.draas.model_client.TaskProgressPhase">
<em class="property">class </em><code class="descclassname">com.vmware.vmc.draas.model_client.</code><code class="descname">TaskProgressPhase</code><span class="sig-paren">(</span><em>id=None</em>, <em>name=None</em>, <em>progress_percent=None</em><span class="sig-paren">)</span><a class="headerlink" href="#com.vmware.vmc.draas.model_client.TaskProgressPhase" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">vmware.vapi.bindings.struct.VapiStruct</span></code></p>
<p>A task progress can be (but does NOT have to be) divided to more meaningful
progress phases.</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> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The identifier of the task progress phase</li>
<li><strong>name</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The display name of the task progress phase</li>
<li><strong>progress_percent</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">long</span></code>) – The percentage of the phase that has completed format: int32</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="vmware.html" class="btn btn-neutral float-right" title="vmware package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="com.vmware.vmc.html" class="btn btn-neutral float-left" title="com.vmware.vmc package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2019, VMware, Inc. All rights reserved
</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Copy Permalink