public class HarborStub extends com.vmware.vapi.internal.bindings.Stub implements Harbor
Harbor
API service.
WARNING: Internal class, subject to change in future versions.
HarborTypes.CreateSpec, HarborTypes.GarbageCollection, HarborTypes.Info, HarborTypes.StorageInfo, HarborTypes.StorageSpec, HarborTypes.Summary
apiProvider, converter, ifaceId, securityContext
_VAPI_SERVICE_ID
Constructor and Description |
---|
HarborStub(ApiProvider apiProvider,
StubConfigurationBase config) |
HarborStub(ApiProvider apiProvider,
com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
StubConfigurationBase config) |
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.
|
public HarborStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)
public HarborStub(ApiProvider apiProvider, StubConfigurationBase config)
public java.lang.String create(java.lang.String clientToken, HarborTypes.CreateSpec spec)
Harbor
Synchronous method overload. Result of the invocation will be reported as a method return value.
create
in interface Harbor
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.com.vmware.vcenter.content.Registry
.public java.lang.String create(java.lang.String clientToken, HarborTypes.CreateSpec spec, InvocationConfig invocationConfig)
Harbor
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
create
in interface Harbor
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.com.vmware.vcenter.content.Registry
.public void create(java.lang.String clientToken, HarborTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback)
Harbor
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()
.
create
in interface Harbor
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.public void create(java.lang.String clientToken, HarborTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
Harbor
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()
.
create
in interface Harbor
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.public void delete(java.lang.String registry)
Harbor
Synchronous method overload. Result of the invocation will be reported as a method return value.
public void delete(java.lang.String registry, InvocationConfig invocationConfig)
Harbor
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
public void delete(java.lang.String registry, AsyncCallback<java.lang.Void> asyncCallback)
Harbor
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.
public void delete(java.lang.String registry, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
Harbor
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.
delete
in interface Harbor
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.public HarborTypes.Info get(java.lang.String registry)
Harbor
Synchronous method overload. Result of the invocation will be reported as a method return value.
public HarborTypes.Info get(java.lang.String registry, InvocationConfig invocationConfig)
Harbor
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
public void get(java.lang.String registry, AsyncCallback<HarborTypes.Info> asyncCallback)
Harbor
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.
public void get(java.lang.String registry, AsyncCallback<HarborTypes.Info> asyncCallback, InvocationConfig invocationConfig)
Harbor
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.
get
in interface Harbor
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.public java.util.List<HarborTypes.Summary> list()
Harbor
Synchronous method overload. Result of the invocation will be reported as a method return value.
public java.util.List<HarborTypes.Summary> list(InvocationConfig invocationConfig)
Harbor
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
public void list(AsyncCallback<java.util.List<HarborTypes.Summary>> asyncCallback)
Harbor
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.
public void list(AsyncCallback<java.util.List<HarborTypes.Summary>> asyncCallback, InvocationConfig invocationConfig)
Harbor
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.