<spanid="com-vmware-vcenter-content-registries-package"></span><h1>com.vmware.vcenter.content.registries package<aclass="headerlink"href="#module-com.vmware.vcenter.content.registries"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-content-registries-harbor-client-module"></span><h2>com.vmware.vcenter.content.registries.harbor_client module<aclass="headerlink"href="#module-com.vmware.vcenter.content.registries.harbor_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.harbor_client.</span></code><codeclass="sig-name descname"><spanclass="pre">Projects</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.harbor_client.Projects"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Projects</span></code> class provides methods for managing the lifecycle of
Harbor project that stores and distributes container repositories and
images.</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">ConfigStatus</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.harbor_client.Projects.ConfigStatus"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Projects.ConfigStatus</span></code> class describes the status of reaching the
desired configuration state for the Harbor project.</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">ConfigStatus</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">ERROR</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConfigStatus(string='ERROR')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.ERROR"title="Permalink to this definition">¶</a></dt>
<dd><p>Failed to create Harbor project or apply the configuration to the project,
<codeclass="sig-name descname"><spanclass="pre">PENDING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConfigStatus(string='PENDING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.PENDING"title="Permalink to this definition">¶</a></dt>
<dd><p>Harbor project is being created or the configuration is being applied to
<codeclass="sig-name descname"><spanclass="pre">READY</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConfigStatus(string='READY')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.READY"title="Permalink to this definition">¶</a></dt>
<dd><p>Harbor project is created or configured correctly.</p>
<codeclass="sig-name descname"><spanclass="pre">REMOVING</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">ConfigStatus(string='REMOVING')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus.REMOVING"title="Permalink to this definition">¶</a></dt>
<dd><p>The configuration is being removed and Harbor project is being deleted.</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">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">scope</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.harbor_client.Projects.CreateSpec"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Projects.CreateSpec</span></code> class defines the information required to
create a Harbor project.</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>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the Harbor project. Should be between 1-63 characters long
alphanumeric string and may contain the following characters:
a-z,0-9, and ‘-‘. Must be starting with characters or numbers, with
the ‘-‘ character allowed anywhere except the first or last
character.</p></li>
<li><p><strong>scope</strong> (<aclass="reference internal"href="#com.vmware.vcenter.content.registries.harbor_client.Projects.Scope"title="com.vmware.vcenter.content.registries.harbor_client.Projects.Scope"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Projects.Scope</span></code></a>) – Access type of a Harbor project.</p></li>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Projects.Info</span></code> class contains detailed information about a Harbor
project.</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>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the Harbor project. Should be between 1-63 characters long
alphanumeric string and may contain the following characters:
a-z,0-9, and ‘-‘. Must be starting with characters or numbers, with
the ‘-‘ character allowed anywhere except the first or last
character.</p></li>
<li><p><strong>config_status</strong> (<aclass="reference internal"href="#com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus"title="com.vmware.vcenter.content.registries.harbor_client.Projects.ConfigStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Projects.ConfigStatus</span></code></a>) – The status of the Harbor project.</p></li>
<li><p><strong>scope</strong> (<aclass="reference internal"href="#com.vmware.vcenter.content.registries.harbor_client.Projects.Scope"title="com.vmware.vcenter.content.registries.harbor_client.Projects.Scope"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Projects.Scope</span></code></a>) – The access type of a Harbor project.</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 project creation API was
triggered and project identifier generated.</p></li>
<li><p><strong>update_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code>) – The date and time when the harbor project purge API was triggered.
In case no purge was triggered, <codeclass="docutils literal notranslate"><spanclass="pre">updateTime</span></code> is same as
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-name descname"><spanclass="pre">Scope</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.harbor_client.Projects.Scope"title="Permalink to this definition">¶</a></dt>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">Projects.Scope</span></code> class in a project defines access levels of the
project.</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">Scope</span></code> instance.</p>
<codeclass="sig-name descname"><spanclass="pre">PRIVATE</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Scope(string='PRIVATE')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries.harbor_client.Projects.Scope.PRIVATE"title="Permalink to this definition">¶</a></dt>
<dd><p>A Harbor project can only be accessed by assigned users.</p>
<codeclass="sig-name descname"><spanclass="pre">PUBLIC</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">Scope(string='PUBLIC')</span></em><aclass="headerlink"href="#com.vmware.vcenter.content.registries.harbor_client.Projects.Scope.PUBLIC"title="Permalink to this definition">¶</a></dt>
<dd><p>A Harbor project can be accessed by everyone.</p>
<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">project</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">scope</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.harbor_client.Projects.Summary"title="Permalink to this definition">¶</a></dt>
<li><p><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the Harbor project. Should be between 1-63 characters long
alphanumeric string and may contain the following characters:
a-z,0-9, and ‘-‘. Must be starting with characters or numbers, with
the ‘-‘ character allowed anywhere except the first or last
character.</p></li>
<li><p><strong>scope</strong> (<aclass="reference internal"href="#com.vmware.vcenter.content.registries.harbor_client.Projects.Scope"title="com.vmware.vcenter.content.registries.harbor_client.Projects.Scope"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Projects.Scope</span></code></a>) – Access type of a Harbor project.</p></li>
<codeclass="sig-name descname"><spanclass="pre">create</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">registry</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">spec</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries.harbor_client.Projects.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a project in a Harbor registry using the supplied
specification. In vSphere 7.0, a Harbor registry is deployed in a
vSphere cluster with vSphere namespaces enabled. When a namespace is
created, a project with same name as the namespace is created in the
Harbor registry, so this method should not be called.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><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:
<li><p><strong>spec</strong> (<aclass="reference internal"href="#com.vmware.vcenter.content.registries.harbor_client.Projects.CreateSpec"title="com.vmware.vcenter.content.registries.harbor_client.Projects.CreateSpec"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Projects.CreateSpec</span></code></a>) – Information used to create the Harbor project.</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>, <emclass="sig-param"><spanclass="n"><spanclass="pre">project</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries.harbor_client.Projects.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes the specified project from Harbor registry. Repositories and
images in the project will be removed upon project deletion. Storage
space of deleted images in the project will be reclaimed through next
scheduled Harbor registry garbage collection. In vSphere 7.0, a Harbor
registry is deployed in a vSphere cluster with vSphere namespaces
enabled. When a namespace is deleted, a project with same name as the
namespace is deleted from the Harbor registry, so this method should
not be called.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><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:
if <codeclass="docutils literal notranslate"><spanclass="pre">registry</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">project</span></code> cannot be found. In vSphere 7.0, the
existing project could have been deleted automatically when a
<codeclass="sig-name descname"><spanclass="pre">get</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">registry</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">project</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries.harbor_client.Projects.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns detailed information about the specified Harbor project.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><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:
if <codeclass="docutils literal notranslate"><spanclass="pre">registry</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">project</span></code> cannot be found.</p>
<codeclass="sig-name descname"><spanclass="pre">list</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.harbor_client.Projects.list"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns basic information of all projects in a 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">purge</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">registry</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">project</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vcenter.content.registries.harbor_client.Projects.purge"title="Permalink to this definition">¶</a></dt>
<dd><p>Remove all repositories, images and members in the project. Storage
space of deleted images in the project will be reclaimed through next
scheduled Harbor registry garbage collection.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><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:
if <codeclass="docutils literal notranslate"><spanclass="pre">registry</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">project</span></code> cannot be found.</p>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">com.vmware.vcenter.content.registries.harbor_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.harbor_client.StubFactory"title="Permalink to this definition">¶</a></dt>
