mirror of
https://github.com/vmware/vsphere-automation-sdk-python.git
synced 2024-11-23 09:59:59 -05:00
2356 lines
171 KiB
HTML
2356 lines
171 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8">
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>vmware.vmc_draas.models package — VMware Automation SDK for Python 0.1.0 documentation</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="../../_static/js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
|
|
|
|
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
|
<script src="../../_static/jquery.js"></script>
|
|
<script src="../../_static/underscore.js"></script>
|
|
<script src="../../_static/doctools.js"></script>
|
|
<script src="../../_static/language_data.js"></script>
|
|
|
|
<script type="text/javascript" src="../../_static/js/theme.js"></script>
|
|
|
|
|
|
<link rel="index" title="Index" href="../../genindex.html" />
|
|
<link rel="search" title="Search" href="../../search.html" />
|
|
<link rel="prev" title="vmware.vmc_draas.api package" href="vmware.vmc_draas.api.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" alt="Documentation Home"> VMware Automation SDK for Python
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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"><a class="reference internal" href="../console/modules.html">console</a></li>
|
|
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">draas</a><ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="setup.html">setup module</a></li>
|
|
<li class="toctree-l2 current"><a class="reference internal" href="vmware.html">vmware package</a><ul class="current">
|
|
<li class="toctree-l3 current"><a class="reference internal" href="vmware.html#subpackages">Subpackages</a><ul class="current">
|
|
<li class="toctree-l4"><a class="reference internal" href="vmware.vmc.html">vmware.vmc package</a></li>
|
|
<li class="toctree-l4 current"><a class="reference internal" href="vmware.vmc_draas.html">vmware.vmc_draas package</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="vmware.html#module-vmware">Module contents</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</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">VMware 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" class="icon icon-home"></a> »</li>
|
|
|
|
<li><a href="modules.html">draas</a> »</li>
|
|
|
|
<li><a href="vmware.html">vmware package</a> »</li>
|
|
|
|
<li><a href="vmware.vmc_draas.html">vmware.vmc_draas package</a> »</li>
|
|
|
|
<li>vmware.vmc_draas.models package</li>
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="../../_sources/vmc/draas/vmware.vmc_draas.models.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="vmware-vmc-draas-models-package">
|
|
<h1>vmware.vmc_draas.models package<a class="headerlink" href="#vmware-vmc-draas-models-package" 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-vmware.vmc_draas.models.abstract_entity">
|
|
<span id="vmware-vmc-draas-models-abstract-entity-module"></span><h2>vmware.vmc_draas.models.abstract_entity module<a class="headerlink" href="#module-vmware.vmc_draas.models.abstract_entity" title="Permalink to this headline">¶</a></h2>
|
|
<p>VMC DRaaS APIs</p>
|
|
<ul class="simple">
|
|
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>   <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>       <span class="pre">-d</span> <span class="pre">"refresh_token=${REFRESH_TOKEN}"</span> <span class="pre">\</span>       <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize</span> <span class="pre">|</span> <span class="pre">jq</span> <span class="pre">-r</span> <span class="pre">.access_token</span>   <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field * Most VMC DRaaS APIs require a sddc identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs/{org}/sddcs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
|
|
</ul>
|
|
<p>The version of the OpenAPI document: 1.0
|
|
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</span>com</a>
|
|
Generated by: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<dl class="py class">
|
|
<dt id="vmware.vmc_draas.models.abstract_entity.AbstractEntity">
|
|
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc_draas.models.abstract_entity.</code><code class="sig-name descname">AbstractEntity</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">updated</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">user_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">created</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">updated_by_user_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">updated_by_user_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">user_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">local_vars_configuration</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.abstract_entity.AbstractEntity" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>NOTE: This class is auto generated by OpenAPI Generator.
|
|
Ref: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<p>Do not edit the class manually.</p>
|
|
<p>AbstractEntity - a model defined in OpenAPI</p>
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.abstract_entity.AbstractEntity.attribute_map">
|
|
<code class="sig-name descname">attribute_map</code><em class="property"> = {'created': 'created', 'id': 'id', 'updated': 'updated', 'updated_by_user_id': 'updated_by_user_id', 'updated_by_user_name': 'updated_by_user_name', 'user_id': 'user_id', 'user_name': 'user_name', 'version': 'version'}</em><a class="headerlink" href="#vmware.vmc_draas.models.abstract_entity.AbstractEntity.attribute_map" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.abstract_entity.AbstractEntity.created">
|
|
<em class="property">property </em><code class="sig-name descname">created</code><a class="headerlink" href="#vmware.vmc_draas.models.abstract_entity.AbstractEntity.created" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the created of this AbstractEntity. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The created of this AbstractEntity. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>datetime</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.abstract_entity.AbstractEntity.id">
|
|
<em class="property">property </em><code class="sig-name descname">id</code><a class="headerlink" href="#vmware.vmc_draas.models.abstract_entity.AbstractEntity.id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the id of this AbstractEntity. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The id of this AbstractEntity. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.abstract_entity.AbstractEntity.openapi_types">
|
|
<code class="sig-name descname">openapi_types</code><em class="property"> = {'created': 'datetime', 'id': 'str', 'updated': 'datetime', 'updated_by_user_id': 'str', 'updated_by_user_name': 'str', 'user_id': 'str', 'user_name': 'str', 'version': 'int'}</em><a class="headerlink" href="#vmware.vmc_draas.models.abstract_entity.AbstractEntity.openapi_types" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.abstract_entity.AbstractEntity.to_dict">
|
|
<code class="sig-name descname">to_dict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.abstract_entity.AbstractEntity.to_dict" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the model properties as a dict</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.abstract_entity.AbstractEntity.to_str">
|
|
<code class="sig-name descname">to_str</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.abstract_entity.AbstractEntity.to_str" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the string representation of the model</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.abstract_entity.AbstractEntity.updated">
|
|
<em class="property">property </em><code class="sig-name descname">updated</code><a class="headerlink" href="#vmware.vmc_draas.models.abstract_entity.AbstractEntity.updated" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the updated of this AbstractEntity. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The updated of this AbstractEntity. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>datetime</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.abstract_entity.AbstractEntity.updated_by_user_id">
|
|
<em class="property">property </em><code class="sig-name descname">updated_by_user_id</code><a class="headerlink" href="#vmware.vmc_draas.models.abstract_entity.AbstractEntity.updated_by_user_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the updated_by_user_id of this AbstractEntity. # noqa: E501</p>
|
|
<p>User id that last updated this record # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The updated_by_user_id of this AbstractEntity. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.abstract_entity.AbstractEntity.updated_by_user_name">
|
|
<em class="property">property </em><code class="sig-name descname">updated_by_user_name</code><a class="headerlink" href="#vmware.vmc_draas.models.abstract_entity.AbstractEntity.updated_by_user_name" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the updated_by_user_name of this AbstractEntity. # noqa: E501</p>
|
|
<p>User name that last updated this record # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The updated_by_user_name of this AbstractEntity. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.abstract_entity.AbstractEntity.user_id">
|
|
<em class="property">property </em><code class="sig-name descname">user_id</code><a class="headerlink" href="#vmware.vmc_draas.models.abstract_entity.AbstractEntity.user_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the user_id of this AbstractEntity. # noqa: E501</p>
|
|
<p>User id that last updated this record # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The user_id of this AbstractEntity. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.abstract_entity.AbstractEntity.user_name">
|
|
<em class="property">property </em><code class="sig-name descname">user_name</code><a class="headerlink" href="#vmware.vmc_draas.models.abstract_entity.AbstractEntity.user_name" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the user_name of this AbstractEntity. # noqa: E501</p>
|
|
<p>User name that last updated this record # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The user_name of this AbstractEntity. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.abstract_entity.AbstractEntity.version">
|
|
<em class="property">property </em><code class="sig-name descname">version</code><a class="headerlink" href="#vmware.vmc_draas.models.abstract_entity.AbstractEntity.version" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the version of this AbstractEntity. # noqa: E501</p>
|
|
<p>Version of this entity # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The version of this AbstractEntity. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>int</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-vmware.vmc_draas.models.activate_site_recovery_config">
|
|
<span id="vmware-vmc-draas-models-activate-site-recovery-config-module"></span><h2>vmware.vmc_draas.models.activate_site_recovery_config module<a class="headerlink" href="#module-vmware.vmc_draas.models.activate_site_recovery_config" title="Permalink to this headline">¶</a></h2>
|
|
<p>VMC DRaaS APIs</p>
|
|
<ul class="simple">
|
|
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>   <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>       <span class="pre">-d</span> <span class="pre">"refresh_token=${REFRESH_TOKEN}"</span> <span class="pre">\</span>       <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize</span> <span class="pre">|</span> <span class="pre">jq</span> <span class="pre">-r</span> <span class="pre">.access_token</span>   <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field * Most VMC DRaaS APIs require a sddc identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs/{org}/sddcs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
|
|
</ul>
|
|
<p>The version of the OpenAPI document: 1.0
|
|
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</span>com</a>
|
|
Generated by: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<dl class="py class">
|
|
<dt id="vmware.vmc_draas.models.activate_site_recovery_config.ActivateSiteRecoveryConfig">
|
|
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc_draas.models.activate_site_recovery_config.</code><code class="sig-name descname">ActivateSiteRecoveryConfig</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">srm_extension_key_suffix</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">local_vars_configuration</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.activate_site_recovery_config.ActivateSiteRecoveryConfig" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>NOTE: This class is auto generated by OpenAPI Generator.
|
|
Ref: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<p>Do not edit the class manually.</p>
|
|
<p>ActivateSiteRecoveryConfig - a model defined in OpenAPI</p>
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.activate_site_recovery_config.ActivateSiteRecoveryConfig.attribute_map">
|
|
<code class="sig-name descname">attribute_map</code><em class="property"> = {'srm_extension_key_suffix': 'srm_extension_key_suffix'}</em><a class="headerlink" href="#vmware.vmc_draas.models.activate_site_recovery_config.ActivateSiteRecoveryConfig.attribute_map" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.activate_site_recovery_config.ActivateSiteRecoveryConfig.openapi_types">
|
|
<code class="sig-name descname">openapi_types</code><em class="property"> = {'srm_extension_key_suffix': 'str'}</em><a class="headerlink" href="#vmware.vmc_draas.models.activate_site_recovery_config.ActivateSiteRecoveryConfig.openapi_types" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.activate_site_recovery_config.ActivateSiteRecoveryConfig.srm_extension_key_suffix">
|
|
<em class="property">property </em><code class="sig-name descname">srm_extension_key_suffix</code><a class="headerlink" href="#vmware.vmc_draas.models.activate_site_recovery_config.ActivateSiteRecoveryConfig.srm_extension_key_suffix" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the srm_extension_key_suffix of this ActivateSiteRecoveryConfig. # noqa: E501</p>
|
|
<p>Optional custom extension key suffix for SRM. If not specified, 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. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The srm_extension_key_suffix of this ActivateSiteRecoveryConfig. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.activate_site_recovery_config.ActivateSiteRecoveryConfig.to_dict">
|
|
<code class="sig-name descname">to_dict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.activate_site_recovery_config.ActivateSiteRecoveryConfig.to_dict" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the model properties as a dict</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.activate_site_recovery_config.ActivateSiteRecoveryConfig.to_str">
|
|
<code class="sig-name descname">to_str</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.activate_site_recovery_config.ActivateSiteRecoveryConfig.to_str" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the string representation of the model</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-vmware.vmc_draas.models.error_response">
|
|
<span id="vmware-vmc-draas-models-error-response-module"></span><h2>vmware.vmc_draas.models.error_response module<a class="headerlink" href="#module-vmware.vmc_draas.models.error_response" title="Permalink to this headline">¶</a></h2>
|
|
<p>VMC DRaaS APIs</p>
|
|
<ul class="simple">
|
|
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>   <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>       <span class="pre">-d</span> <span class="pre">"refresh_token=${REFRESH_TOKEN}"</span> <span class="pre">\</span>       <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize</span> <span class="pre">|</span> <span class="pre">jq</span> <span class="pre">-r</span> <span class="pre">.access_token</span>   <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field * Most VMC DRaaS APIs require a sddc identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs/{org}/sddcs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
|
|
</ul>
|
|
<p>The version of the OpenAPI document: 1.0
|
|
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</span>com</a>
|
|
Generated by: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<dl class="py class">
|
|
<dt id="vmware.vmc_draas.models.error_response.ErrorResponse">
|
|
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc_draas.models.error_response.</code><code class="sig-name descname">ErrorResponse</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">retryable</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_code</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_messages</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">local_vars_configuration</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.error_response.ErrorResponse" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>NOTE: This class is auto generated by OpenAPI Generator.
|
|
Ref: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<p>Do not edit the class manually.</p>
|
|
<p>ErrorResponse - a model defined in OpenAPI</p>
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.error_response.ErrorResponse.attribute_map">
|
|
<code class="sig-name descname">attribute_map</code><em class="property"> = {'error_code': 'error_code', 'error_messages': 'error_messages', 'path': 'path', 'retryable': 'retryable', 'status': 'status'}</em><a class="headerlink" href="#vmware.vmc_draas.models.error_response.ErrorResponse.attribute_map" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.error_response.ErrorResponse.error_code">
|
|
<em class="property">property </em><code class="sig-name descname">error_code</code><a class="headerlink" href="#vmware.vmc_draas.models.error_response.ErrorResponse.error_code" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the error_code of this ErrorResponse. # noqa: E501</p>
|
|
<p>unique error code # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The error_code of this ErrorResponse. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.error_response.ErrorResponse.error_messages">
|
|
<em class="property">property </em><code class="sig-name descname">error_messages</code><a class="headerlink" href="#vmware.vmc_draas.models.error_response.ErrorResponse.error_messages" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the error_messages of this ErrorResponse. # noqa: E501</p>
|
|
<p>localized error messages # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The error_messages of this ErrorResponse. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>list[str]</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.error_response.ErrorResponse.openapi_types">
|
|
<code class="sig-name descname">openapi_types</code><em class="property"> = {'error_code': 'str', 'error_messages': 'list[str]', 'path': 'str', 'retryable': 'bool', 'status': 'int'}</em><a class="headerlink" href="#vmware.vmc_draas.models.error_response.ErrorResponse.openapi_types" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.error_response.ErrorResponse.path">
|
|
<em class="property">property </em><code class="sig-name descname">path</code><a class="headerlink" href="#vmware.vmc_draas.models.error_response.ErrorResponse.path" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the path of this ErrorResponse. # noqa: E501</p>
|
|
<p>Originating request URI # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The path of this ErrorResponse. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.error_response.ErrorResponse.retryable">
|
|
<em class="property">property </em><code class="sig-name descname">retryable</code><a class="headerlink" href="#vmware.vmc_draas.models.error_response.ErrorResponse.retryable" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the retryable of this ErrorResponse. # noqa: E501</p>
|
|
<p>If true, client should retry operation # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The retryable of this ErrorResponse. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>bool</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.error_response.ErrorResponse.status">
|
|
<em class="property">property </em><code class="sig-name descname">status</code><a class="headerlink" href="#vmware.vmc_draas.models.error_response.ErrorResponse.status" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the status of this ErrorResponse. # noqa: E501</p>
|
|
<p>HTTP status code # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The status of this ErrorResponse. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>int</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.error_response.ErrorResponse.to_dict">
|
|
<code class="sig-name descname">to_dict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.error_response.ErrorResponse.to_dict" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the model properties as a dict</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.error_response.ErrorResponse.to_str">
|
|
<code class="sig-name descname">to_str</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.error_response.ErrorResponse.to_str" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the string representation of the model</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-vmware.vmc_draas.models.provision_srm_config">
|
|
<span id="vmware-vmc-draas-models-provision-srm-config-module"></span><h2>vmware.vmc_draas.models.provision_srm_config module<a class="headerlink" href="#module-vmware.vmc_draas.models.provision_srm_config" title="Permalink to this headline">¶</a></h2>
|
|
<p>VMC DRaaS APIs</p>
|
|
<ul class="simple">
|
|
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>   <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>       <span class="pre">-d</span> <span class="pre">"refresh_token=${REFRESH_TOKEN}"</span> <span class="pre">\</span>       <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize</span> <span class="pre">|</span> <span class="pre">jq</span> <span class="pre">-r</span> <span class="pre">.access_token</span>   <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field * Most VMC DRaaS APIs require a sddc identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs/{org}/sddcs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
|
|
</ul>
|
|
<p>The version of the OpenAPI document: 1.0
|
|
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</span>com</a>
|
|
Generated by: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<dl class="py class">
|
|
<dt id="vmware.vmc_draas.models.provision_srm_config.ProvisionSrmConfig">
|
|
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc_draas.models.provision_srm_config.</code><code class="sig-name descname">ProvisionSrmConfig</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">srm_extension_key_suffix</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">local_vars_configuration</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.provision_srm_config.ProvisionSrmConfig" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>NOTE: This class is auto generated by OpenAPI Generator.
|
|
Ref: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<p>Do not edit the class manually.</p>
|
|
<p>ProvisionSrmConfig - a model defined in OpenAPI</p>
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.provision_srm_config.ProvisionSrmConfig.attribute_map">
|
|
<code class="sig-name descname">attribute_map</code><em class="property"> = {'srm_extension_key_suffix': 'srm_extension_key_suffix'}</em><a class="headerlink" href="#vmware.vmc_draas.models.provision_srm_config.ProvisionSrmConfig.attribute_map" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.provision_srm_config.ProvisionSrmConfig.openapi_types">
|
|
<code class="sig-name descname">openapi_types</code><em class="property"> = {'srm_extension_key_suffix': 'str'}</em><a class="headerlink" href="#vmware.vmc_draas.models.provision_srm_config.ProvisionSrmConfig.openapi_types" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.provision_srm_config.ProvisionSrmConfig.srm_extension_key_suffix">
|
|
<em class="property">property </em><code class="sig-name descname">srm_extension_key_suffix</code><a class="headerlink" href="#vmware.vmc_draas.models.provision_srm_config.ProvisionSrmConfig.srm_extension_key_suffix" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the srm_extension_key_suffix of this ProvisionSrmConfig. # noqa: E501</p>
|
|
<p>Optional custom extension key suffix for SRM. If not specified, default extension key will be used. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The srm_extension_key_suffix of this ProvisionSrmConfig. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.provision_srm_config.ProvisionSrmConfig.to_dict">
|
|
<code class="sig-name descname">to_dict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.provision_srm_config.ProvisionSrmConfig.to_dict" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the model properties as a dict</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.provision_srm_config.ProvisionSrmConfig.to_str">
|
|
<code class="sig-name descname">to_str</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.provision_srm_config.ProvisionSrmConfig.to_str" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the string representation of the model</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-vmware.vmc_draas.models.replica_disk">
|
|
<span id="vmware-vmc-draas-models-replica-disk-module"></span><h2>vmware.vmc_draas.models.replica_disk module<a class="headerlink" href="#module-vmware.vmc_draas.models.replica_disk" title="Permalink to this headline">¶</a></h2>
|
|
<p>VMC DRaaS APIs</p>
|
|
<ul class="simple">
|
|
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>   <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>       <span class="pre">-d</span> <span class="pre">"refresh_token=${REFRESH_TOKEN}"</span> <span class="pre">\</span>       <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize</span> <span class="pre">|</span> <span class="pre">jq</span> <span class="pre">-r</span> <span class="pre">.access_token</span>   <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field * Most VMC DRaaS APIs require a sddc identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs/{org}/sddcs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
|
|
</ul>
|
|
<p>The version of the OpenAPI document: 1.0
|
|
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</span>com</a>
|
|
Generated by: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<dl class="py class">
|
|
<dt id="vmware.vmc_draas.models.replica_disk.ReplicaDisk">
|
|
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc_draas.models.replica_disk.</code><code class="sig-name descname">ReplicaDisk</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">space_requirement</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">collection_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">datastores_for_single_host_move</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">movable</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">disk_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">datastore_mo_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">local_vars_configuration</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk.ReplicaDisk" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>NOTE: This class is auto generated by OpenAPI Generator.
|
|
Ref: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<p>Do not edit the class manually.</p>
|
|
<p>ReplicaDisk - a model defined in OpenAPI</p>
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.replica_disk.ReplicaDisk.attribute_map">
|
|
<code class="sig-name descname">attribute_map</code><em class="property"> = {'collection_id': 'collection_id', 'datastore_mo_id': 'datastore_mo_id', 'datastores_for_single_host_move': 'datastores_for_single_host_move', 'disk_id': 'disk_id', 'movable': 'movable', 'name': 'name', 'space_requirement': 'space_requirement'}</em><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk.ReplicaDisk.attribute_map" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.replica_disk.ReplicaDisk.collection_id">
|
|
<em class="property">property </em><code class="sig-name descname">collection_id</code><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk.ReplicaDisk.collection_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the collection_id of this ReplicaDisk. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The collection_id of this ReplicaDisk. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.replica_disk.ReplicaDisk.datastore_mo_id">
|
|
<em class="property">property </em><code class="sig-name descname">datastore_mo_id</code><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk.ReplicaDisk.datastore_mo_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the datastore_mo_id of this ReplicaDisk. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The datastore_mo_id of this ReplicaDisk. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.replica_disk.ReplicaDisk.datastores_for_single_host_move">
|
|
<em class="property">property </em><code class="sig-name descname">datastores_for_single_host_move</code><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk.ReplicaDisk.datastores_for_single_host_move" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the datastores_for_single_host_move of this ReplicaDisk. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The datastores_for_single_host_move of this ReplicaDisk. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>list[object]</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.replica_disk.ReplicaDisk.disk_id">
|
|
<em class="property">property </em><code class="sig-name descname">disk_id</code><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk.ReplicaDisk.disk_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the disk_id of this ReplicaDisk. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The disk_id of this ReplicaDisk. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.replica_disk.ReplicaDisk.movable">
|
|
<em class="property">property </em><code class="sig-name descname">movable</code><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk.ReplicaDisk.movable" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the movable of this ReplicaDisk. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The movable of this ReplicaDisk. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>bool</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.replica_disk.ReplicaDisk.name">
|
|
<em class="property">property </em><code class="sig-name descname">name</code><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk.ReplicaDisk.name" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the name of this ReplicaDisk. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The name of this ReplicaDisk. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.replica_disk.ReplicaDisk.openapi_types">
|
|
<code class="sig-name descname">openapi_types</code><em class="property"> = {'collection_id': 'str', 'datastore_mo_id': 'str', 'datastores_for_single_host_move': 'list[object]', 'disk_id': 'str', 'movable': 'bool', 'name': 'str', 'space_requirement': 'float'}</em><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk.ReplicaDisk.openapi_types" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.replica_disk.ReplicaDisk.space_requirement">
|
|
<em class="property">property </em><code class="sig-name descname">space_requirement</code><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk.ReplicaDisk.space_requirement" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the space_requirement of this ReplicaDisk. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The space_requirement of this ReplicaDisk. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>float</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.replica_disk.ReplicaDisk.to_dict">
|
|
<code class="sig-name descname">to_dict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk.ReplicaDisk.to_dict" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the model properties as a dict</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.replica_disk.ReplicaDisk.to_str">
|
|
<code class="sig-name descname">to_str</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk.ReplicaDisk.to_str" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the string representation of the model</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-vmware.vmc_draas.models.replica_disk_collection">
|
|
<span id="vmware-vmc-draas-models-replica-disk-collection-module"></span><h2>vmware.vmc_draas.models.replica_disk_collection module<a class="headerlink" href="#module-vmware.vmc_draas.models.replica_disk_collection" title="Permalink to this headline">¶</a></h2>
|
|
<p>VMC DRaaS APIs</p>
|
|
<ul class="simple">
|
|
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>   <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>       <span class="pre">-d</span> <span class="pre">"refresh_token=${REFRESH_TOKEN}"</span> <span class="pre">\</span>       <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize</span> <span class="pre">|</span> <span class="pre">jq</span> <span class="pre">-r</span> <span class="pre">.access_token</span>   <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field * Most VMC DRaaS APIs require a sddc identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs/{org}/sddcs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
|
|
</ul>
|
|
<p>The version of the OpenAPI document: 1.0
|
|
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</span>com</a>
|
|
Generated by: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<dl class="py class">
|
|
<dt id="vmware.vmc_draas.models.replica_disk_collection.ReplicaDiskCollection">
|
|
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc_draas.models.replica_disk_collection.</code><code class="sig-name descname">ReplicaDiskCollection</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">collection_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">generated</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">disks</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">placeholder_vm_mo_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">local_vars_configuration</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk_collection.ReplicaDiskCollection" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>NOTE: This class is auto generated by OpenAPI Generator.
|
|
Ref: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<p>Do not edit the class manually.</p>
|
|
<p>ReplicaDiskCollection - a model defined in OpenAPI</p>
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.replica_disk_collection.ReplicaDiskCollection.attribute_map">
|
|
<code class="sig-name descname">attribute_map</code><em class="property"> = {'collection_id': 'collection_id', 'disks': 'disks', 'generated': 'generated', 'name': 'name', 'placeholder_vm_mo_id': 'placeholder_vm_mo_id'}</em><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk_collection.ReplicaDiskCollection.attribute_map" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.replica_disk_collection.ReplicaDiskCollection.collection_id">
|
|
<em class="property">property </em><code class="sig-name descname">collection_id</code><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk_collection.ReplicaDiskCollection.collection_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the collection_id of this ReplicaDiskCollection. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The collection_id of this ReplicaDiskCollection. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.replica_disk_collection.ReplicaDiskCollection.disks">
|
|
<em class="property">property </em><code class="sig-name descname">disks</code><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk_collection.ReplicaDiskCollection.disks" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the disks of this ReplicaDiskCollection. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The disks of this ReplicaDiskCollection. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>list[<a class="reference internal" href="#vmware.vmc_draas.models.replica_disk.ReplicaDisk" title="vmware.vmc_draas.models.replica_disk.ReplicaDisk">ReplicaDisk</a>]</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.replica_disk_collection.ReplicaDiskCollection.generated">
|
|
<em class="property">property </em><code class="sig-name descname">generated</code><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk_collection.ReplicaDiskCollection.generated" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the generated of this ReplicaDiskCollection. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The generated of this ReplicaDiskCollection. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>datetime</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.replica_disk_collection.ReplicaDiskCollection.name">
|
|
<em class="property">property </em><code class="sig-name descname">name</code><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk_collection.ReplicaDiskCollection.name" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the name of this ReplicaDiskCollection. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The name of this ReplicaDiskCollection. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.replica_disk_collection.ReplicaDiskCollection.openapi_types">
|
|
<code class="sig-name descname">openapi_types</code><em class="property"> = {'collection_id': 'str', 'disks': 'list[ReplicaDisk]', 'generated': 'datetime', 'name': 'str', 'placeholder_vm_mo_id': 'str'}</em><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk_collection.ReplicaDiskCollection.openapi_types" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.replica_disk_collection.ReplicaDiskCollection.placeholder_vm_mo_id">
|
|
<em class="property">property </em><code class="sig-name descname">placeholder_vm_mo_id</code><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk_collection.ReplicaDiskCollection.placeholder_vm_mo_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the placeholder_vm_mo_id of this ReplicaDiskCollection. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The placeholder_vm_mo_id of this ReplicaDiskCollection. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.replica_disk_collection.ReplicaDiskCollection.to_dict">
|
|
<code class="sig-name descname">to_dict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk_collection.ReplicaDiskCollection.to_dict" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the model properties as a dict</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.replica_disk_collection.ReplicaDiskCollection.to_str">
|
|
<code class="sig-name descname">to_str</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.replica_disk_collection.ReplicaDiskCollection.to_str" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the string representation of the model</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-vmware.vmc_draas.models.site_recovery">
|
|
<span id="vmware-vmc-draas-models-site-recovery-module"></span><h2>vmware.vmc_draas.models.site_recovery module<a class="headerlink" href="#module-vmware.vmc_draas.models.site_recovery" title="Permalink to this headline">¶</a></h2>
|
|
<p>VMC DRaaS APIs</p>
|
|
<ul class="simple">
|
|
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>   <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>       <span class="pre">-d</span> <span class="pre">"refresh_token=${REFRESH_TOKEN}"</span> <span class="pre">\</span>       <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize</span> <span class="pre">|</span> <span class="pre">jq</span> <span class="pre">-r</span> <span class="pre">.access_token</span>   <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field * Most VMC DRaaS APIs require a sddc identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs/{org}/sddcs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
|
|
</ul>
|
|
<p>The version of the OpenAPI document: 1.0
|
|
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</span>com</a>
|
|
Generated by: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<dl class="py class">
|
|
<dt id="vmware.vmc_draas.models.site_recovery.SiteRecovery">
|
|
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc_draas.models.site_recovery.</code><code class="sig-name descname">SiteRecovery</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">updated</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">user_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">created</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">updated_by_user_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">updated_by_user_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">user_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">site_recovery_state</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vr_node</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">srm_nodes</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sddc_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">draas_h5_url</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">local_vars_configuration</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery.SiteRecovery" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>NOTE: This class is auto generated by OpenAPI Generator.
|
|
Ref: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<p>Do not edit the class manually.</p>
|
|
<p>SiteRecovery - a model defined in OpenAPI</p>
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.site_recovery.SiteRecovery.attribute_map">
|
|
<code class="sig-name descname">attribute_map</code><em class="property"> = {'created': 'created', 'draas_h5_url': 'draas_h5_url', 'id': 'id', 'sddc_id': 'sddc_id', 'site_recovery_state': 'site_recovery_state', 'srm_nodes': 'srm_nodes', 'updated': 'updated', 'updated_by_user_id': 'updated_by_user_id', 'updated_by_user_name': 'updated_by_user_name', 'user_id': 'user_id', 'user_name': 'user_name', 'version': 'version', 'vr_node': 'vr_node'}</em><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery.SiteRecovery.attribute_map" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery.SiteRecovery.created">
|
|
<em class="property">property </em><code class="sig-name descname">created</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery.SiteRecovery.created" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the created of this SiteRecovery. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The created of this SiteRecovery. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>datetime</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery.SiteRecovery.draas_h5_url">
|
|
<em class="property">property </em><code class="sig-name descname">draas_h5_url</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery.SiteRecovery.draas_h5_url" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the draas_h5_url of this SiteRecovery. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The draas_h5_url of this SiteRecovery. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery.SiteRecovery.id">
|
|
<em class="property">property </em><code class="sig-name descname">id</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery.SiteRecovery.id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the id of this SiteRecovery. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The id of this SiteRecovery. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.site_recovery.SiteRecovery.openapi_types">
|
|
<code class="sig-name descname">openapi_types</code><em class="property"> = {'created': 'datetime', 'draas_h5_url': 'str', 'id': 'str', 'sddc_id': 'str', 'site_recovery_state': 'str', 'srm_nodes': 'list[SiteRecoveryNode]', 'updated': 'datetime', 'updated_by_user_id': 'str', 'updated_by_user_name': 'str', 'user_id': 'str', 'user_name': 'str', 'version': 'int', 'vr_node': 'SiteRecoveryNode'}</em><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery.SiteRecovery.openapi_types" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery.SiteRecovery.sddc_id">
|
|
<em class="property">property </em><code class="sig-name descname">sddc_id</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery.SiteRecovery.sddc_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the sddc_id of this SiteRecovery. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The sddc_id of this SiteRecovery. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery.SiteRecovery.site_recovery_state">
|
|
<em class="property">property </em><code class="sig-name descname">site_recovery_state</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery.SiteRecovery.site_recovery_state" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the site_recovery_state of this SiteRecovery. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The site_recovery_state of this SiteRecovery. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery.SiteRecovery.srm_nodes">
|
|
<em class="property">property </em><code class="sig-name descname">srm_nodes</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery.SiteRecovery.srm_nodes" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the srm_nodes of this SiteRecovery. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The srm_nodes of this SiteRecovery. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>list[<a class="reference internal" href="#vmware.vmc_draas.models.site_recovery_node.SiteRecoveryNode" title="vmware.vmc_draas.models.site_recovery_node.SiteRecoveryNode">SiteRecoveryNode</a>]</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery.SiteRecovery.to_dict">
|
|
<code class="sig-name descname">to_dict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery.SiteRecovery.to_dict" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the model properties as a dict</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery.SiteRecovery.to_str">
|
|
<code class="sig-name descname">to_str</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery.SiteRecovery.to_str" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the string representation of the model</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery.SiteRecovery.updated">
|
|
<em class="property">property </em><code class="sig-name descname">updated</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery.SiteRecovery.updated" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the updated of this SiteRecovery. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The updated of this SiteRecovery. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>datetime</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery.SiteRecovery.updated_by_user_id">
|
|
<em class="property">property </em><code class="sig-name descname">updated_by_user_id</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery.SiteRecovery.updated_by_user_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the updated_by_user_id of this SiteRecovery. # noqa: E501</p>
|
|
<p>User id that last updated this record # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The updated_by_user_id of this SiteRecovery. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery.SiteRecovery.updated_by_user_name">
|
|
<em class="property">property </em><code class="sig-name descname">updated_by_user_name</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery.SiteRecovery.updated_by_user_name" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the updated_by_user_name of this SiteRecovery. # noqa: E501</p>
|
|
<p>User name that last updated this record # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The updated_by_user_name of this SiteRecovery. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery.SiteRecovery.user_id">
|
|
<em class="property">property </em><code class="sig-name descname">user_id</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery.SiteRecovery.user_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the user_id of this SiteRecovery. # noqa: E501</p>
|
|
<p>User id that last updated this record # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The user_id of this SiteRecovery. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery.SiteRecovery.user_name">
|
|
<em class="property">property </em><code class="sig-name descname">user_name</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery.SiteRecovery.user_name" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the user_name of this SiteRecovery. # noqa: E501</p>
|
|
<p>User name that last updated this record # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The user_name of this SiteRecovery. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery.SiteRecovery.version">
|
|
<em class="property">property </em><code class="sig-name descname">version</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery.SiteRecovery.version" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the version of this SiteRecovery. # noqa: E501</p>
|
|
<p>Version of this entity # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The version of this SiteRecovery. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>int</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery.SiteRecovery.vr_node">
|
|
<em class="property">property </em><code class="sig-name descname">vr_node</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery.SiteRecovery.vr_node" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the vr_node of this SiteRecovery. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The vr_node of this SiteRecovery. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p><a class="reference internal" href="#vmware.vmc_draas.models.site_recovery_node.SiteRecoveryNode" title="vmware.vmc_draas.models.site_recovery_node.SiteRecoveryNode">SiteRecoveryNode</a></p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-vmware.vmc_draas.models.site_recovery_all_of">
|
|
<span id="vmware-vmc-draas-models-site-recovery-all-of-module"></span><h2>vmware.vmc_draas.models.site_recovery_all_of module<a class="headerlink" href="#module-vmware.vmc_draas.models.site_recovery_all_of" title="Permalink to this headline">¶</a></h2>
|
|
<p>VMC DRaaS APIs</p>
|
|
<ul class="simple">
|
|
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>   <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>       <span class="pre">-d</span> <span class="pre">"refresh_token=${REFRESH_TOKEN}"</span> <span class="pre">\</span>       <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize</span> <span class="pre">|</span> <span class="pre">jq</span> <span class="pre">-r</span> <span class="pre">.access_token</span>   <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field * Most VMC DRaaS APIs require a sddc identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs/{org}/sddcs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
|
|
</ul>
|
|
<p>The version of the OpenAPI document: 1.0
|
|
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</span>com</a>
|
|
Generated by: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<dl class="py class">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_all_of.SiteRecoveryAllOf">
|
|
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc_draas.models.site_recovery_all_of.</code><code class="sig-name descname">SiteRecoveryAllOf</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">site_recovery_state</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">vr_node</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">srm_nodes</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sddc_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">draas_h5_url</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">local_vars_configuration</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_all_of.SiteRecoveryAllOf" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>NOTE: This class is auto generated by OpenAPI Generator.
|
|
Ref: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<p>Do not edit the class manually.</p>
|
|
<p>SiteRecoveryAllOf - a model defined in OpenAPI</p>
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_all_of.SiteRecoveryAllOf.attribute_map">
|
|
<code class="sig-name descname">attribute_map</code><em class="property"> = {'draas_h5_url': 'draas_h5_url', 'sddc_id': 'sddc_id', 'site_recovery_state': 'site_recovery_state', 'srm_nodes': 'srm_nodes', 'vr_node': 'vr_node'}</em><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_all_of.SiteRecoveryAllOf.attribute_map" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_all_of.SiteRecoveryAllOf.draas_h5_url">
|
|
<em class="property">property </em><code class="sig-name descname">draas_h5_url</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_all_of.SiteRecoveryAllOf.draas_h5_url" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the draas_h5_url of this SiteRecoveryAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The draas_h5_url of this SiteRecoveryAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_all_of.SiteRecoveryAllOf.openapi_types">
|
|
<code class="sig-name descname">openapi_types</code><em class="property"> = {'draas_h5_url': 'str', 'sddc_id': 'str', 'site_recovery_state': 'str', 'srm_nodes': 'list[SiteRecoveryNode]', 'vr_node': 'SiteRecoveryNode'}</em><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_all_of.SiteRecoveryAllOf.openapi_types" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_all_of.SiteRecoveryAllOf.sddc_id">
|
|
<em class="property">property </em><code class="sig-name descname">sddc_id</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_all_of.SiteRecoveryAllOf.sddc_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the sddc_id of this SiteRecoveryAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The sddc_id of this SiteRecoveryAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_all_of.SiteRecoveryAllOf.site_recovery_state">
|
|
<em class="property">property </em><code class="sig-name descname">site_recovery_state</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_all_of.SiteRecoveryAllOf.site_recovery_state" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the site_recovery_state of this SiteRecoveryAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The site_recovery_state of this SiteRecoveryAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_all_of.SiteRecoveryAllOf.srm_nodes">
|
|
<em class="property">property </em><code class="sig-name descname">srm_nodes</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_all_of.SiteRecoveryAllOf.srm_nodes" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the srm_nodes of this SiteRecoveryAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The srm_nodes of this SiteRecoveryAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>list[<a class="reference internal" href="#vmware.vmc_draas.models.site_recovery_node.SiteRecoveryNode" title="vmware.vmc_draas.models.site_recovery_node.SiteRecoveryNode">SiteRecoveryNode</a>]</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_all_of.SiteRecoveryAllOf.to_dict">
|
|
<code class="sig-name descname">to_dict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_all_of.SiteRecoveryAllOf.to_dict" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the model properties as a dict</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_all_of.SiteRecoveryAllOf.to_str">
|
|
<code class="sig-name descname">to_str</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_all_of.SiteRecoveryAllOf.to_str" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the string representation of the model</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_all_of.SiteRecoveryAllOf.vr_node">
|
|
<em class="property">property </em><code class="sig-name descname">vr_node</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_all_of.SiteRecoveryAllOf.vr_node" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the vr_node of this SiteRecoveryAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The vr_node of this SiteRecoveryAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p><a class="reference internal" href="#vmware.vmc_draas.models.site_recovery_node.SiteRecoveryNode" title="vmware.vmc_draas.models.site_recovery_node.SiteRecoveryNode">SiteRecoveryNode</a></p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-vmware.vmc_draas.models.site_recovery_node">
|
|
<span id="vmware-vmc-draas-models-site-recovery-node-module"></span><h2>vmware.vmc_draas.models.site_recovery_node module<a class="headerlink" href="#module-vmware.vmc_draas.models.site_recovery_node" title="Permalink to this headline">¶</a></h2>
|
|
<p>VMC DRaaS APIs</p>
|
|
<ul class="simple">
|
|
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>   <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>       <span class="pre">-d</span> <span class="pre">"refresh_token=${REFRESH_TOKEN}"</span> <span class="pre">\</span>       <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize</span> <span class="pre">|</span> <span class="pre">jq</span> <span class="pre">-r</span> <span class="pre">.access_token</span>   <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field * Most VMC DRaaS APIs require a sddc identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs/{org}/sddcs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
|
|
</ul>
|
|
<p>The version of the OpenAPI document: 1.0
|
|
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</span>com</a>
|
|
Generated by: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<dl class="py class">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node.SiteRecoveryNode">
|
|
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc_draas.models.site_recovery_node.</code><code class="sig-name descname">SiteRecoveryNode</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">local_vars_configuration</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node.SiteRecoveryNode" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>NOTE: This class is auto generated by OpenAPI Generator.
|
|
Ref: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<p>Do not edit the class manually.</p>
|
|
<p>SiteRecoveryNode - a model defined in OpenAPI</p>
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node.SiteRecoveryNode.attribute_map">
|
|
<code class="sig-name descname">attribute_map</code><em class="property"> = {}</em><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node.SiteRecoveryNode.attribute_map" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node.SiteRecoveryNode.openapi_types">
|
|
<code class="sig-name descname">openapi_types</code><em class="property"> = {}</em><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node.SiteRecoveryNode.openapi_types" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node.SiteRecoveryNode.to_dict">
|
|
<code class="sig-name descname">to_dict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node.SiteRecoveryNode.to_dict" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the model properties as a dict</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node.SiteRecoveryNode.to_str">
|
|
<code class="sig-name descname">to_str</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node.SiteRecoveryNode.to_str" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the string representation of the model</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-vmware.vmc_draas.models.site_recovery_node_all_of">
|
|
<span id="vmware-vmc-draas-models-site-recovery-node-all-of-module"></span><h2>vmware.vmc_draas.models.site_recovery_node_all_of module<a class="headerlink" href="#module-vmware.vmc_draas.models.site_recovery_node_all_of" title="Permalink to this headline">¶</a></h2>
|
|
<p>VMC DRaaS APIs</p>
|
|
<ul class="simple">
|
|
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>   <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>       <span class="pre">-d</span> <span class="pre">"refresh_token=${REFRESH_TOKEN}"</span> <span class="pre">\</span>       <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize</span> <span class="pre">|</span> <span class="pre">jq</span> <span class="pre">-r</span> <span class="pre">.access_token</span>   <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field * Most VMC DRaaS APIs require a sddc identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs/{org}/sddcs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
|
|
</ul>
|
|
<p>The version of the OpenAPI document: 1.0
|
|
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</span>com</a>
|
|
Generated by: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<dl class="py class">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf">
|
|
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc_draas.models.site_recovery_node_all_of.</code><code class="sig-name descname">SiteRecoveryNodeAllOf</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vm_moref_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">ip_address</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">hostname</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">state</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">local_vars_configuration</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>NOTE: This class is auto generated by OpenAPI Generator.
|
|
Ref: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<p>Do not edit the class manually.</p>
|
|
<p>SiteRecoveryNodeAllOf - a model defined in OpenAPI</p>
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf.attribute_map">
|
|
<code class="sig-name descname">attribute_map</code><em class="property"> = {'hostname': 'hostname', 'id': 'id', 'ip_address': 'ip_address', 'state': 'state', 'type': 'type', 'vm_moref_id': 'vm_moref_id'}</em><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf.attribute_map" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf.hostname">
|
|
<em class="property">property </em><code class="sig-name descname">hostname</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf.hostname" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the hostname of this SiteRecoveryNodeAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The hostname of this SiteRecoveryNodeAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf.id">
|
|
<em class="property">property </em><code class="sig-name descname">id</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf.id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the id of this SiteRecoveryNodeAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The id of this SiteRecoveryNodeAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf.ip_address">
|
|
<em class="property">property </em><code class="sig-name descname">ip_address</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf.ip_address" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the ip_address of this SiteRecoveryNodeAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The ip_address of this SiteRecoveryNodeAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf.openapi_types">
|
|
<code class="sig-name descname">openapi_types</code><em class="property"> = {'hostname': 'str', 'id': 'str', 'ip_address': 'str', 'state': 'str', 'type': 'str', 'vm_moref_id': 'str'}</em><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf.openapi_types" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf.state">
|
|
<em class="property">property </em><code class="sig-name descname">state</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf.state" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the state of this SiteRecoveryNodeAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The state of this SiteRecoveryNodeAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf.to_dict">
|
|
<code class="sig-name descname">to_dict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf.to_dict" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the model properties as a dict</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf.to_str">
|
|
<code class="sig-name descname">to_str</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf.to_str" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the string representation of the model</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf.type">
|
|
<em class="property">property </em><code class="sig-name descname">type</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf.type" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the type of this SiteRecoveryNodeAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The type of this SiteRecoveryNodeAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf.vm_moref_id">
|
|
<em class="property">property </em><code class="sig-name descname">vm_moref_id</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_all_of.SiteRecoveryNodeAllOf.vm_moref_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the vm_moref_id of this SiteRecoveryNodeAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The vm_moref_id of this SiteRecoveryNodeAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-vmware.vmc_draas.models.site_recovery_node_version">
|
|
<span id="vmware-vmc-draas-models-site-recovery-node-version-module"></span><h2>vmware.vmc_draas.models.site_recovery_node_version module<a class="headerlink" href="#module-vmware.vmc_draas.models.site_recovery_node_version" title="Permalink to this headline">¶</a></h2>
|
|
<p>VMC DRaaS APIs</p>
|
|
<ul class="simple">
|
|
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>   <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>       <span class="pre">-d</span> <span class="pre">"refresh_token=${REFRESH_TOKEN}"</span> <span class="pre">\</span>       <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize</span> <span class="pre">|</span> <span class="pre">jq</span> <span class="pre">-r</span> <span class="pre">.access_token</span>   <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field * Most VMC DRaaS APIs require a sddc identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs/{org}/sddcs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
|
|
</ul>
|
|
<p>The version of the OpenAPI document: 1.0
|
|
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</span>com</a>
|
|
Generated by: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<dl class="py class">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion">
|
|
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc_draas.models.site_recovery_node_version.</code><code class="sig-name descname">SiteRecoveryNodeVersion</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">version_source</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">node_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">build_number</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">appliance_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">node_ip</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">full_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">node_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">local_vars_configuration</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>NOTE: This class is auto generated by OpenAPI Generator.
|
|
Ref: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<p>Do not edit the class manually.</p>
|
|
<p>SiteRecoveryNodeVersion - a model defined in OpenAPI</p>
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.appliance_version">
|
|
<em class="property">property </em><code class="sig-name descname">appliance_version</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.appliance_version" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the appliance_version of this SiteRecoveryNodeVersion. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The appliance_version of this SiteRecoveryNodeVersion. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.attribute_map">
|
|
<code class="sig-name descname">attribute_map</code><em class="property"> = {'appliance_version': 'appliance_version', 'build_number': 'build_number', 'full_version': 'full_version', 'node_id': 'node_id', 'node_ip': 'node_ip', 'node_type': 'node_type', 'version_source': 'version_source'}</em><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.attribute_map" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.build_number">
|
|
<em class="property">property </em><code class="sig-name descname">build_number</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.build_number" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the build_number of this SiteRecoveryNodeVersion. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The build_number of this SiteRecoveryNodeVersion. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.full_version">
|
|
<em class="property">property </em><code class="sig-name descname">full_version</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.full_version" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the full_version of this SiteRecoveryNodeVersion. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The full_version of this SiteRecoveryNodeVersion. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.node_id">
|
|
<em class="property">property </em><code class="sig-name descname">node_id</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.node_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the node_id of this SiteRecoveryNodeVersion. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The node_id of this SiteRecoveryNodeVersion. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.node_ip">
|
|
<em class="property">property </em><code class="sig-name descname">node_ip</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.node_ip" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the node_ip of this SiteRecoveryNodeVersion. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The node_ip of this SiteRecoveryNodeVersion. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.node_type">
|
|
<em class="property">property </em><code class="sig-name descname">node_type</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.node_type" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the node_type of this SiteRecoveryNodeVersion. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The node_type of this SiteRecoveryNodeVersion. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.openapi_types">
|
|
<code class="sig-name descname">openapi_types</code><em class="property"> = {'appliance_version': 'str', 'build_number': 'str', 'full_version': 'str', 'node_id': 'str', 'node_ip': 'str', 'node_type': 'str', 'version_source': 'str'}</em><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.openapi_types" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.to_dict">
|
|
<code class="sig-name descname">to_dict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.to_dict" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the model properties as a dict</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.to_str">
|
|
<code class="sig-name descname">to_str</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.to_str" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the string representation of the model</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.version_source">
|
|
<em class="property">property </em><code class="sig-name descname">version_source</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion.version_source" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the version_source of this SiteRecoveryNodeVersion. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The version_source of this SiteRecoveryNodeVersion. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-vmware.vmc_draas.models.site_recovery_versions">
|
|
<span id="vmware-vmc-draas-models-site-recovery-versions-module"></span><h2>vmware.vmc_draas.models.site_recovery_versions module<a class="headerlink" href="#module-vmware.vmc_draas.models.site_recovery_versions" title="Permalink to this headline">¶</a></h2>
|
|
<p>VMC DRaaS APIs</p>
|
|
<ul class="simple">
|
|
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>   <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>       <span class="pre">-d</span> <span class="pre">"refresh_token=${REFRESH_TOKEN}"</span> <span class="pre">\</span>       <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize</span> <span class="pre">|</span> <span class="pre">jq</span> <span class="pre">-r</span> <span class="pre">.access_token</span>   <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field * Most VMC DRaaS APIs require a sddc identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs/{org}/sddcs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
|
|
</ul>
|
|
<p>The version of the OpenAPI document: 1.0
|
|
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</span>com</a>
|
|
Generated by: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<dl class="py class">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_versions.SiteRecoveryVersions">
|
|
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc_draas.models.site_recovery_versions.</code><code class="sig-name descname">SiteRecoveryVersions</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">generated</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sddc_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">node_versions</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">local_vars_configuration</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_versions.SiteRecoveryVersions" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>NOTE: This class is auto generated by OpenAPI Generator.
|
|
Ref: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<p>Do not edit the class manually.</p>
|
|
<p>SiteRecoveryVersions - a model defined in OpenAPI</p>
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_versions.SiteRecoveryVersions.attribute_map">
|
|
<code class="sig-name descname">attribute_map</code><em class="property"> = {'generated': 'generated', 'node_versions': 'node_versions', 'sddc_id': 'sddc_id'}</em><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_versions.SiteRecoveryVersions.attribute_map" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_versions.SiteRecoveryVersions.generated">
|
|
<em class="property">property </em><code class="sig-name descname">generated</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_versions.SiteRecoveryVersions.generated" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the generated of this SiteRecoveryVersions. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The generated of this SiteRecoveryVersions. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>datetime</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_versions.SiteRecoveryVersions.node_versions">
|
|
<em class="property">property </em><code class="sig-name descname">node_versions</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_versions.SiteRecoveryVersions.node_versions" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the node_versions of this SiteRecoveryVersions. # noqa: E501</p>
|
|
<p>list of site recovery node version # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The node_versions of this SiteRecoveryVersions. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>list[<a class="reference internal" href="#vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion" title="vmware.vmc_draas.models.site_recovery_node_version.SiteRecoveryNodeVersion">SiteRecoveryNodeVersion</a>]</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_versions.SiteRecoveryVersions.openapi_types">
|
|
<code class="sig-name descname">openapi_types</code><em class="property"> = {'generated': 'datetime', 'node_versions': 'list[SiteRecoveryNodeVersion]', 'sddc_id': 'str'}</em><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_versions.SiteRecoveryVersions.openapi_types" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_versions.SiteRecoveryVersions.sddc_id">
|
|
<em class="property">property </em><code class="sig-name descname">sddc_id</code><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_versions.SiteRecoveryVersions.sddc_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the sddc_id of this SiteRecoveryVersions. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The sddc_id of this SiteRecoveryVersions. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_versions.SiteRecoveryVersions.to_dict">
|
|
<code class="sig-name descname">to_dict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_versions.SiteRecoveryVersions.to_dict" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the model properties as a dict</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.site_recovery_versions.SiteRecoveryVersions.to_str">
|
|
<code class="sig-name descname">to_str</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.site_recovery_versions.SiteRecoveryVersions.to_str" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the string representation of the model</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-vmware.vmc_draas.models.task">
|
|
<span id="vmware-vmc-draas-models-task-module"></span><h2>vmware.vmc_draas.models.task module<a class="headerlink" href="#module-vmware.vmc_draas.models.task" title="Permalink to this headline">¶</a></h2>
|
|
<p>VMC DRaaS APIs</p>
|
|
<ul class="simple">
|
|
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>   <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>       <span class="pre">-d</span> <span class="pre">"refresh_token=${REFRESH_TOKEN}"</span> <span class="pre">\</span>       <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize</span> <span class="pre">|</span> <span class="pre">jq</span> <span class="pre">-r</span> <span class="pre">.access_token</span>   <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field * Most VMC DRaaS APIs require a sddc identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs/{org}/sddcs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
|
|
</ul>
|
|
<p>The version of the OpenAPI document: 1.0
|
|
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</span>com</a>
|
|
Generated by: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<dl class="py class">
|
|
<dt id="vmware.vmc_draas.models.task.Task">
|
|
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc_draas.models.task.</code><code class="sig-name descname">Task</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">updated</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">user_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">created</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">updated_by_user_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">updated_by_user_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">user_name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">retries</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">task_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">task_progress_phases</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tenant_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_message</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent_task_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">progress_percent</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">estimated_remaining_minutes</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">end_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">task_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sub_status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">local_vars_configuration</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.task.Task" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>NOTE: This class is auto generated by OpenAPI Generator.
|
|
Ref: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<p>Do not edit the class manually.</p>
|
|
<p>Task - a model defined in OpenAPI</p>
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.task.Task.attribute_map">
|
|
<code class="sig-name descname">attribute_map</code><em class="property"> = {'created': 'created', 'end_time': 'end_time', 'error_message': 'error_message', 'estimated_remaining_minutes': 'estimated_remaining_minutes', 'id': 'id', 'params': 'params', 'parent_task_id': 'parent_task_id', 'progress_percent': 'progress_percent', 'resource_id': 'resource_id', 'resource_type': 'resource_type', 'retries': 'retries', 'start_time': 'start_time', 'status': 'status', 'sub_status': 'sub_status', 'task_progress_phases': 'task_progress_phases', 'task_type': 'task_type', 'task_version': 'task_version', 'tenant_id': 'tenant_id', 'updated': 'updated', 'updated_by_user_id': 'updated_by_user_id', 'updated_by_user_name': 'updated_by_user_name', 'user_id': 'user_id', 'user_name': 'user_name', 'version': 'version'}</em><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.attribute_map" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.created">
|
|
<em class="property">property </em><code class="sig-name descname">created</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.created" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the created of this Task. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The created of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>datetime</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.end_time">
|
|
<em class="property">property </em><code class="sig-name descname">end_time</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.end_time" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the end_time of this Task. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The end_time of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>datetime</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.error_message">
|
|
<em class="property">property </em><code class="sig-name descname">error_message</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.error_message" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the error_message of this Task. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The error_message of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.estimated_remaining_minutes">
|
|
<em class="property">property </em><code class="sig-name descname">estimated_remaining_minutes</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.estimated_remaining_minutes" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the estimated_remaining_minutes of this Task. # noqa: E501</p>
|
|
<p>Estimated remaining time in minute of the task execution, < 0 means no estimation for the task. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The estimated_remaining_minutes of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>int</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.id">
|
|
<em class="property">property </em><code class="sig-name descname">id</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the id of this Task. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The id of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.task.Task.openapi_types">
|
|
<code class="sig-name descname">openapi_types</code><em class="property"> = {'created': 'datetime', 'end_time': 'datetime', 'error_message': 'str', 'estimated_remaining_minutes': 'int', 'id': 'str', 'params': 'object', 'parent_task_id': 'str', 'progress_percent': 'int', 'resource_id': 'str', 'resource_type': 'str', 'retries': 'int', 'start_time': 'str', 'status': 'str', 'sub_status': 'str', 'task_progress_phases': 'list[TaskProgressPhase]', 'task_type': 'str', 'task_version': 'str', 'tenant_id': 'str', 'updated': 'datetime', 'updated_by_user_id': 'str', 'updated_by_user_name': 'str', 'user_id': 'str', 'user_name': 'str', 'version': 'int'}</em><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.openapi_types" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.params">
|
|
<em class="property">property </em><code class="sig-name descname">params</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.params" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the params of this Task. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The params of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>object</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.parent_task_id">
|
|
<em class="property">property </em><code class="sig-name descname">parent_task_id</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.parent_task_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the parent_task_id of this Task. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The parent_task_id of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.progress_percent">
|
|
<em class="property">property </em><code class="sig-name descname">progress_percent</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.progress_percent" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the progress_percent of this Task. # noqa: E501</p>
|
|
<p>Estimated progress percentage the task executed # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The progress_percent of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>int</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.resource_id">
|
|
<em class="property">property </em><code class="sig-name descname">resource_id</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.resource_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the resource_id of this Task. # noqa: E501</p>
|
|
<p>UUID of resources task is acting upon # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The resource_id of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.resource_type">
|
|
<em class="property">property </em><code class="sig-name descname">resource_type</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.resource_type" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the resource_type of this Task. # noqa: E501</p>
|
|
<p>Type of resource being acted upon # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The resource_type of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.retries">
|
|
<em class="property">property </em><code class="sig-name descname">retries</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.retries" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the retries of this Task. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The retries of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>int</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.start_time">
|
|
<em class="property">property </em><code class="sig-name descname">start_time</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.start_time" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the start_time of this Task. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The start_time of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.status">
|
|
<em class="property">property </em><code class="sig-name descname">status</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.status" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the status of this Task. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The status of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.sub_status">
|
|
<em class="property">property </em><code class="sig-name descname">sub_status</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.sub_status" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the sub_status of this Task. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The sub_status of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.task_progress_phases">
|
|
<em class="property">property </em><code class="sig-name descname">task_progress_phases</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.task_progress_phases" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the task_progress_phases of this Task. # noqa: E501</p>
|
|
<p>Task progress phases involved in current task execution # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The task_progress_phases of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>list[<a class="reference internal" href="../console/vmware.vmc.console.models.html#vmware.vmc.console.models.task_progress_phase.TaskProgressPhase" title="vmware.vmc.console.models.task_progress_phase.TaskProgressPhase">TaskProgressPhase</a>]</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.task_type">
|
|
<em class="property">property </em><code class="sig-name descname">task_type</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.task_type" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the task_type of this Task. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The task_type of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.task_version">
|
|
<em class="property">property </em><code class="sig-name descname">task_version</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.task_version" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the task_version of this Task. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The task_version of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.tenant_id">
|
|
<em class="property">property </em><code class="sig-name descname">tenant_id</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.tenant_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the tenant_id of this Task. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The tenant_id of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.to_dict">
|
|
<code class="sig-name descname">to_dict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.to_dict" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the model properties as a dict</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.to_str">
|
|
<code class="sig-name descname">to_str</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.to_str" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the string representation of the model</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.updated">
|
|
<em class="property">property </em><code class="sig-name descname">updated</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.updated" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the updated of this Task. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The updated of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>datetime</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.updated_by_user_id">
|
|
<em class="property">property </em><code class="sig-name descname">updated_by_user_id</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.updated_by_user_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the updated_by_user_id of this Task. # noqa: E501</p>
|
|
<p>User id that last updated this record # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The updated_by_user_id of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.updated_by_user_name">
|
|
<em class="property">property </em><code class="sig-name descname">updated_by_user_name</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.updated_by_user_name" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the updated_by_user_name of this Task. # noqa: E501</p>
|
|
<p>User name that last updated this record # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The updated_by_user_name of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.user_id">
|
|
<em class="property">property </em><code class="sig-name descname">user_id</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.user_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the user_id of this Task. # noqa: E501</p>
|
|
<p>User id that last updated this record # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The user_id of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.user_name">
|
|
<em class="property">property </em><code class="sig-name descname">user_name</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.user_name" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the user_name of this Task. # noqa: E501</p>
|
|
<p>User name that last updated this record # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The user_name of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task.Task.version">
|
|
<em class="property">property </em><code class="sig-name descname">version</code><a class="headerlink" href="#vmware.vmc_draas.models.task.Task.version" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the version of this Task. # noqa: E501</p>
|
|
<p>Version of this entity # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The version of this Task. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>int</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-vmware.vmc_draas.models.task_all_of">
|
|
<span id="vmware-vmc-draas-models-task-all-of-module"></span><h2>vmware.vmc_draas.models.task_all_of module<a class="headerlink" href="#module-vmware.vmc_draas.models.task_all_of" title="Permalink to this headline">¶</a></h2>
|
|
<p>VMC DRaaS APIs</p>
|
|
<ul class="simple">
|
|
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>   <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>       <span class="pre">-d</span> <span class="pre">"refresh_token=${REFRESH_TOKEN}"</span> <span class="pre">\</span>       <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize</span> <span class="pre">|</span> <span class="pre">jq</span> <span class="pre">-r</span> <span class="pre">.access_token</span>   <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field * Most VMC DRaaS APIs require a sddc identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs/{org}/sddcs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
|
|
</ul>
|
|
<p>The version of the OpenAPI document: 1.0
|
|
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</span>com</a>
|
|
Generated by: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<dl class="py class">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf">
|
|
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc_draas.models.task_all_of.</code><code class="sig-name descname">TaskAllOf</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">start_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">retries</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">task_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">task_progress_phases</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tenant_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">error_message</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">parent_task_id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">progress_percent</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">estimated_remaining_minutes</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">params</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">end_time</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">task_version</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">resource_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sub_status</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">local_vars_configuration</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>NOTE: This class is auto generated by OpenAPI Generator.
|
|
Ref: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<p>Do not edit the class manually.</p>
|
|
<p>TaskAllOf - a model defined in OpenAPI</p>
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf.attribute_map">
|
|
<code class="sig-name descname">attribute_map</code><em class="property"> = {'end_time': 'end_time', 'error_message': 'error_message', 'estimated_remaining_minutes': 'estimated_remaining_minutes', 'params': 'params', 'parent_task_id': 'parent_task_id', 'progress_percent': 'progress_percent', 'resource_id': 'resource_id', 'resource_type': 'resource_type', 'retries': 'retries', 'start_time': 'start_time', 'status': 'status', 'sub_status': 'sub_status', 'task_progress_phases': 'task_progress_phases', 'task_type': 'task_type', 'task_version': 'task_version', 'tenant_id': 'tenant_id'}</em><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf.attribute_map" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf.end_time">
|
|
<em class="property">property </em><code class="sig-name descname">end_time</code><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf.end_time" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the end_time of this TaskAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The end_time of this TaskAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>datetime</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf.error_message">
|
|
<em class="property">property </em><code class="sig-name descname">error_message</code><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf.error_message" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the error_message of this TaskAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The error_message of this TaskAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf.estimated_remaining_minutes">
|
|
<em class="property">property </em><code class="sig-name descname">estimated_remaining_minutes</code><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf.estimated_remaining_minutes" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the estimated_remaining_minutes of this TaskAllOf. # noqa: E501</p>
|
|
<p>Estimated remaining time in minute of the task execution, < 0 means no estimation for the task. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The estimated_remaining_minutes of this TaskAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>int</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf.openapi_types">
|
|
<code class="sig-name descname">openapi_types</code><em class="property"> = {'end_time': 'datetime', 'error_message': 'str', 'estimated_remaining_minutes': 'int', 'params': 'object', 'parent_task_id': 'str', 'progress_percent': 'int', 'resource_id': 'str', 'resource_type': 'str', 'retries': 'int', 'start_time': 'str', 'status': 'str', 'sub_status': 'str', 'task_progress_phases': 'list[TaskProgressPhase]', 'task_type': 'str', 'task_version': 'str', 'tenant_id': 'str'}</em><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf.openapi_types" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf.params">
|
|
<em class="property">property </em><code class="sig-name descname">params</code><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf.params" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the params of this TaskAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The params of this TaskAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>object</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf.parent_task_id">
|
|
<em class="property">property </em><code class="sig-name descname">parent_task_id</code><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf.parent_task_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the parent_task_id of this TaskAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The parent_task_id of this TaskAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf.progress_percent">
|
|
<em class="property">property </em><code class="sig-name descname">progress_percent</code><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf.progress_percent" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the progress_percent of this TaskAllOf. # noqa: E501</p>
|
|
<p>Estimated progress percentage the task executed # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The progress_percent of this TaskAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>int</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf.resource_id">
|
|
<em class="property">property </em><code class="sig-name descname">resource_id</code><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf.resource_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the resource_id of this TaskAllOf. # noqa: E501</p>
|
|
<p>UUID of resources task is acting upon # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The resource_id of this TaskAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf.resource_type">
|
|
<em class="property">property </em><code class="sig-name descname">resource_type</code><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf.resource_type" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the resource_type of this TaskAllOf. # noqa: E501</p>
|
|
<p>Type of resource being acted upon # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The resource_type of this TaskAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf.retries">
|
|
<em class="property">property </em><code class="sig-name descname">retries</code><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf.retries" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the retries of this TaskAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The retries of this TaskAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>int</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf.start_time">
|
|
<em class="property">property </em><code class="sig-name descname">start_time</code><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf.start_time" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the start_time of this TaskAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The start_time of this TaskAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf.status">
|
|
<em class="property">property </em><code class="sig-name descname">status</code><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf.status" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the status of this TaskAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The status of this TaskAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf.sub_status">
|
|
<em class="property">property </em><code class="sig-name descname">sub_status</code><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf.sub_status" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the sub_status of this TaskAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The sub_status of this TaskAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf.task_progress_phases">
|
|
<em class="property">property </em><code class="sig-name descname">task_progress_phases</code><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf.task_progress_phases" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the task_progress_phases of this TaskAllOf. # noqa: E501</p>
|
|
<p>Task progress phases involved in current task execution # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The task_progress_phases of this TaskAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>list[<a class="reference internal" href="../console/vmware.vmc.console.models.html#vmware.vmc.console.models.task_progress_phase.TaskProgressPhase" title="vmware.vmc.console.models.task_progress_phase.TaskProgressPhase">TaskProgressPhase</a>]</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf.task_type">
|
|
<em class="property">property </em><code class="sig-name descname">task_type</code><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf.task_type" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the task_type of this TaskAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The task_type of this TaskAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf.task_version">
|
|
<em class="property">property </em><code class="sig-name descname">task_version</code><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf.task_version" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the task_version of this TaskAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The task_version of this TaskAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf.tenant_id">
|
|
<em class="property">property </em><code class="sig-name descname">tenant_id</code><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf.tenant_id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the tenant_id of this TaskAllOf. # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The tenant_id of this TaskAllOf. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf.to_dict">
|
|
<code class="sig-name descname">to_dict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf.to_dict" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the model properties as a dict</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_all_of.TaskAllOf.to_str">
|
|
<code class="sig-name descname">to_str</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.task_all_of.TaskAllOf.to_str" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the string representation of the model</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-vmware.vmc_draas.models.task_progress_phase">
|
|
<span id="vmware-vmc-draas-models-task-progress-phase-module"></span><h2>vmware.vmc_draas.models.task_progress_phase module<a class="headerlink" href="#module-vmware.vmc_draas.models.task_progress_phase" title="Permalink to this headline">¶</a></h2>
|
|
<p>VMC DRaaS APIs</p>
|
|
<ul class="simple">
|
|
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>   <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>       <span class="pre">-d</span> <span class="pre">"refresh_token=${REFRESH_TOKEN}"</span> <span class="pre">\</span>       <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize</span> <span class="pre">|</span> <span class="pre">jq</span> <span class="pre">-r</span> <span class="pre">.access_token</span>   <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field * Most VMC DRaaS APIs require a sddc identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs/{org}/sddcs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
|
|
</ul>
|
|
<p>The version of the OpenAPI document: 1.0
|
|
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</span>com</a>
|
|
Generated by: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<dl class="py class">
|
|
<dt id="vmware.vmc_draas.models.task_progress_phase.TaskProgressPhase">
|
|
<em class="property">class </em><code class="sig-prename descclassname">vmware.vmc_draas.models.task_progress_phase.</code><code class="sig-name descname">TaskProgressPhase</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">id</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">progress_percent</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">local_vars_configuration</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.task_progress_phase.TaskProgressPhase" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
|
<p>NOTE: This class is auto generated by OpenAPI Generator.
|
|
Ref: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
<p>Do not edit the class manually.</p>
|
|
<p>TaskProgressPhase - a model defined in OpenAPI</p>
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.task_progress_phase.TaskProgressPhase.attribute_map">
|
|
<code class="sig-name descname">attribute_map</code><em class="property"> = {'id': 'id', 'name': 'name', 'progress_percent': 'progress_percent'}</em><a class="headerlink" href="#vmware.vmc_draas.models.task_progress_phase.TaskProgressPhase.attribute_map" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_progress_phase.TaskProgressPhase.id">
|
|
<em class="property">property </em><code class="sig-name descname">id</code><a class="headerlink" href="#vmware.vmc_draas.models.task_progress_phase.TaskProgressPhase.id" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the id of this TaskProgressPhase. # noqa: E501</p>
|
|
<p>The identifier of the task progress phase # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The id of this TaskProgressPhase. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_progress_phase.TaskProgressPhase.name">
|
|
<em class="property">property </em><code class="sig-name descname">name</code><a class="headerlink" href="#vmware.vmc_draas.models.task_progress_phase.TaskProgressPhase.name" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the name of this TaskProgressPhase. # noqa: E501</p>
|
|
<p>The display name of the task progress phase # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The name of this TaskProgressPhase. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>str</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py attribute">
|
|
<dt id="vmware.vmc_draas.models.task_progress_phase.TaskProgressPhase.openapi_types">
|
|
<code class="sig-name descname">openapi_types</code><em class="property"> = {'id': 'str', 'name': 'str', 'progress_percent': 'int'}</em><a class="headerlink" href="#vmware.vmc_draas.models.task_progress_phase.TaskProgressPhase.openapi_types" title="Permalink to this definition">¶</a></dt>
|
|
<dd></dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_progress_phase.TaskProgressPhase.progress_percent">
|
|
<em class="property">property </em><code class="sig-name descname">progress_percent</code><a class="headerlink" href="#vmware.vmc_draas.models.task_progress_phase.TaskProgressPhase.progress_percent" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Gets the progress_percent of this TaskProgressPhase. # noqa: E501</p>
|
|
<p>The percentage of the phase that has completed # noqa: E501</p>
|
|
<dl class="field-list simple">
|
|
<dt class="field-odd">Returns</dt>
|
|
<dd class="field-odd"><p>The progress_percent of this TaskProgressPhase. # noqa: E501</p>
|
|
</dd>
|
|
<dt class="field-even">Return type</dt>
|
|
<dd class="field-even"><p>int</p>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_progress_phase.TaskProgressPhase.to_dict">
|
|
<code class="sig-name descname">to_dict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.task_progress_phase.TaskProgressPhase.to_dict" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the model properties as a dict</p>
|
|
</dd></dl>
|
|
|
|
<dl class="py method">
|
|
<dt id="vmware.vmc_draas.models.task_progress_phase.TaskProgressPhase.to_str">
|
|
<code class="sig-name descname">to_str</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#vmware.vmc_draas.models.task_progress_phase.TaskProgressPhase.to_str" title="Permalink to this definition">¶</a></dt>
|
|
<dd><p>Returns the string representation of the model</p>
|
|
</dd></dl>
|
|
|
|
</dd></dl>
|
|
|
|
</div>
|
|
<div class="section" id="module-vmware.vmc_draas.models">
|
|
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-vmware.vmc_draas.models" title="Permalink to this headline">¶</a></h2>
|
|
<p>VMC DRaaS APIs</p>
|
|
<ul class="simple">
|
|
<li><p>All VMware Cloud APIs require a valid authentication token; which can be obtained by issuing a <cite>POST</cite>: <code class="docutils literal notranslate"><span class="pre">`</span>   <span class="pre">curl</span> <span class="pre">-s</span> <span class="pre">-X</span> <span class="pre">POST</span> <span class="pre">\</span>       <span class="pre">-d</span> <span class="pre">"refresh_token=${REFRESH_TOKEN}"</span> <span class="pre">\</span>       <span class="pre">https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize</span> <span class="pre">|</span> <span class="pre">jq</span> <span class="pre">-r</span> <span class="pre">.access_token</span>   <span class="pre">`</span></code> * This CSP API is defined at: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST">https://console.cloud.vmware.com/csp/gateway/am/api/swagger-ui.html#/Authentication/getAccessTokenByApiRefreshTokenUsingPOST</a> * The <cite>refresh_token</cite> used to get a valid authentication token can be obtained after successful login to following URL via a web browser: <a class="reference external" href="https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens">https://console.cloud.vmware.com/csp/gateway/portal/#/user/tokens</a>. * Most VMware Cloud APIs require an org identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs</cite> and extracting the <cite>id</cite> field * Most VMC DRaaS APIs require a sddc identifier. This can be obtained by issuing a <cite>GET</cite> on <cite>/vmc/api/orgs/{org}/sddcs</cite> and extracting the <cite>id</cite> field # noqa: E501</p></li>
|
|
</ul>
|
|
<p>The version of the OpenAPI document: 1.0
|
|
Contact: <a class="reference external" href="mailto:anushah%40vmware.com">anushah<span>@</span>vmware<span>.</span>com</a>
|
|
Generated by: <a class="reference external" href="https://openapi-generator.tech">https://openapi-generator.tech</a></p>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
|
|
<a href="vmware.vmc_draas.api.html" class="btn btn-neutral float-left" title="vmware.vmc_draas.api package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
|
|
© Copyright 2020, VMware Inc.
|
|
|
|
</p>
|
|
</div>
|
|
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html> |