<spanid="com-vmware-vcenter-hvc-links-package"></span><h1>com.vmware.vcenter.hvc.links package<aclass="headerlink"href="#module-com.vmware.vcenter.hvc.links"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="submodules">
<h2>Submodules<aclass="headerlink"href="#submodules"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-vcenter-hvc-links-sync-client-module"></span><h2>com.vmware.vcenter.hvc.links.sync_client module<aclass="headerlink"href="#module-com.vmware.vcenter.hvc.links.sync_client"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.hvc.links.sync_client.</code><codeclass="descname">Providers</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc.links.sync_client.Providers"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<emclass="property">class </em><codeclass="descname">Info</code><spanclass="sig-paren">(</span><em>last_sync_time=None</em>, <em>status=None</em>, <em>polling_interval_in_seconds=None</em>, <em>current_session_info=None</em>, <em>status_message=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Info"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>last_sync_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Last sync time for the provider. This indicates the last time that
either a background sync or a force sync was started for the
provider. <strong>Warning:</strong> This attribute is available as technical
preview. It may be changed in a future release.
If None no sync was found for the provider.</li>
<li><strong>status</strong> (<aclass="reference internal"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Status"title="com.vmware.vcenter.hvc.links.sync_client.Providers.Status"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.Status</span></code></a>) – Last Sync status for the provider. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.</li>
<li><strong>polling_interval_in_seconds</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Sync Polling interval between local and remote replicas for the
provider. <strong>Warning:</strong> This attribute is available as technical
preview. It may be changed in a future release.</li>
<li><strong>current_session_info</strong> (<aclass="reference internal"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo"title="com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.SessionInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Returns information on the forced sync for the provider.
<strong>Warning:</strong> This attribute is available as technical preview. It
may be changed in a future release.
If None there is no outstanding sync session created for this
provider</li>
<li><strong>status_message</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Localizable messages associated with sync status. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">status</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Status.FAILED"title="com.vmware.vcenter.hvc.links.sync_client.Providers.Status.FAILED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.Status.FAILED</span></code></a>.</li>
<codeclass="descname">RESOURCE_TYPE</code><emclass="property"> = 'com.vmware.vcenter.hvc.links.sync.Providers'</em><aclass="headerlink"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.RESOURCE_TYPE"title="Permalink to this definition">¶</a></dt>
<dd><p>Resource type for Sync Providers. <strong>Warning:</strong> This class attribute is
available as technical preview. It may be changed in a future release.</p>
<emclass="property">class </em><codeclass="descname">SessionInfo</code><spanclass="sig-paren">(</span><em>stage=None</em>, <em>completed_work=None</em>, <em>total_work=None</em>, <em>completion_time=None</em>, <em>start_time=None</em>, <em>exception=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>stage</strong> (<aclass="reference internal"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage"title="com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Providers.SessionInfo.Stage</span></code></a>) – Sync stage for the session. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.</li>
<li><strong>completed_work</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Completed work for the session. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.</li>
<li><strong>total_work</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Total work for the session. <strong>Warning:</strong> This attribute is
available as technical preview. It may be changed in a future
release.</li>
<li><strong>completion_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time at which forced sync session was completed. <strong>Warning:</strong> This
attribute is available as technical preview. It may be changed in a
future release.
If None there is an ongoing sync that has not completed</li>
<li><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – Time at which force sync was initiated. <strong>Warning:</strong> This attribute
is available as technical preview. It may be changed in a future
release.</li>
<li><strong>exception</strong> (<aclass="reference internal"href="com.vmware.vapi.html#com.vmware.vapi.std_client.LocalizableMessage"title="com.vmware.vapi.std_client.LocalizableMessage"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">com.vmware.vapi.std_client.LocalizableMessage</span></code></a>) – Exception message if there is a sync failure on forced sync.
<strong>Warning:</strong> This attribute is available as technical preview. It
may be changed in a future release.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">stage</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.FAILED"title="com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.FAILED"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Providers.SessionInfo.Stage.FAILED</span></code></a>.</li>
<emclass="property">class </em><codeclass="descname">Stage</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.SessionInfo.Stage</span></code> class defines the different stages of
Sync. <strong>Warning:</strong> This enumeration is available as technical preview. It
may be changed in a future release.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">CHANGE_APPLICATION</code><emclass="property"> = Stage(string='CHANGE_APPLICATION')</em><aclass="headerlink"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.CHANGE_APPLICATION"title="Permalink to this definition">¶</a></dt>
<dd><p>Changes are being applied to the destination replica. <strong>Warning:</strong> This
class attribute is available as technical preview. It may be changed in a
<codeclass="descname">CHANGE_DETECTION</code><emclass="property"> = Stage(string='CHANGE_DETECTION')</em><aclass="headerlink"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.CHANGE_DETECTION"title="Permalink to this definition">¶</a></dt>
<dd><p>Changes are being detected on the source replica. <strong>Warning:</strong> This class
attribute is available as technical preview. It may be changed in a future
<codeclass="descname">CHANGE_ENUMERATION</code><emclass="property"> = Stage(string='CHANGE_ENUMERATION')</em><aclass="headerlink"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.CHANGE_ENUMERATION"title="Permalink to this definition">¶</a></dt>
<dd><p>Changes from the source replica are being enumerated. <strong>Warning:</strong> This
class attribute is available as technical preview. It may be changed in a
<codeclass="descname">COMPLETED</code><emclass="property"> = Stage(string='COMPLETED')</em><aclass="headerlink"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.COMPLETED"title="Permalink to this definition">¶</a></dt>
<dd><p>Sync has completed. <strong>Warning:</strong> This class attribute is available as
technical preview. It may be changed in a future release.</p>
<codeclass="descname">FAILED</code><emclass="property"> = Stage(string='FAILED')</em><aclass="headerlink"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.FAILED"title="Permalink to this definition">¶</a></dt>
<dd><p>Sync failed. <strong>Warning:</strong> This class attribute is available as technical
preview. It may be changed in a future release.</p>
<codeclass="descname">WAITING</code><emclass="property"> = Stage(string='WAITING')</em><aclass="headerlink"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.SessionInfo.Stage.WAITING"title="Permalink to this definition">¶</a></dt>
<dd><p>Session is waiting for progress to be set. <strong>Warning:</strong> This class
attribute is available as technical preview. It may be changed in a future
<emclass="property">class </em><codeclass="descname">Status</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Status"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Providers.Status</span></code> class defines valid sync status. <strong>Warning:</strong> This
enumeration is available as technical preview. It may be changed in a
future release.</p>
<divclass="admonition note">
<pclass="first admonition-title">Note</p>
<pclass="last">This class represents an enumerated type in the interface language
definition. The class contains class attributes which represent the
values in the current version of the enumerated type. Newer versions of
the enumerated type may contain new values. To use new values of the
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">FAILED</code><emclass="property"> = Status(string='FAILED')</em><aclass="headerlink"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Status.FAILED"title="Permalink to this definition">¶</a></dt>
<dd><p>If Sync failed. <strong>Warning:</strong> This class attribute is available as technical
preview. It may be changed in a future release.</p>
<codeclass="descname">NO_SYNC_FOUND</code><emclass="property"> = Status(string='NO_SYNC_FOUND')</em><aclass="headerlink"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Status.NO_SYNC_FOUND"title="Permalink to this definition">¶</a></dt>
<dd><p>If Sync has not been triggered. <strong>Warning:</strong> This class attribute is
available as technical preview. It may be changed in a future release.</p>
<codeclass="descname">SUCCEEDED</code><emclass="property"> = Status(string='SUCCEEDED')</em><aclass="headerlink"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Status.SUCCEEDED"title="Permalink to this definition">¶</a></dt>
<dd><p>If Sync was successful. <strong>Warning:</strong> This class attribute is available as
technical preview. It may be changed in a future release.</p>
<emclass="property">class </em><codeclass="descname">Summary</code><spanclass="sig-paren">(</span><em>provider=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.Summary"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>provider</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Sync provider id. <strong>Warning:</strong> This attribute is available as
technical preview. It may be changed in a future release.
When clients pass a value of this class as a parameter, the
attribute must be an identifier for the resource type:
<codeclass="docutils literal notranslate"><spanclass="pre">com.vmware.vcenter.hvc.links.sync.Providers</span></code>. When methods
return a value of this class as a return value, the attribute will
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>link</em>, <em>provider</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Gets Sync information for a sync provider. <strong>Warning:</strong> This method is
available as technical preview. It may be changed in a future release.</p>
<li><strong>link</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier of the link
The parameter must be an identifier for the resource type:
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>link</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Enumerates the sync providers. <strong>Warning:</strong> This method is available as
technical preview. It may be changed in a future release.</p>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>link</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier of the link
The parameter must be an identifier for the resource type:
<codeclass="descname">start</code><spanclass="sig-paren">(</span><em>link</em>, <em>provider</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc.links.sync_client.Providers.start"title="Permalink to this definition">¶</a></dt>
<dd><p>Initiates synchronization between the local and remote replicas for the
sync provider. <strong>Warning:</strong> This method is available as technical
preview. It may be changed in a future release.</p>
<li><strong>link</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique identifier of the link
The parameter must be an identifier for the resource type:
<emclass="property">class </em><codeclass="descclassname">com.vmware.vcenter.hvc.links.sync_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.hvc.links.sync_client.StubFactory"title="Permalink to this definition">¶</a></dt>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.
