<spanid="com-vmware-vcenter-content-package"></span><h1>com.vmware.vcenter.content package<aclass="headerlink"href="#module-com.vmware.vcenter.content"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="subpackages">
<h2>Subpackages<aclass="headerlink"href="#subpackages"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-vcenter-content-registries-client-module"></span><h2>com.vmware.vcenter.content.registries_client module<aclass="headerlink"href="#module-com.vmware.vcenter.content.registries_client"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.content.registries_client.</span></code><codeclass="sig-name descname"><spanclass="pre">DayOfWeek</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.DayOfWeek"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">DayOfWeek</span></code> class describes the supported days of the week to run a
specific operation for a container registry.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>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
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <aclass="reference internal"href="#com.vmware.vcenter.content.registries_client.DayOfWeek"title="com.vmware.vcenter.content.registries_client.DayOfWeek"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DayOfWeek</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">FRIDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='FRIDAY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.DayOfWeek.FRIDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">MONDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='MONDAY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.DayOfWeek.MONDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SATURDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='SATURDAY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.DayOfWeek.SATURDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">SUNDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='SUNDAY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.DayOfWeek.SUNDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">THURSDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='THURSDAY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.DayOfWeek.THURSDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">TUESDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='TUESDAY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.DayOfWeek.TUESDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WEDNESDAY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">DayOfWeek(string='WEDNESDAY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.DayOfWeek.WEDNESDAY"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.content.registries_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Harbor</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Harbor"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Harbor</span></code> class provides methods to manage the lifecycle of an
integrated Harbor container registry in vCenter.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><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.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">CreateSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">garbage_collection</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">storage</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Harbor.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Harbor.CreateSpec</span></code> class contains the specification required to
create a Harbor registry.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the cluster hosting the registry.
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">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.
If None, registry will not be created on a specified cluster. This
is required in current version, since Harbor can only be created on
a cluster with Kubernetes enabled.</p></li>
<li><p><strong>garbage_collection</strong> (<aclass="reference internal"href="#com.vmware.vcenter.content.registries_client.Harbor.GarbageCollection"title="com.vmware.vcenter.content.registries_client.Harbor.GarbageCollection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Harbor.GarbageCollection</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Garbage collection configuration for the Harbor registry.
If None, a default configuration is set, Recurrence#WEEKLY,
DayOfWeek#SATURDAY, GarbageCollection#hour is 2,
GarbageCollection#minute is 0.</p></li>
<li><p><strong>storage</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.content.registries_client.Harbor.StorageSpec"title="com.vmware.vcenter.content.registries_client.Harbor.StorageSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Harbor.StorageSpec</span></code></a>) – Storage associated with the Harbor registry. The list contains only
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">GarbageCollection</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">type</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">day_of_week</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">hour</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">minute</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Harbor.GarbageCollection"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Harbor.GarbageCollection</span></code> class contains garbage collection
configuration for the Harbor registry.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>type</strong> (<aclass="reference internal"href="#com.vmware.vcenter.content.registries_client.Recurrence"title="com.vmware.vcenter.content.registries_client.Recurrence"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Recurrence</span></code></a>) – Frequency of garbage collection.</p></li>
<li><p><strong>day_of_week</strong> (<aclass="reference internal"href="#com.vmware.vcenter.content.registries_client.DayOfWeek"title="com.vmware.vcenter.content.registries_client.DayOfWeek"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DayOfWeek</span></code></a>) – Day of the week when garbage collection should run.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is <aclass="reference internal"href="#com.vmware.vcenter.content.registries_client.Recurrence.WEEKLY"title="com.vmware.vcenter.content.registries_client.Recurrence.WEEKLY"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Recurrence.WEEKLY</span></code></a>.</p></li>
<li><p><strong>hour</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Hour at which garbage collection should run.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is one of <aclass="reference internal"href="#com.vmware.vcenter.content.registries_client.Recurrence.DAILY"title="com.vmware.vcenter.content.registries_client.Recurrence.DAILY"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Recurrence.DAILY</span></code></a> or
<li><p><strong>minute</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Minute at which garbage collection should run.
This attribute is optional and it is only relevant when the value
of <codeclass="docutils literal notranslate"><spanclass="pre">type</span></code> is one of <aclass="reference internal"href="#com.vmware.vcenter.content.registries_client.Recurrence.DAILY"title="com.vmware.vcenter.content.registries_client.Recurrence.DAILY"><codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Recurrence.DAILY</span></code></a> or
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Harbor.Info</span></code> class contains detailed information about a running
Harbor registry.</p>
<divclass="admonition tip">
<pclass="admonition-title">Tip</p>
<p>The arguments are used to initialize data attributes with the same
names.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>cluster</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the cluster.
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">ClusterComputeResource</span></code>. When methods return a value of this
class as a return value, the attribute will be an identifier for
the resource type: <codeclass="docutils literal notranslate"><spanclass="pre">ClusterComputeResource</span></code>.
If None, container registry is not created on the cluster specified
by <codeclass="xref py py-attr docutils literal notranslate"><spanclass="pre">Harbor.CreateSpec.cluster</span></code>.</p></li>
<li><p><strong>namespace</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier of the Harbor namespace in case it is created in a
Kubernetes environment.
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">NamespaceInstance</span></code>. When methods return a value of this class as
a return value, the attribute will be an identifier for the
If None, no Kubernetes namespace is created for the Harbor.</p></li>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the registry.</p></li>
<li><p><strong>creation_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – The date and time when the harbor registry was created.</p></li>
<li><p><strong>ui_access_url</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – URL to access the UI of the registry.</p></li>
<li><p><strong>garbage_collection</strong> (<aclass="reference internal"href="#com.vmware.vcenter.content.registries_client.Harbor.GarbageCollection"title="com.vmware.vcenter.content.registries_client.Harbor.GarbageCollection"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Harbor.GarbageCollection</span></code></a>) – Garbage collection information for the registry.</p></li>
<li><p><strong>storage</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vcenter.content.registries_client.Harbor.StorageInfo"title="com.vmware.vcenter.content.registries_client.Harbor.StorageInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Harbor.StorageInfo</span></code></a>) – Storage information associated with the registry.</p></li>
<li><p><strong>health</strong> (<aclass="reference internal"href="#com.vmware.vcenter.content.registries_client.Health.Info"title="com.vmware.vcenter.content.registries_client.Health.Info"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Health.Info</span></code></a>) – Health status of the container registry.</p></li>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">StorageInfo</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">policy</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">capacity</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">used</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Harbor.StorageInfo"title="Permalink to this definition">¶</a></dt>
<li><p><strong>capacity</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Total capacity for the registry storage (in mebibytes). This is the
storage limit set on the Harbor registry. If a storage limit was
not set on the registry, the default registry capacity - 204800
mebibytes is used.</p></li>
<li><p><strong>used</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Overall storage used by the registry (in mebibytes). This is the
sum of used storage associated with storage policies configured for
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">StorageSpec</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">policy</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">limit</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Harbor.StorageSpec"title="Permalink to this definition">¶</a></dt>
<li><p><strong>limit</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The maximum amount of storage (in mebibytes) which can be utilized
by the registry for this specification.
If None, a default limit of 204800 mebibytes will be set as the
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Summary</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">cluster</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">registry</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">version</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">ui_access_url</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Harbor.Summary"title="Permalink to this definition">¶</a></dt>
<li><p><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Version of the registry.</p></li>
<li><p><strong>ui_access_url</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – URL to access the UI of the registry.</p></li>
<codeclass="sig-name descname"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">client_token</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Harbor.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a Harbor registry in the cluster.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>client_token</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A unique token generated on the client for each creation request.
The token should be a universally unique identifier (UUID), for
example: <codeclass="docutils literal notranslate"><spanclass="pre">b8a2a2e3-2314-43cd-a871-6ede0f429751</span></code>. This token can
be used to guarantee idempotent creation.
If not specified, creation is not idempotent.</p></li>
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.content.registries_client.Harbor.CreateSpec"title="com.vmware.vcenter.content.registries_client.Harbor.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Harbor.CreateSpec</span></code></a>) – Specification for creating the Harbor registry.</p></li>
<codeclass="sig-name descname"><spanclass="pre">delete</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">registry</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Harbor.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Delete the Harbor registry in the cluster. All Harbor projects,
repositories and images will be deleted upon Harbor registry deletion.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>registry</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the registry.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">registry</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Harbor.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get detailed information of the Harbor registry.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>registry</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the registry.
The parameter must be an identifier for the resource type:
<codeclass="sig-name descname"><spanclass="pre">list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Harbor.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns basic information of all Harbor registries.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.content.registries_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Health</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Health"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Health</span></code> class provides methods to retrieve health status for a
container registry.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><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.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Info</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">status</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">details</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Health.Info"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Status</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Health.Status"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Health.Status</span></code> class describes the status of the container registry.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>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
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Status</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">DELETING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='DELETING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Health.Status.DELETING"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Health.Status.ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Container registry failed to start or stopped with fatal error.</p>
<codeclass="sig-name descname"><spanclass="pre">RUNNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='RUNNING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Health.Status.RUNNING"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">STARTING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='STARTING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Health.Status.STARTING"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WARNING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Status(string='WARNING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Health.Status.WARNING"title="Permalink to this definition">¶</a></dt>
<dd><p>Container registry is running with some warning, for example, storage
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">registry</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Health.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the health information of a container registry in the vCenter.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>registry</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Identifier of the registry.
The parameter must be an identifier for the resource type:
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.content.registries_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Recurrence</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">string</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Recurrence"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Recurrence</span></code> class defines the supported values for how often to run
a specific operation for a container registry.</p>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>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
type description page</span></a>.</p>
</div>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>string</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – String value for the <aclass="reference internal"href="#com.vmware.vcenter.content.registries_client.Recurrence"title="com.vmware.vcenter.content.registries_client.Recurrence"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Recurrence</span></code></a> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">DAILY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Recurrence(string='DAILY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Recurrence.DAILY"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">NONE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Recurrence(string='NONE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Recurrence.NONE"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">WEEKLY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Recurrence(string='WEEKLY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.Recurrence.WEEKLY"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.content.registries_client.</span></code><codeclass="sig-name descname"><spanclass="pre">StubFactory</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">stub_config</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries_client.StubFactory"title="Permalink to this definition">¶</a></dt>