com.vmware.vcenter.content.registries

Interface Harbor

All Superinterfaces:

HarborTypes, Service

All Known Implementing Classes:

HarborStub

public interface Harbor
extends Service, HarborTypes

The Harbor interface provides methods to manage the lifecycle of an integrated Harbor container registry in vCenter.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.content.registries.HarborTypes

HarborTypes.CreateSpec, HarborTypes.GarbageCollection, HarborTypes.Info, HarborTypes.StorageInfo, HarborTypes.StorageSpec, HarborTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.content.registries.HarborTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(java.lang.String clientToken, HarborTypes.CreateSpec spec) Creates a Harbor registry in the cluster.
void	create(java.lang.String clientToken, HarborTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Creates a Harbor registry in the cluster.
void	create(java.lang.String clientToken, HarborTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates a Harbor registry in the cluster.
java.lang.String	create(java.lang.String clientToken, HarborTypes.CreateSpec spec, InvocationConfig invocationConfig) Creates a Harbor registry in the cluster.
void	delete(java.lang.String registry) Delete the Harbor registry in the cluster.
void	delete(java.lang.String registry, AsyncCallback<java.lang.Void> asyncCallback) Delete the Harbor registry in the cluster.
void	delete(java.lang.String registry, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Delete the Harbor registry in the cluster.
void	delete(java.lang.String registry, InvocationConfig invocationConfig) Delete the Harbor registry in the cluster.
HarborTypes.Info	get(java.lang.String registry) Get detailed information of the Harbor registry.
void	get(java.lang.String registry, AsyncCallback<HarborTypes.Info> asyncCallback) Get detailed information of the Harbor registry.
void	get(java.lang.String registry, AsyncCallback<HarborTypes.Info> asyncCallback, InvocationConfig invocationConfig) Get detailed information of the Harbor registry.
HarborTypes.Info	get(java.lang.String registry, InvocationConfig invocationConfig) Get detailed information of the Harbor registry.
java.util.List<HarborTypes.Summary>	list() Returns basic information of all Harbor registries.
void	list(AsyncCallback<java.util.List<HarborTypes.Summary>> asyncCallback) Returns basic information of all Harbor registries.
void	list(AsyncCallback<java.util.List<HarborTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns basic information of all Harbor registries.
java.util.List<HarborTypes.Summary>	list(InvocationConfig invocationConfig) Returns basic information of all Harbor registries.

Method Detail

create

java.lang.String create(java.lang.String clientToken,
                        HarborTypes.CreateSpec spec)

Creates a Harbor registry in the cluster.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

clientToken - A unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified, creation is not idempotent.

spec - Specification for creating the Harbor registry.

Returns:

Identifier of the deployed registry. The return value will be an identifier for the resource type: com.vmware.vcenter.content.Registry.

Throws:

AlreadyExists - if a Harbor already exists in the associated cluster.

NotFound - if resources/objects could not be located.

Unsupported - if HarborTypes.CreateSpec.getCluster() does not have vSphere namespace enabled.

InvalidArgument - if spec contains any errors.

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have ContentLibrary.ManageRegistry and/or CertificateAuthority.Manage privilege, or user does not have ContentLibrary.ManageClusterRegistryResource privilege on HarborTypes.CreateSpec.getCluster().

create

java.lang.String create(java.lang.String clientToken,
                        HarborTypes.CreateSpec spec,
                        InvocationConfig invocationConfig)

Creates a Harbor registry in the cluster.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

clientToken - A unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified, creation is not idempotent.

spec - Specification for creating the Harbor registry.

invocationConfig - Configuration for the method invocation.

Returns:

Identifier of the deployed registry. The return value will be an identifier for the resource type: com.vmware.vcenter.content.Registry.

Throws:

AlreadyExists - if a Harbor already exists in the associated cluster.

NotFound - if resources/objects could not be located.

Unsupported - if HarborTypes.CreateSpec.getCluster() does not have vSphere namespace enabled.

InvalidArgument - if spec contains any errors.

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have ContentLibrary.ManageRegistry and/or CertificateAuthority.Manage privilege, or user does not have ContentLibrary.ManageClusterRegistryResource privilege on HarborTypes.CreateSpec.getCluster().

create

void create(java.lang.String clientToken,
            HarborTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback)

Creates a Harbor registry in the cluster.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
Identifier of the deployed registry. The return value will be an identifier for the resource type: com.vmware.vcenter.content.Registry.

Operation Errors:
AlreadyExists - if a Harbor already exists in the associated cluster.
NotFound - if resources/objects could not be located.
Unsupported - if HarborTypes.CreateSpec.getCluster() does not have vSphere namespace enabled.
InvalidArgument - if spec contains any errors.
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have ContentLibrary.ManageRegistry and/or CertificateAuthority.Manage privilege, or user does not have ContentLibrary.ManageClusterRegistryResource privilege on HarborTypes.CreateSpec.getCluster().

Parameters:

clientToken - A unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified, creation is not idempotent.

spec - Specification for creating the Harbor registry.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

create

void create(java.lang.String clientToken,
            HarborTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback,
            InvocationConfig invocationConfig)

Creates a Harbor registry in the cluster.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
Identifier of the deployed registry. The return value will be an identifier for the resource type: com.vmware.vcenter.content.Registry.

Operation Errors:
AlreadyExists - if a Harbor already exists in the associated cluster.
NotFound - if resources/objects could not be located.
Unsupported - if HarborTypes.CreateSpec.getCluster() does not have vSphere namespace enabled.
InvalidArgument - if spec contains any errors.
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have ContentLibrary.ManageRegistry and/or CertificateAuthority.Manage privilege, or user does not have ContentLibrary.ManageClusterRegistryResource privilege on HarborTypes.CreateSpec.getCluster().

Parameters:

clientToken - A unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified, creation is not idempotent.

spec - Specification for creating the Harbor registry.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String registry)

Delete the Harbor registry in the cluster. All Harbor projects, repositories and images will be deleted upon Harbor registry deletion.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

registry - Identifier of the registry. The parameter must be an identifier for the resource type: com.vmware.vcenter.content.Registry.

Throws:

NotFound - if a registry specified by registry could not be found.

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have ContentLibrary.ManageRegistry privilege.

delete

void delete(java.lang.String registry,
            InvocationConfig invocationConfig)

Delete the Harbor registry in the cluster. All Harbor projects, repositories and images will be deleted upon Harbor registry deletion.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

registry - Identifier of the registry. The parameter must be an identifier for the resource type: com.vmware.vcenter.content.Registry.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if a registry specified by registry could not be found.

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have ContentLibrary.ManageRegistry privilege.

delete

void delete(java.lang.String registry,
            AsyncCallback<java.lang.Void> asyncCallback)

Delete the Harbor registry in the cluster. All Harbor projects, repositories and images will be deleted upon Harbor registry deletion.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
NotFound - if a registry specified by registry could not be found.
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have ContentLibrary.ManageRegistry privilege.

Parameters:

registry - Identifier of the registry. The parameter must be an identifier for the resource type: com.vmware.vcenter.content.Registry.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

delete

void delete(java.lang.String registry,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Delete the Harbor registry in the cluster. All Harbor projects, repositories and images will be deleted upon Harbor registry deletion.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
NotFound - if a registry specified by registry could not be found.
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have ContentLibrary.ManageRegistry privilege.

Parameters:

registry - Identifier of the registry. The parameter must be an identifier for the resource type: com.vmware.vcenter.content.Registry.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

get

HarborTypes.Info get(java.lang.String registry)

Get detailed information of the Harbor registry.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

registry - Identifier of the registry. The parameter must be an identifier for the resource type: com.vmware.vcenter.content.Registry.

Returns:

Information about the registry.

Throws:

NotFound - if a Harbor registry specified by registry could not be found.

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

get

HarborTypes.Info get(java.lang.String registry,
                     InvocationConfig invocationConfig)

Get detailed information of the Harbor registry.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

registry - Identifier of the registry. The parameter must be an identifier for the resource type: com.vmware.vcenter.content.Registry.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the registry.

Throws:

NotFound - if a Harbor registry specified by registry could not be found.

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

get

void get(java.lang.String registry,
         AsyncCallback<HarborTypes.Info> asyncCallback)

Get detailed information of the Harbor registry.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
Information about the registry.

Operation Errors:
NotFound - if a Harbor registry specified by registry could not be found.
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

registry - Identifier of the registry. The parameter must be an identifier for the resource type: com.vmware.vcenter.content.Registry.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String registry,
         AsyncCallback<HarborTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Get detailed information of the Harbor registry.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
Information about the registry.

Operation Errors:
NotFound - if a Harbor registry specified by registry could not be found.
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

registry - Identifier of the registry. The parameter must be an identifier for the resource type: com.vmware.vcenter.content.Registry.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

list

java.util.List<HarborTypes.Summary> list()

Returns basic information of all Harbor registries.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Returns:

The list of basic information of all Harbor registries.

Throws:

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

list

java.util.List<HarborTypes.Summary> list(InvocationConfig invocationConfig)

Returns basic information of all Harbor registries.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

The list of basic information of all Harbor registries.

Throws:

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

list

void list(AsyncCallback<java.util.List<HarborTypes.Summary>> asyncCallback)

Returns basic information of all Harbor registries.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
The list of basic information of all Harbor registries.

Operation Errors:
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

void list(AsyncCallback<java.util.List<HarborTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Returns basic information of all Harbor registries.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
The list of basic information of all Harbor registries.

Operation Errors:
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.